You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Span Status Query 0x0084
SwitchKit Name
SpanStatusQuery
Type
EXS API and SwitchKit API message
Description
This message may be used by the host to obtain information about the state of an in-service T1 or E1 span. It resets bipolar violations and frame error contents.
For the SS7 Multi-Protocol I/O card, the positive acknowledgement to this query contains zeros in the data fields.
Sent by
SwitchKit Code
C Structure
typedef struct {
unsigned short Status;
unsigned short Span;
UBYTE AlarmStatus;
unsigned short BiPolarCntr;
unsigned short FrameErrors;
unsigned short SlipCntr;
unsigned short RemoteAlarmCntr;
unsigned short FrameLossCntr;
} XL_SpanStatusQueryAck;
C Structure Response
typedef struct {
unsigned short Status;
unsigned short Span;
UBYTE AlarmStatus;
unsigned short BiPolarCntr;
unsigned short FrameErrors;
unsigned short SlipCntr;
unsigned short RemoteAlarmCntr;
UBYTE FrameLossCntr;
} XL_SpanStatusQueryAck;
C++ Class
class XLC_SpanStatusQuery : public XLC_OutboundMessage {
public:
unsigned short getSpan() const;
void setSpan(unsigned short x);
};
C++ Class Response
class XLC_SpanStatusQueryAck : public XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
unsigned short getSpan() const;
void setSpan(unsigned short x);
UBYTE getAlarmStatus() const;
void setAlarmStatus(UBYTE x);
unsigned short getBiPolarCntr() const;
void setBiPolarCntr(unsigned short x);
unsigned short getFrameErrors() const;
void setFrameErrors(unsigned short x);
unsigned short getSlipCntr() const;
void setSlipCntr(unsigned short x);
unsigned short getRemoteAlarmCntr() const;
void setRemoteAlarmCntr(unsigned short x);
unsigned short getFrameLossCntr() const;
void setFrameLossCntr(unsigned short x);
};
EXS API Hex Format
MESSAGE (White) |
RESPONSE (Gray) |
||
Byte |
Field Description |
Byte |
Field Description |
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
1, 2 |
Length (0xNNNN) |
1, 2 |
Length (0xNNNN) |
3, 4 |
Message Type (0x0084) |
3, 4 |
Message Type (0x0084) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8 : |
Address Method 0x00 - Individual AEs
|
8, 9 |
If this field is anything other than 0x0010 (Positive Acknowledgment), the value of the Length field will be 0x0003. |
Number of AEs to follow |
10 |
AIB (same as message) |
|
AE |
|||
: |
Checksum |
||
|
Response continued below. |
||
: |
Alarm Status This field is a bit mask. The bit values are 0=Disabled, 1=Enabled. Bit 0 Receiving Red Alarm Bit 1 Receiving Yellow Alarm Bit 2 Receiving Loss of Signal Bit 3 Receiving Out of Frame Bit 4 Sending Red Alarm Bit 5 Sending Yellow Alarm Bit 6 Receiving AIS Bit 7 In Remote Loopback |
||
: |
Bipolar Violation Counter MSB, LSB The number of bipolar violations detected since last request. |
||
: |
Frame Errors MSB, LSB If the span is T1, this field contains the number of frame bit errors. If the span is E1, this field contains frame alignment signal errors. |
||
: |
Slip Counter MSB, LSB The number of slips detected since last request. |
||
: |
Remote Alarm Indication Counter MSB, LSB The number of times Remote Alarm Indication has been detected since the last request. |
||
: |
Loss of Frame Counter MSB, LSB The Number of times a Loss of Frame has been detected since the last request. |
||
: |
Checksum |