M3UA management function summary

NaturalAccess M3UA consists of the following synchronous management functions, in which the action is completed before control is returned to the application:

Control functions

Function

Description

M3uaMgmtCtrl

Sends a control request to the M3UA layer.

M3uaMgmtInit

Initializes internal structures and opens communication with the M3UA process on the TX board. This function must be called before any other management function.

M3uaMgmtTerm

Terminates access to the M3UA management API for this application.


Configuration functions

Function

Description

M3uaGetGenCfg

Obtains general configuration parameter values from the M3UA layer.

M3uaGetNwkCfg

Obtains network configuration parameter values from the M3UA layer.

M3uaGetNSapCfg

Obtains NSAP configuration parameter values from the M3UA layer.

M3uaGetPsCfg

Obtains peer server configuration parameter values from the M3UA layer.

M3uaGetPspCfg

Obtains peer signaling process configuration parameter values from the M3UA layer.

M3uaGetRteCfg

Obtains route configuration parameter values from the M3UA layer.

M3uaGetSctSapCfg

Obtains SCT SAP configuration parameter values from the M3UA layer.

M3uaInitGenCfg

Initializes the provided general configuration structure with default values.

M3uaInitNSapCfg

Initializes the provided NSAP configuration structure with default values and the NSAP identifier.

M3uaInitNwkCfg

Initializes the provided network configuration structure with default values and the network identifier.

M3uaInitPsCfg

Initializes the provided peer server configuration structure with default values and the peer server identifier.

M3uaInitPspCfg

Initializes the provided peer signaling process configuration structure with default values and the peer signaling process identifier.

M3uaInitRteCfg

Initializes the provided route configuration structure with default values and the route number, DPC, and switch type.

M3uaInitSctSapCfg

Initializes the provided SCT SAP configuration structure with default values and the SCT SAP identifier.

M3uaSetGenCfg

Configures the M3UA layer with the values contained in the general configuration structure.

M3uaSetNSapCfg

Configures the M3UA layer with the values contained in the NSAP configuration structure.

M3uaSetNwkCfg

Configures the M3UA layer with the values contained in the network configuration structure.

M3uaSetPsCfg

Configures the M3UA layer with the values contained in the peer server configuration structure.

M3uaSetPspCfg

Configures the M3UA layer with the values contained in the peer signaling process structure.

M3uaSetRteCfg

Configures the M3UA layer with the values contained in the route configuration structure.

M3uaSetSctSapCfg

Configures the M3UA layer with the values contained in the SCTP SAP configuration structure.


Statistics functions

Function

Description

M3uaGenStatistics

Obtains and optionally resets the general statistics for the M3UA layer.

M3uaNSapStatistics

Obtains and optionally resets the statistics for the specified M3UA NSAP.

M3uaPspStatistics

Obtains and optionally resets the statistics for the specified M3UA peer signaling process.

M3uaSctSapStatistics

Obtains and optionally resets the statistics for the specified M3UA SCT SAP.


Status functions

Function

Description

M3uaAddrTransStatus

Obtains address translation status information from the M3UA layer.

M3uaDpcStatus

Obtains destination point code status information from the M3UA layer.

M3uaGenStatus

Obtains general status information from the M3UA layer.

M3uaNSapStatus

Obtains NSAP status information from the M3UA layer.

M3uaPspRkIdStatus

Obtains information about the routing keys associated with the specified peer signaling process.

M3uaPspStatus

Obtains peer signaling process status information from the M3UA layer.

M3uaPsStatus

Obtains peer server status information from the M3UA layer.

M3uaRkStatus

Obtains routing key status information from the M3UA layer.

M3uaRteStatus

Obtains route status information from the M3UA layer.

M3uaSctSapStatus

Obtains SCT SAP status information from the M3UA layer.