Instrument Control Toolbox

udp

Create a UDP object

Syntax

• obj = udp('')
  obj = udp('rhost')
  obj = udp('rhost',rport)
  obj = udp(...,'PropertyName',PropertyValue,...)
  

Arguments

'rhost'	The remote host.
rport	The remote port.
'PropertyName'	A UDP property name.
PropertyValue	A property value supported by PropertyName.
obj	The UDP object.

Description

obj = udp('') creates a UDP object, obj, not associated with a remote host. obj = udp('rhost') creates a UDP object associated with remote host rhost.

obj = udp('rhost',rport) creates a UDP object with remote port value, rport. The default remote port is 9090.

obj = udp(...,'PropertyName',PropertyValue,...) creates a UDP object with the specified property name/property value pairs. If an invalid property name or property value is specified, the object is not created.

Remarks

At any time, you can use the instrhelp function to view a complete listing of properties and functions associated with UDP objects.

• instrhelp udp
  

When you create a UDP object, these properties are automatically configured:

• The Type property is given by udp.
• The Name property is given by concatenating UDP with the remote host name specified in the udp function.
• The RemoteHost and RemotePort properties are given by the values specified in the udp function.

You can specify the property names and property values using any format supported by the set function. For example, you can use property name/property value cell array pairs. Additionally, you can specify property names without regard to case, and you can make use of property name completion. For example, the following commands are all valid.

• u = udp('144.212.113.252','InputBufferSize',1024)
  u = udp('144.212.113.252','inputbuffersize',1024)
  u = udp('144.212.113.252','Input',1024)
  

The UDP object must be bound to the local socket with the fopen function. The default remote port is 9090. The default local host in multihome hosts is the system's default. The LocalPort property defaults to a value of [] and it causes any free local port to be used. LocalPort is updated when fopen is issued. When the UDP object is constructed, the Status property value is closed. Once the object is bound to the local socket with fopen, Status is configured to open.

The maximum packet size for reading is 8192 bytes. The input buffer can hold as many packets as defined by the InputBufferSize property value. You can write any data size to the output buffer. The data will be sent in packets of at most 4096 bytes.

Example

Start the echo server and create a UDP object.

• echoudp('on',4012)
  u = udp('127.0.0.1',4012);
  

Connect the UDP object to the host.

• fopen(u)
  

Write to the host and read from the host.

• fwrite(u,65:74)
  A = fread(u,10);
  

Stop the echo server and disconnect the UDP object from the host.

• echoudp('off')
  fclose(u)
  

See Also

Functions

fopen

Properties

LocalHost, LocalPort, LocalPortMode, Name, RemoteHost, RemotePort, Status, Type

trigger

visa