Jw: adding file template

2015-05-05T06:41:32Z

adding file template

← Older revision		Revision as of 08:41, 5 May 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	==IP Item ~~Messages==~~		{{IP Item}}

	The <code>ip</code> shell item sends the following messages:		The <code>ip</code> shell item sends the following messages:

Admin: 1 revision: Initial import

2010-11-18T16:31:50Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==IP Item Messages==

The <code>ip</code> shell item sends the following messages:

====ACCEPTED====

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

<code>IP name ACCEPTED socketnumber</code>

Where <code>name</code> is the name of the ip instance and <code>socketnumber</code> is the unique string identifying the new connection.

====CLOSED====

The <code>CLOSED</code> 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:

<code>IP name CLOSED socketnumber</code>

Where <code>name</code> is the name of the ip instance and <code>socketnumber</code> is the unique string identifying the closed connection.

====CONNECTED====

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

<code>IP name CONNECTED socketnumber</code>

Where <code>name</code> is the name of the ip instance and <code>socketnumber</code> is the unique string identifying the new connection.

====READYTOSEND====

The <code>READYTOSEND</code> message is sent by an <code>ip</code> 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:

<code>IP name READYTOSEND socketnumber</code>

Where <code>name</code> is the name of the ip instance and <code>socketnumber</code> is the unique string identifying the connection.

====RECEIVED====

The <code>RECEIVED</code> 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:

<code>IP name RECEIVED socketnumber nbytes</code>

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

====SENT====

The <code>SENT</code> 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:

<code>IP name SENT socketname nbytes</code>

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

Programmer Guide/Shell Items/IP/IP Item Messages - Revision history

Jw: adding file template

Admin: 1 revision: Initial import

193.171.195.8: initial import