IP Socket Query 0x00F1

SwitchKit Name

IPSocketQuery

Type

EXS API and SwitchKit API message

Description

Use this message to query IP socket configurations.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

UBYTE Slot;

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_IPSocketQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE TLVCount;

UBYTE Data[250];

} XL_IPSocketQueryAck;

C++ Class

class XLC_IPSocketQuery : 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_IPSocketQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short 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 (0x0007)

3, 4

Message Type (0x00F1)

3, 4

Message Type (0x00F1)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

:

AIB

0x00 - Individual AEs

8, 9

Status MSB, LSB

Number of AEs to follow

AE

0x01 Slot

:

Data Type

10

Checksum

:

Number of TLVs

:

TLV:

0x0B Socket ID

0x0C Socket Information

:

Checksum