You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > IP Socket Configure 0x00F0

IP Socket Configure 0x00F0

SwitchKit Name

IPSocketConfig

Type

EXS API and SwitchKit API message

Description

IP Socket Configure 0x00F0

This message is used for TCP/IP socket registration and operations. The message registers the TCP/IP socket, opens or closes a socket, and prohibits or allows traffic on a socket.

Sent by

Host

SwitchKit Code

Configuration

IPSocketConfig (

Node = integer,

Slot = integer,

DataType = integer,

TLVCount = integer,

Data = string);

C Structure

typedef struct {

BaseFields Base;

UBYTE Slot;

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_IPSocketConfig;

C++ Class

class XLC_IPSocketConfig : 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);

};

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 (0x000B)
3, 4 | Message Type (0x00F0) | 3, 4 | Message Type (0x00F0)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
: | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status MSB, LSB
Number of AEs to follow
AE 0x01 Slot
: | Data Type (TLVs) | 10 | Checksum
: | TLV 0x01 Client Socket Register by IP 0x02 Server Socket Register by IP 0x03 Client Socket Register by Name 0x04 Server Socket Register by Name 0x05 Unregister Socket 0x06 Open Socket 0x07 Close Socket 0x08 Prohibit Traffic on Socket 0x09 Allow Traffic on Socket
: | Checksum

Internet Protocol. Part of the TCP/IP family of protocols used to route messages and tracks the addresses of nodes.
Transmission Control Protocol / Internet Protocol. A networking protocol that provides communication across interconnected networks.
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.