Instrument-control Toolkit - tcpclient
- Loadable Function:
tcpclient =
tcpclient(ipaddress, port)
- Loadable Function:
tcpclient =
tcpclient(ipaddress, port, [propertyname, propertyvalue])
-
Open tcpclient interface.
Inputs
ipaddress - the ip address of type String.
port - the port number to connect.
propname,propvalue - property name/value pairs.Known input properties:
- Name
name value
- Tag
tag value
- Timeout
Numeric timeout value or -1 to wait forever
- EnableTransferDelay
Boolean to enable or disable the nagle algorithm for delay transfer.
- UserData
User data value.
Outputs
The tcpclient() shall return instance of octave_tcpclient class as the result tcpclient.
Properties
The tcpclient object has the following public properties:
- Name
name assigned to the tcpclient object
- Tag
user tag assigned to the tcpclient object
- Type
instrument type ’tcpclient’ (readonly)
- Port
remote port number (Readonly)
- Address
remote host address (Readonly)
- Status
status of the object ’open’ or ’closed’ (readonly)
- Timeout
timeout value in seconds used for waiting for data
- NumBytesAvailable
number of bytes currently available to read (readonly)
- NumBytesWritten
number of bytes currently available to read (readonly)
- ByteOrder
Byte order for data (currently not used)
- Terminator
Terminator value used for string data (currently not used)
- UserData
User data
- EnableTransferDelay
Bool for whether transfer delay is enabled. (Read only)