You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > IP Socket Status Report 0x00F2

IP Socket Status Report 0x00F2

SwitchKit Name

IPSocketStatusReport

Type

EXS API and SwitchKit API message

Description

IP Socket Status Report 0x00F2

This message reports the status of a socket. The CSP sends this message to the host when a socket becomes connected or disconnected.

Sent by

CSP

SwitchKit Code

C Structure

typedef struct {

UBYTE Slot;

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_IPSocketStatusReport;

C++ Class

class XLC_IPSocketStatusReport : public XLC_InboundMessage {

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);

};

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 (0x00F2) | 3, 4 | Message Type (0x00F2)
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 (TLVs) | 10 | Checksum
: | Number of TLVs
: | TLV: 0x0A Socket Status
: | Checksum

Internet Protocol. Part of the TCP/IP family of protocols used to route messages and tracks the addresses of nodes.
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.