Portal (UnetStack 3.4.0 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

org.arl.unet.portal.Portal

Portal provides a transparent transport for TCP or serial connections through a Unet.
The Portal agent uses the fjage connector framework to support TCP socket and serial port connections. Arriving data are sent via a DATAGRAM service to a peer node, using the specified peer address, protocol, reliability and priority. The Portal agent also listens for any datagrams arriving from the DATAGRAM service with the specified protocol. These are forwarded to the TCP socket or serial connection.
For supported agent parameters, see PortalParam.

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

Properties Summary

Properties
Type	Name and description
`def`	`delimiters`
`static String`	`description`
`String`	`dsp`
`int`	`peer`
`Priority`	`priority`
`int`	`protocol`
`boolean`	`reliability`
`int`	`timeout`
`static String`	`title`

Constructor Summary

Constructors
Constructor and description
`Portal (Connector conn)`
`Portal (String devname, int baud, String settings)`
`Portal (int port)`
`Portal (String hostname, int port)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`getDsp()`
	`List<Parameter>`	`getParameterList()`
	`protected void`	`processMessage(Message msg)`
	`String`	`setDsp(String aid)`
	`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
  - def delimiters
  - static final String description
  - String dsp
  - int peer
  - Priority priority
  - int protocol
  - boolean reliability
  - int timeout
  - static final String title
- Constructor Detail
  - Portal(Connector conn)
  - Portal(String devname, int baud, String settings)
  - Portal(int port)
  - Portal(String hostname, int port)
- Method Detail
  - String getDsp()
  - List<Parameter> getParameterList()
  - @Override protected void processMessage(Message msg)
  - String setDsp(String aid)
  - @Override void shutdown()
  - @Override void startup()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

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