Jw: adding template

2015-05-05T06:45:15Z

adding template

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

	The shell ip item implements the following commands:		The shell ip item implements the following commands:

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

2011-04-05T16:00:28Z

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

← Older revision		Revision as of 18:00, 5 April 2011
Line 115:		Line 115:
	:o - Open Sound Control (OSC) protocol		:o - Open Sound Control (OSC) protocol

	:s - ~~S_TOOLS-STx~~ protocol		:s - {{STX}} protocol

	:a - ASCII text		:a - ASCII text
Line 121:		Line 121:
	:u - Unicode text		:u - Unicode text

	:If no protocol is specified, the ~~S_TOOLS-STx~~ protocol is used by default.		:If no protocol is specified, the {{STX}} protocol is used by default.

	;<var>/m</var>		;<var>/m</var>

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}}}}
==SET IP==

The shell ip item implements the following commands:

====CLOSE====

<code>SET <var>ip</var> CLOSE</code>

Close open connections. Connections can be reconnected using the <code>CONNECT</code> command.

====CONNECT====

<code>SET <var>ip</var> CONNECT [ <var>raddr</var> <var>rport</var> ] [ /u ]</code>

Open a connection to a remote server. If the connection is accepted, the <code>CONNECTED</code> message is sent to the shell.

;<var>ip</var>

:The name of the ip item instance.

;<var>raddr</var>

:The remote ip address to connect to. If <var>raddr</var> is not specified, the <var>raddr</var> specified by the last <code>CONNECT</code> command is used.

;<var>rport</var>

:The remote port to connect to. If <var>rport</var> is not specified, the <var>rport</var> specified by the last <code>CONNECT</code> command is used.

;<var>/u</var>

:If specified, the UDP protocol is used for the connection. Otherwise the TCP protocol is used.

Example:

<pre>
#raddr := set '192.168.1.25'#rport := '7000'#ip := new ip *$#ip connect $#raddr $#rport /u
</pre>
====LISTEN====

<code>SET <var>ip</var> LISTEN <var>laddr</var> <var>lport</var> [ /u ]</code>

;<var>ip</var>

:The name of the ip item instance.

;<var>laddr</var>

:The local ip address to listen for connections on. If an asterisk is specified, the ip item listens on all local network interfaces.

;<var>lport</var>

:The local port to listen for connections on.

;<var>/u</var>

:If specified, the UDP protocol is used for the connection. Otherwise the TCP protocol is used.

====RECEIVE====

<code>SET <var>ip</var> RECEIVE [ <var>table</var>|<var>variable</var> [ <var>field</var> ] ] // client</code>

<code>SET <var>ip</var> RECEIVE <var>socketId</var> [ <var>table</var>|<var>variable</var> [ <var>field</var> ] ] // server</code>

The ip item's <code>RECEIVE</code> command retrieves the next message from the queue of received messages. If successful, the local variable <code>#ipreceive</code> retrieved data.

;<var>ip</var>

:The name of an ip item instance.

;<var>socketId</var>

:The id of the socket to retrieve the message from. This parameter must be specified if the ip instance is acting as a server.

;<var>table</var>

:A table item to store the received data in. This should be a simple table for a string message and an parameter table for a numeric data message. Note that this parameter is optional. If you do not specify a table, a table of the correct type is created for you. If the command is successful, the local variable <code>#ipreceive</code> contains the name of the table item containing the received data.

;<var>variable</var>

:The name of a variable to store the table name in.

;<var>field</var>

:If a table parameter <var>table</var> is specified, then the first field to retrieve data into may also be specified. If no field is specified, the first field is used.

====RESET====

<code>SET <var>ip</var> RESET</code>

Close open connections. Connections can be reconnected using the <code>CONNECT</code> command.

====SEND====

<code>SET <var>ip</var> SEND [ <var>socketId</var> ] <var>table</var>|<var>string</var> [ /p ] [ /m ] [ /u ]</code>

The <code>SEND</code> command sends data to a remote host using an existing connection.

;<var>socketId</var>

:If this ip instance is acting as a server, then a socket id must be specified on which to send the data.

;<var>table</var>

:A table item containing the data to send. The type of data you can send depends on the protocol.

;<var>string</var>

;<var></var>

;<var>/p=o|s|a|u</var>

:Specify the data protocol. The following protocols are supported:

:o - Open Sound Control (OSC) protocol

:s - S_TOOLS-STx protocol

:a - ASCII text

:u - Unicode text

:If no protocol is specified, the S_TOOLS-STx protocol is used by default.

;<var>/m</var>

:If specified, a SENT message is sent when sending is completed. This is not the same as the <code>READYTOSEND</code> message.

;<var>/u</var>

:If specified, strings are sent as Unicode. Otherwise they are sent as ASCII.

Example:

<pre>
#ip := new ip *$#ip connect localhost 5000// send 'hello' as ASCII text$#ip send 'hello' /p=a
</pre>

Programmer Guide/Shell Items/IP/SET IP - Revision history

Jw: adding template

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

Admin: 1 revision: Initial import

193.171.195.8: initial import