(Page 18 of 29 in this chapter)
Version
Mtp3MgmtCtrl
Description
Sends a control request to the MTP 3 task.
Prototype
MTP3_STATUS
Mtp3MgmtCtrl
(
U8
board
,
S16
entity
,
U8
action
)
board
TX board number on which the desired MTP 3 task resides. Valid range is 1 to
MAXBOARD
(currently 8).
entity
Link number for link control operations or the linkset number for linkset control operations. The link or linkset number must have been previously defined via the appropriate configuration function call,
Mtp3SetLinkCfg
or
Mtp3SetLinkSetCfg
. Unused for general control operations.
action
Action to take on the entity specified.
Return Values
MTP3_SUCCESS
MTP3_BOARD
Invalid board number specified.
MTP3_HANDLE
Mtp3MgmtInit
was never called for the specified board.
MTP3_PARAM
Invalid action specified. Must be one of those defined above in the
action
parameter description.
Details
There are three classifications of control requests: general, link, and linkset. This function is used to activate and deactivate network layer resources. The combination of
entity
and
action
tell MTP 3 what action to take and what to act upon.
The
action
field must be one of the following:
General Control Actions
(
entity
is unused)
Action
Description
MTP3_CTRL_ALARM_ENA
Enables alarms
MTP3_CTRL_ALARM_DIS
Disables alarms
MTP3_CTRL_FLOWCTL_ON
Starts flow control and disables transmission of all MTP 3 management messages
MTP3_CTRL_FLOWCTL_OFF
Ends flow control and enables transmission of all MTP 3 management messages
Link Control Actions
(
entity
specifies link number)
Action
Description
MTP3_CTRL_LINK_ENA
Enables transmission/reception of all messages to/from specified link
MTP3_CTRL_LINK_DIS
Disables transmission/reception of all messages to/from specified link
MTP3_CTRL_LINK_INH
Inhibits transmission of data messages to/from specified link
MTP3_CTRL_LINK_UNINH
Uninhibits transmission of data messages to/from specified link
MTP3_CTRL_LINK_SPRST
Restarts specified signaling point and enables all configured links
MTP3_CTRL_LINK_DEL
Deletes specified link
MTP3_CTRL_LINK_LPO
Sends specified link into Local Processor Outage condition. Layer 2 will send SIPOs, rather than FISUs
MTP3_CTRL_LINK_LPR
Clears Local Processor Outage condition.
Layer 2 will resume sending FISUs
MTP3_CTRL_LINK_EMG
Sends specified link into Emergency Alignment condition. Layer 2 will send SIN, rather than SIE
MTP3_CTRL_LINK_NRM
Sends specified link into Normal Alignment condition. Layer 2 will send SIN, rather than SIE
Linkset Control Actions
(
entity
specifies linkset number)
Action
Description
MTP3_CTRL_LINKSET_ENA
Enables all links in specified linkset
MTP3_CTRL_LINKSET_DIS
Disables all links in specified linkset
See Also
Mtp3MgmtInit
,
Mtp3SetLinkCfg
,
Mtp3SetLinkSetCfg
(Page 18 of 29 in this chapter)
Version
tech_support@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.
(Page 18 of 29 in this chapter) Version (Page 18 of 29 in this chapter) Version