You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Resource Attribute Query 0x00E4

Resource Attribute Query 0x00E4

SwitchKit Name

ResourceAttributeQuery

Type

EXS API and SwitchKit API message

Description

Resource Attribute Query 0x00E4

This message queries either the default attributes of a module, or the current attributes of a channel involved in an IP call.

Sent By

Host

SwitchKit Code

C Structure

typedef struct {

UBYTE Slot;

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_ResourceAttributeQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE Slot;

UBYTE TLVCount;

UBYTE Data[220];

} XL_ResourceAttributeQueryAck;

C++ Class

class XLC_ResourceAttributeQuery : public XLC_OutboundMessage {

public:

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getDataType() const;

void setDataType(UBYTE x);

UBYTE getTLVCount() const;

void setTLVCount(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

C++ Class Response

class XLC_ResourceAttributeQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getTLVCount() const;

void setTLVCount(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(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 (0x00E4) | 3, 4 | Message Type (0x00E4)
5 | Reserved | 5 | Reserved
6 | Sequence Number | 6 | Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 : | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status MSB, LSB
Number of AEs to follow | 10 | AIB Same as message
AEs 0x01 Slot | : | Number of TLV blocks
: | TLV data type (0x00) | : | TLVs 0x0100 RTP Payload Type (VDAC-ONE) 0x0100 RTP Payload Type (IPN Series 2)
: | Number of TLVs to follow |  | 0x0100 RTP Payload Type (IPN Series 3) 0x0101 RTP Payload Size (IPN Series 2)
: | 0x0009 Address Element TLV See format choices below table | : | Checksum
: | Checksum

Tag/Length/Value Blocks

Only one format of the Address Element Block TLV is required.

If the TLV contains the data type of Expanded Span/Channel, then the message is querying attributes of an established call.

If the TLV contains the data type of IP Address, then the message is querying default attributes of all channels associated with a particular DSP.

Message TLVs

Address Element TLV Block

(for the Expanded Span/Channel AIB)

Byte | Description
0, 1 | Tag: Address Element Block (0x0009)
2, 3 | Length: 0x0005
4 | Value: Data[0] AIB Type: Expanded Span/Channel (0x0D)
5 | Value: Data[1] AIB Length (0x03)
6 | Value: Data[2] Logical Span (MSB)
7 | Value: Data[3] Logical Span (LSB)
8 | Value: Data[4] Channel

Address Element TLV Block

(for the IP Address AIB)

Byte | Description
0, 1 | Tag: Address Element Block (0x0009)
2, 3 | Length: 0x0006
4 | Value: Data[0] AIB Type: (0x3E: IP Address)
5 | Value: Data[1] AIB Length (0x04)
6 | Value: Data[2] IP (MSB)
7 | Value: Data[3] IP
8 | Value: Data[4] IP
9 | Value: Data[5] IP (LSB)

Internet Protocol. Part of the TCP/IP family of protocols used to route messages and tracks the addresses of nodes.
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.
See Address Information Block.
Most Significant Bit
Least Significant Bit
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
The information in an AIB that follows the header, down to the data field. An AIB can have one or more Address Elements. AEs correspond to Span, Channel, and SS7 Link.
Range of channels provided by T1 or E1 transmission service. A physical span is a group of channels taking up a single physical wire. A logical span is a group of channels taking up less than a single logical wire, or carried over more than one physical wire.
A 32-bit address, used in IP routing, which includes a Network address identifier assigned by a central authority and a Host ID (an end station identifier assigned by a LAN administrator).
Digital Signal Processor