UdpPortal (UnetStack 3.4.0 API)

Summary:
Property
Method

| Detail:
Property
Method

org.arl.unet.portal.UdpPortal

UDP portal provides a transparent transport for UDP frames through a Unet.
The UdpPortal agent listens for UDP packets on the specified port. Arriving UDP packets are sent via the DATAGRAM service to a peer node, using the specified peer address, protocol, reliability and priority. The UdpPortal agent also listens for any datagrams arriving from the DATAGRAM service with the specified protocol. These are forwarded as UDP packets sent to the clientIP and clientPort.
For supported agent parameters, see UdpPortalParam.

Inherited fields
Fields inherited from class	Fields
`class UnetAgent`	`timeout`

Properties Summary

Properties
Type	Name and description
`String`	`clientIP`
`int`	`clientPort`
`static String`	`description`
`String`	`dsp`
`int`	`peer`
`int`	`port`
`Priority`	`priority`
`int`	`protocol`
`boolean`	`reliability`
`static String`	`title`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`getDsp()`
	`List<Parameter>`	`getParameterList()`
	`protected void`	`processMessage(Message msg)`
	`void`	`setClientIP(String ip)`
	`String`	`setDsp(String aid)`
	`void`	`setPort(int port)`
	`void`	`setup()`
	`void`	`shutdown()`
	`void`	`startup()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class UnetAgent`	`addCapability, allOf, deregister, deregister, die, get, get, getBuildInfo, getLogLevel, getParam, getParameterClasses, getParameterClasses, getParameterList, getParameterList, getServices, getTitle, getVersion, init, isReadOnly, longValue, processMessage, processQuery, processRequest, register, register, set, set, setLogLevel, setParam, setup, shutdown, startup, subscribeForService, subscribeForService, trace, trace, trace, unsubscribeForService, unsubscribeForService`

- Property Detail
  - String clientIP
  - int clientPort
  - static final String description
  - String dsp
  - int peer
  - int port
  - Priority priority
  - int protocol
  - boolean reliability
  - static final String title
- Method Detail
  - String getDsp()
  - List<Parameter> getParameterList()
  - @Override protected void processMessage(Message msg)
  - void setClientIP(String ip)
  - String setDsp(String aid)
  - void setPort(int port)
  - @Override void setup()
  - @Override void shutdown()
  - @Override void startup()

Summary:
Property
Method

| Detail:
Property
Method

Copyright 2013-21, Acoustic Research Laboratory, National University of Singapore, and Subnero Pte Ltd