SctpMgmtCtrl

Sends an SCTP control request to the SCTP layer.

Prototype

SCTP_STATUS TXSCTPFUNC SctpMgmtCtrl ( U8 board, S16 entity, U8 action)

Argument

Description

board

TX board number on which the desired SCTP layer resides. Valid range is 1 through MAXBOARD (currently 32).

entity

Type of control action the function performs. Valid values are:

No value = General control

SCT SAP identifier - SCT SAP control

TSAP identifier = TSAP control

 

Note: The entity identifier (entity) must have been previously defined with the appropriate set configuration function.

action

Action to take on the specified entity. See the Details section for valid actions.


Return values

Return value

Description

SCTP_SUCCESS

 

SCTP_BOARD

Invalid board number.

SCTP_HANDLE

SctpMgmtInit was not called for the specified board.

SIGTRAN_ERR_BADACT

Invalid action argument.


Details

Use SCTPMgmtCntrl to activate and deactivate SCTP resources. The combination of entity and action tells SCTP what entity to act upon and what action to take. There are three types of control actions:

Note: In the following value-description tables, do not use the management API to perform the actions marked with an asterisk, unless you are an experienced user. These actions are performed automatically by the SCTP layer, and are provided through the management API for testing and debugging purposes only.

General control actions

If the entity argument is not used, the action argument has the following valid values.

Value

Description

*SCTP_CTRL_ALARM_DIS

Disables alarms.

*SCTP_CTRL_ALARM_ENA

Enables alarms.

SCTP_CTRL_DEBUG_OFF

Stops debug logging.

SCTP_CTRL_DEBUG_ON

Starts debug logging.

*SCTP_CTRL_FLOWCTL_OFF

Ends flow control and enables transmission of all SCTP management messages.

*SCTP_CTRL_FLOWCTL_ON

Starts flow control, and disable transmission of all except critical M3UA management messages.

*SCTP_CTRL_SHUTDOWN

Shuts down the SCTP layer.

SCTP_CTRL_TRACE_OFF

Stops trace data.

SCTP_CTRL_TRACE_ON

Starts trace data.


 

SCT SAP control actions

If the entity argument specifies an SCT SAP identifier, the action argument has the following valid values:

Value

Description

*SCTP_CTRL_SCTSAP_DEL

Deletes the SCT SAP.

*SCTP_CTRL_SCTSAP_DIS

Disables the SCT SAP.

*SCTP_CTRL_SCTSAP_ENA

Enables the SCT SAP.


TSAP control actions

If the entity argument specifies a TSAP identifier, the action argument has the following valid values:

Value

Description

*SCTP_CTRL_TSAP_DEL

Deletes the TSAP.

*SCTP_CTRL_TSAP_DIS

Disables the TSAP.

*SCTP_CTRL_TSAP_ENA

Enables the TSAP.


See also

SctpMgmtInit, SctpMgmtTerm