M3uaMgmtCtrl

Sends an M3UA control request to the M3UA layer.

Prototype

TXM3UAFUNC M3uaMgmtCtrl ( U8 board, S16 entity, U8 action)

Argument

Description

board

TX board number on which the desired M3UA 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

ASP identifier = ASP control

Association identifier = Association control

Routing key identifier = Routing key control

SCT SAP identifier - SCT SAP 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

M3UA_SUCCESS

 

M3UA_BOARD

Invalid board number.

M3UA_DRIVER

CPI driver error.

M3UA_HANDLE

M3UAMgmtInit was not called for the specified board.

SIGTRAN_ERR_BADACT

Invalid action parameter.


Details

Use M3uaMgmtCtrl to activate and deactivate network task resources. The combination of entity and action tells M3UA what entity to act upon and what action to take. There are five types of control actions:

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 M3UA 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

*M3UA_CTRL_ALARM_DIS

Disables alarms.

*M3UA_CTRL_ALARM_ENA

Enables alarms.

M3UA_CTRL_DEBUG_OFF

Stops debug logging.

M3UA_CTRL_DEBUG_ON

Starts debug logging.

*M3UA_CTRL_FLOWCTL_OFF

Ends flow control, and enable transmission of all M3UA management messages.

*M3UA_CTRL_FLOWCTL_ON

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

*M3UA_CTRL_SHUTDOWN

Shuts down the M3UA layer.

M3UA_CTRL_TRACE_OFF

Stops trace data.

M3UA_CTRL_TRACE_ON

Starts trace data.


ASP control actions

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

Value

Description

*M3UA_CTRL_ASP_AC

Sends an ASPAC (ASP Active) message.

*M3UA_CTRL_ASP_DN

Sends an ASPDN (ASP Down) message.

*M3UA_CTRL_ASP_IA

Sends an ASPIA (ASP Inactive) message.

*M3UA_CTRL_ASP_UP

Sends an ASPUP (ASP Up) message.


Association control actions

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

Value

Description

*M3UA_CTRL_ASSOC_EST

Establishes the association.

M3UA_CTRL_ASSOC_INH

Inhibits the association.

*M3UA_CTRL_ASSOC_TERM

Terminates the association.

M3UA_CTRL_ASSOC_UNI

Uninhibits the association.


Routing key control actions

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

Value

Description

*M3UA_CTRL_RK_DEREG

De-registers the dynamic routing key.

*M3UA_CTRL_RK_REG

Registers the dynamic routing key.


SCT SAP control actions

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

Value

Description

*M3UA_CTRL_SCTSAP_DIS

Disables the SCT SAP.

*M3UA_CTRL_SCTSAP_ENA  

Enables the SCT SAP.


TOS control actions

If the entity argument specifies an ASP identifier and a new TOS value, the action argument has the following valid values:

Value

Description

M3UA_CTRL_SET_TOS

Set the Type of Service octet used on the association.


Note: The ASP identifier occupies the high byte in the entity field. The new TOS value occupies the low byte in the entity field.

See also

M3uaMgmtInit, M3UAMgmtTerm