IP Item Messages

From STX Wiki
Jump to navigationJump to search
IP Item
NEW SET ATTRIBUTES MESSAGES PROTOCOLS

The ip shell item sends the following messages:

ACCEPTED

The ACCEPTED message is sent by a listening ip item to its shell when an incoming connection is established. The format of the message is:

IP name ACCEPTED socketnumber

Where name is the name of the ip instance and socketnumber is the unique string identifying the new connection.

CLOSED

The CLOSED message is sent by an ip item using the TCP protocol to its shell, when the connection has been closed. This occurs when either the local or the remote connection is closed. The message has the following format:

IP name CLOSED socketnumber

Where name is the name of the ip instance and socketnumber is the unique string identifying the closed connection.

CONNECTED

The CONNECTED message is sent by a client ip item to its shell when it successfully connects to a remote server. The format of the message is as follows:

IP name CONNECTED socketnumber

Where name is the name of the ip instance and socketnumber is the unique string identifying the new connection.

READYTOSEND

The READYTOSEND message is sent by an ip item to its shell when the socket is ready to send data. This occurs after a CONNECTED or ACCEPTED message, and after data has been successfully sent and the socket is ready to send more. The message has the following format:

IP name READYTOSEND socketnumber

Where name is the name of the ip instance and socketnumber is the unique string identifying the connection.

RECEIVED

The RECEIVED message is sent by an ip item to its shell when data is received from a remote connection. The format of the message is as follows:

IP name RECEIVED socketnumber nbytes

Where name is the name of the ip instance and socketnumber is the unique string identifying the connection, and nbytes is the number of bytes that were received.

SENT

The SENT message is sent by an ip item to its shell when the send function returned without error. The message does not guarantee that the data has arrived. The format of the message is:

IP name SENT socketname nbytes

Where name is the name of the ip instance and socketnumber is the unique string identifying the connection, and nbytes is the number of bytes that were sent.

Navigation menu

Personal tools