You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > D Channel Facility List Query 0x00CB
D Channel Facility List Query 0x00CB
Query API Messages
SwitchKit Name
DChannelFacilityListQuery
Type
EXS API and SwitchKit API message
Description
This message is used by the host to request a D channel’s Facility List.
Sent by
SwitchKit Code
C Structure
typedef struct {
unsigned short Span;
UBYTE Channel;
} XL_DChannelFacilityListQuery;
C Structure Response
typedef struct {
unsigned short Status;
unsigned short Span;
UBYTE Channel;
UBYTE FacilitySpan0;
UBYTE FacilitySpan1;
UBYTE FacilitySpan2;
UBYTE FacilitySpan3;
UBYTE FacilitySpan4;
UBYTE FacilitySpan5;
UBYTE FacilitySpan6;
UBYTE FacilitySpan7;
UBYTE FacilitySpan8;
UBYTE FacilitySpan9;
} XL_DChannelFacilityListQueryAck;
C++ Class
class XLC_DChannelFacilityListQuery : public XLC_OneChannelOutbound {
public:
unsigned short getSpan() const;
void setSpan(unsigned short x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
};
C++ Class Response
class XLC_DChannelFacilityListQueryAck : public XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
unsigned short getSpan() const;
void setSpan(unsigned short x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
UBYTE getFacilitySpan0() const;
void setFacilitySpan0(UBYTE x);
UBYTE getFacilitySpan1() const;
void setFacilitySpan1(UBYTE x);
UBYTE getFacilitySpan2() const;
void setFacilitySpan2(UBYTE x);
UBYTE getFacilitySpan3() const;
void setFacilitySpan3(UBYTE x);
UBYTE getFacilitySpan4() const;
void setFacilitySpan4(UBYTE x);
UBYTE getFacilitySpan5() const;
void setFacilitySpan5(UBYTE x);
UBYTE getFacilitySpan6() const;
void setFacilitySpan6(UBYTE x);
UBYTE getFacilitySpan7() const;
void setFacilitySpan7(UBYTE x);
UBYTE getFacilitySpan8() const;
void setFacilitySpan8(UBYTE x);
UBYTE getFacilitySpan9() const;
void setFacilitySpan9(UBYTE 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 (0x00CB) |
3, 4 |
Message Type (0x00CB) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
: |
Address Method 0x00 - Individual AEs |
8, 9 |
|
Number of AEs |
: |
AIB Address Method 0x00 - Individual AEs |
|
AE |
Number of AEs |
||
: |
Checksum |
AEs 0x0C Logical Span (See below) |
|
|
Response continued below. |
||
: |
Facility 0 Span ID The value for a facility that is not configured is 0xFF. |
||
: |
: |
||
: |
Facility 9 Span ID |
||
: |
Checksum |
The Channel and Span address type is used for this message. The table that follows shows you the format for addressing the span for Facility 0. Repeat the same format for facilities 1–8.
Byte |
AIB Field Description |
---|---|
0 |
Address Method (0x00) |
1 |
No of Address Elements (0x0A) |
Channel AE: |
|
2 |
Address Type (0x0D) |
3 |
Data Length (0x03) |
4 |
Data[0] Logical Span ID, MSB |
5 |
Data[1] Logical Span ID, LSB |
6 |
Data[2] Channel |
Span, Facility 0 |
|
7 |
Address Type (0x0C) |
8 |
Data Length (0x02) |
9 |
Data[0] Logical Span ID, MSB |
10 |
Data[1] Logical Span ID, LSB |