SL_CHANNEL_ALARM_IND primitive

Purpose

Indicate that a channel has entered the alarm state, or that an alarm on a channel is now cleared.

Requirement

Mandatory for common channel signaling processes. The primitive is not used by exchange data link signaling processes.

Library

The signaling interface library (libsl.a).

C syntax

typedef struct {
                SL_ID id;
                int iseq_no;
                pid_t pidCHP;
                SL_PRIMITIVE_TYPE Command;
                 SL_INDICATION_PARM_ST Parms;
} SL_INDICATION_ST;
...
typedef union {
...
                struct _channel_alarm_indication_st {
                    size_t sizetLength;
                    int iChannelNo;
                    int iVpackNo;
                    SL_BOOL fAlarm;
                } channel_alarm_indication_st;
...
} SL_INDICATION_PARM_ST;

Description

The SL_CHANNEL_ALARM_IND primitive is sent by the signaling process to Blueworx Voice Response to indicate that a channel has entered the alarm state, or that an alarm on a channel is now cleared.

The signaling process may only send SL_CHANNEL_ALARM_IND with fAlarm set to TRUE, for a channel which is currently in state SL_CHANNEL_STATE_ENABLED. After the signaling process has sent the primitive, the channel is in state SL_CHANNEL_STATE_ALARM and the System Monitor window shows that the channel is currently alarmed.

The signaling process can send SL_CHANNEL_ALARM_IND with fAlarm set to FALSE, only for a channel which is currently in state SL_CHANNEL_STATE_ALARM. After the signaling process has sent the primitive, the channel is in state SL_CHANNEL_STATE_ENABLED and the System Monitor window shows that the channel is no longer alarmed

Note: Disabling a channel in state SL_CHANNEL_STATE_ALARM is allowed.

Corresponding state table action

None.

Corresponding user interface action

The Channel Out of Service window shows the channel as alarmed.

Parameters

id

Eye-catcher that identifies the structure as containing an indication primitive. 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_CHANNEL_ALARM_IND.

Parms.channel_alarm_indication_st.sizetLength

Must be set to sizeof(struct _channel_alarm_indication_st).

Parms.channel_alarm_indication_st.fAlarm

TRUE: The specified channel is now in state SL_CHANNEL_STATE_ALARM and the System Monitor window shows the channel as alarmed.
FALSE: The alarm has cleared, and the specified channel is now back in state SL_CHANNEL_STATE_ENABLED.

Parms.channel_alarm_indication_st.iChannelNo

The channel on which the alarm has occurred, or is being cleared, in the range SL_MIN_CHANNEL_ID to SL_MAX_CHANNEL_ID (see Pack and channel numbers).

Parms.call_disconnect_indication_st.iVpackNo

The pack on which the alarm has occurred, or is being cleared, in the range SL_MIN_TRUNK_ID to SL_MAX_TRUNK_ID (see Pack and channel numbers).