SL_TRUNK_ALARM_IND primitive

Purpose

Indicate that a signaling process has placed a trunk in the internal alarm state, or that a signaling process has cleared an internal alarm on a trunk.

Requirement

Mandatory for signaling processes that registered with the capability SL_SIGPROC_CAPABILITY_TRUNK_MGMT. Otherwise this primitive is not used.

C syntax

typedef struct {
                SL_ID id;
                int iseq_no;
                pid_t pidCHP;
                SL_PRIMITIVE_TYPE Command;
} SL_INDICATION_ST;
...
typedef union {
...
                struct _trunk_alarm_indication_st {
                    size_t sizetLength;
                    int iVpackNo;
                    SL_ALARM_TYPE slAlarm;
                }trunk_alarm_indication_st;
...
} SL_INDICATION_PARM_ST;

Description

The signaling process sends the SL_TRUNK_ALARM_IND primitive to Blueworx Voice Response system management to indicate that a trunk has entered a temporary error state (the internal alarm state) or that a temporary error has now passed.

The signaling process may only send SL_TRUNK_ALARM_IND for a trunk which is currently in state SL_TRUNK_STATE_ENABLED. Once the signaling process has sent the primitive, the trunk is in state SL_TRUNK_STATE_ALARM and the System Monitor window shows that the trunk is currently alarmed. The SL_TRUNK_ALARM_IND primitive is used to indicate a temporary or transient alarm condition, which may reasonably be expected to clear without intervention. The SL_TRUNK_DISABLE_IND primitive is used to indicate a permanent error condition, which may require manual intervention, and which requires the trunk to be re-enabled. See SL_TRUNK_DISABLE_IND primitive.

Corresponding state table action

None.

Corresponding user interface action

The System Monitor window shows all the channels on this trunk in the ALARM state if the trunk has entered the internal alarm state. When the signaling process clears the internal alarm state, the System Monitor window returns the channels on the affected trunk to their previous states.

Parameters

id

Eye-catcher that identifies the structure as containing an indication primitive. This must be set to SLID_INDICATION_ST.

iseq_no

The sequence number of the primitive. Must be set to 0.

pidCHP

Must be set to -1.

Command.id

The primitive that the structure contains. Must be set to SL_TRUNK_ALARM_IND.

Parms.trunk_alarm_indication_st.sizetLength

Must be set to sizeof(struct _trunk_alarm_indication_st).

Parms.trunk_alarm_indication_st.iVpackNo

Identifies the trunk on which the alarm occurred, or is being cleared.

Parms.trunk_alarm_request_st.slAlarm

Identifies the alarm condition:

SL_ALARM_CLEAR: The previously notified alarm has cleared. Place the trunk back in state SL_TRUNK_STATE_ENABLED and the System Monitor window removes the alarm indication from the trunk.
SL_ALARM_OTHER: An alarm has occurred.
Place the specified trunk into in state SL_TRUNK_STATE_SIGPROC_ALARM. This indicates that the signaling process has experienced a transient error. The System Monitor shows the trunk as alarmed.
other values: Reserved for use by Blueworx Voice Response.

Related information

Trunk states