Instrument-control Toolkit - udpport
- Loadable Function:
udp =udpport() - Loadable Function:
udp =udpport(propertyname, propertyvalue ...) -
Open udpport interface.
Inputs
propertyname, propertyvalue - property name/value pair
Known input properties:
- Name
name assigned to the udp object
- LocalPort
local port number
- LocalHost
local host address
- Timeout
timeout value in seconds used for waiting for data
- EnablePortSharing
Boolean if the socket has port sharing enabled (readonly)
Outputs
The udpport() shall return instance of octave_udp class as the result udp.
Properties
The udp object has the following public properties:
- Name
name assigned to the udp object
- Tag
user tag assigned to the udp object
- Type
instrument type ’udpport’ (readonly)
- LocalPort
local port number (readonly)
- LocalHost
local 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)
- MulticastGroup
multicast group socket is subscribed to (readonly)
- EnableMultcast
Boolean if the socket has any multicast group it is subscribed to (readonly)
- EnablePortSharing
Boolean if the socket has port sharing enabled (readonly)
- Terminator
Terminator value used for string data (currently not used)