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

Jw: adding file template

2015-05-05T06:41:16Z

adding file template

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

	The ip shell item has the following attributes:		The ip shell item has the following attributes:

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

2011-04-05T16:00:11Z

Text replace - "S_TOOLS-STx" to "{{STX}}"

← Older revision		Revision as of 18:00, 5 April 2011
Line 40:		Line 40:
	<code>socket#1 ; stx 55 : socket#2 ; stx 44 ; unknown 34</code>		<code>socket#1 ; stx 55 : socket#2 ; stx 44 ; unknown 34</code>

	There are three messages in the queue. The first message arrived on socket#1 and uses the ~~S_TOOLS-STx~~ ip protocol. The second and third messages arrived on socket#2. eusing the ~~S_TOOLS-STx~~ ip protocol and is 55 bytes long. The second is 21 bytes long and uses an unknown protocol. The first of these uses the stx protocol, the second uses an unknown protocol and will be treated as a string.		There are three messages in the queue. The first message arrived on socket#1 and uses the {{STX}} ip protocol. The second and third messages arrived on socket#2. eusing the {{STX}} ip protocol and is 55 bytes long. The second is 21 bytes long and uses an unknown protocol. The first of these uses the stx protocol, the second uses an unknown protocol and will be treated as a string.

	;<var>!PROTOCOL</var>		;<var>!PROTOCOL</var>
Line 52:		Line 52:
	;<var>!RC</var>		;<var>!RC</var>

	The <code>!RC</code> ip item attribute returns the last error code. >10000 for Microsoft specific socket errors or <code>–1</code> for ~~S_TOOLS-STx~~ internal errors.		The <code>!RC</code> ip item attribute returns the last error code. >10000 for Microsoft specific socket errors or <code>–1</code> for {{STX}} internal errors.

	;<var>!READY</var>		;<var>!READY</var>

Admin: 1 revision: Initial import

2010-11-18T16:31:51Z

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 Attributes==

The ip shell item has the following attributes:

;<var>!CONNECTIONS</var>

The <code>!CONNECTIONS</code> ip item attribute returns a semi-colon separated list of ip connections. Each connection contains the following information:

<code>socketid localaddress localport remoteaddress remoteport protocol status nmessages</code>

Where <code>socketid</code> is the unique id string identifying the connection. This is necessary for server instances, which must use a socket id with <code>SEND</code> and <code>RECEIVE</code> commands.

Where <code>localaddress</code>, <code>localport</code>, <code>remoteaddress</code>, <code>remoteport</code> are hopefully self-explanatory.

Where <code>protocol</code> refers to the connection protocol.

Where <code>status</code> is either "<code>open</code>" or "<code>closed</code>", depending on whether the socket is connected or not.

Where <code>nmessages</code> is the number of message which have been received by the socket and not yet retrieved by the shell. Messages are retrieved using the <code>RECEIVE</code> command.

Note that if the ip instance is using the UDP protocol, no connections are shown, since UDP is a connectionless protocol.

;<var>!EMSG</var>

The <code>!EMSG</code> ip item attribute returns the last error message.

;<var>!LADDR</var>

The <code>!LADDR</code> ip item attribute returns the local ip address this instance is using.

;<var>!LPORT</var>

The <code>!LPORT</code> ip item attribute returns the local port number this instance is using. This is either the port specified with the <code>LISTEN</code> command for a local server, or the port assigned by a remote server.

;<var>!MESSAGES</var>

The ip item's <code>!MESSAGES</code> attribute returns a list of details about queued messages. Messages received by a socket are queued until a <code>RECEIVE</code> command is performed to retrieve the message. Unless a socket id is specified, the <code>!MESSAGES</code> attribute lists all messages for all sockets. The messages for different sockets are separated by a colon. The messages for one specific socket are separated by a semi-colon. The first entry in a socket's list is the socket id itself. The other entries are protocol/byte pairs E.g.:

<code>socket#1 ; stx 55 : socket#2 ; stx 44 ; unknown 34</code>

There are three messages in the queue. The first message arrived on socket#1 and uses the S_TOOLS-STx ip protocol. The second and third messages arrived on socket#2. eusing the S_TOOLS-STx ip protocol and is 55 bytes long. The second is 21 bytes long and uses an unknown protocol. The first of these uses the stx protocol, the second uses an unknown protocol and will be treated as a string.

;<var>!PROTOCOL</var>

The <code>!PROTOCOL</code> ip item attribute returns the TCP/IP protocol this instance is using (either "<code>TCP</code>" or "<code>UDP</code>").

;<var>!RADDR</var>

The <code>!RADDR</code> ip item attribute returns the remote ip address this instance is connected to.

;<var>!RC</var>

The <code>!RC</code> ip item attribute returns the last error code. >10000 for Microsoft specific socket errors or <code>–1</code> for S_TOOLS-STx internal errors.

;<var>!READY</var>

The <code>!READY</code> ip item attribute returns 1 if the client is connected, otherwise it returns 0. This is not a super attribute and will probably be removed/replaced.

;<var>!RPORT</var>

The <code>!RPORT</code> ip item attribute returns the remote port number this instance is connected to.

;<var>!SERVER</var>

The <code>!SERVER</code> ip item attribute returns 1 if this instance is acting as a server (i.e. listening) or 0 if it is a client (default).