Configures the SCTP layer with the values contained in the general configuration structure.
SCTP_STATUS TXSCTPFUNC SctpSetGenCfg ( U8 board, SCTPGenCfg *pGenCfg )
Argument |
Description |
board |
TX board number on which the desired SCTP layer resides. Valid range is 1 through MAXBOARD (currently 32). |
pGenCfg |
Pointer to the SCTPGenCfg structure that contains the values to be configured. For information, see SCTPGenCfg. |
Return value |
Description |
SCTP_SUCCESS |
|
SCTP_BOARD |
Invalid board number. |
SCTP_DRIVER |
CPI driver error. |
SCTP_HANDLE |
SctpMgmtInit was not called for the specified board. |
SCTP_PARAM |
Invalid parameter. |
SCTP_RESPONSE |
Incorrect response from the board. |
SCTP_TIMEOUT |
No response from the board. |
Call this function to configure the SCTP layer after you download the TX board and call SctpMgmtInit.
An application must set the field values in the SCTPGenCfg structure before calling SctpSetGenCfg. Set the values in any of the following ways:
Call SctpInitGenCfg to set the fields to default values.
Set each field value from within the application.
Call SctpInitGenCfg and then override specific field values before passing the SCTPGenCfg structure to SctpSetGenCfg.
SctpSetGenCfg is typically called once by an application to set global values.
For more information, see General SCTP configuration.