You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Poll Request 0x009E

Poll Request 0x009E

SwitchKit Name

PollRequest

Type

EXS API and SwitchKit API message

Description

Poll Request 0x009E

Use this message to initiate the sending of a Poll message from the CSP Matrix Series 3 Card or SS7 card to the host. The host may use this message to implement its own polling scheme, or to obtain information from the CSP Matrix Series 3 Card or SS7 card.

The host can send this message to the active or standby CSP Matrix Series 3 Card.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

} XL_PollRequest;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE SystemType;

UBYTE MatrixSide;

UBYTE MatrixState;

UBYTE AdjMatrixState;

UBYTE StatusBits;

UBYTE Reserved1;

UBYTE Reserved2;

unsigned short ExcelPort;

} XL_PollRequestAck;

C++ Class

class XLC_PollRequest : public XLC_OutboundMessage {

public:

};

C++ Class Response

class XLC_PollRequestAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getSystemType() const;

void setSystemType(UBYTE x);

UBYTE getMatrixSide() const;

void setMatrixSide(UBYTE x);

UBYTE getMatrixState() const;

void setMatrixState(UBYTE x);

UBYTE getAdjMatrixState() const;

void setAdjMatrixState(UBYTE x);

UBYTE getStatusBits() const;

void setStatusBits(UBYTE x);

UBYTE getReserved1() const;

void setReserved1(UBYTE x);

UBYTE getReserved2() const;

void setReserved2(UBYTE x);

unsigned short getExcelPort() const;

void setExcelPort(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 (0x000E)
3, 4 | Message Type (0x009E) | 3, 4 | Message Type (0x009E)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 | Checksum | 8, 9 | Status MSB, LSB (Response continued below.)
10 | System Type 0x01 CSP 2000 0x03 CSP 1000
11 | CSP Matrix Series 3 Card ID This field indicates the CSP Matrix Series 3 Card that is polling. 0x00 Right CSP Matrix Series 3 Card (Slot 0x20) 0x01 Left CSP Matrix Series 3 Card (Slot 0x21)
12 | CSP Matrix Series 3 Card State This field indicates the most recent matrix state. 0x01 Booting 0x02 Initializing 0x03 Standby 0x04 Switching Over 0x05 Active
13 | Adjacent CSP Matrix Series 3 Card State This field indicates the most recent adjacent CSP Matrix Series 3 Card state change. Changes in the adjacent CSP Matrix Series 3 Card state should be considered as events at the host. 0x00 No adjacent CSP Matrix Series 3 Card detected. 0x01 Adjacent CSP Matrix Series 3 Card detected, cannot establish inter-matrix communications. 0x02 Adjacent CSP Matrix Series 3 Card detected, inter-matrix communications established, and adjacent CSP Matrix Series 3 Card cannot establish communications with the host. 0x03 Adjacent CSP Matrix Series 3 Card detected, inter-matrix communications established, and adjacent CSP Matrix Series 3 Card communicating with host.
14 | Status Bits This field is a bit mask. The meaning of each bit is as follows: Bit 0 Host Messaging 0 Receiving messages from host (at least 1 per 5-second interval) 1 Not Receiving messages from the host Bit 1* Download 0 Download not required 1 Download required Bit 2 Reserved Bit 3 Configuration 0 Ready for configuration messages 1 Not ready for configuration messages Bit 4 Power Down 0 Ready for power down 1 Not ready for power down Bit 5 TFTP Download 0 Not In Progress 1 In Progress Bits 6-7 Reserved * If the matrix has system software, or if it can obtain it from the adjacent matrix, Bit 1 is "0". If Bit 1 is set, the host initiates a download of the system software. In some circumstances, both CSP Matrix Series 3 Cards indicate that they require system software to be downloaded. The CSP Matrix Series 3 Card that receives its Download Complete message last will become the active CSP Matrix Series 3 Card.
15, 16 | Reserved
17 | Checksum

See Signaling System Number Seven.
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
Most Significant Bit
Least Significant Bit
The condition of a component at a given instant. The current "context" of a PPL object, such as Idle, Seizing, Answered. In PPL files, a State is represented by a circle.