UdpLink (UnetStack 3.4.0 API)

org.arl.unet.link.UdpLink

UDP link agent provides UDP based link implementation.

Field Summary

Fields
Modifiers	Name	Description
`static String`	`description`
`static String`	`title`

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

Properties Summary

Properties
Type	Name and description
`int`	`address`
`int`	`advertise`
`String`	`broadcastAddress`
`float`	`dataRate`
`int`	`monitorTimeout`
`int`	`port`
`int`	`port`
`int`	`port`
`int`	`retries`
`float`	`timeout`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`getAddress(int node)` Gets the IP address of a peer Unet node.
	`int`	`getAdvertise()` Gets the advertisement interval.
	`String`	`getBroadcastAddress()` Gets the network broadcast address.
	`float`	`getDataRate()` Get data rate.
	`int`	`getMTU()` Get maximum frame size.
	`int`	`getMonitorTimeout()` Gets the monitor socket timeout in ms.
	`protected List<Parameter>`	`getParameterList()`
	`protected List<Parameter>`	`getParameterList(int ndx)`
	`int`	`getPort()` Gets the port number.
	`int`	`getPort(int node)` Gets the UDP port number used by UdpLink on a peer Unet node.
	`int`	`getRTU()` Get recommended frame size.
	`int`	`getRetries()` Gets the maximum number of retries for delivery.
	`float`	`getTimeout()` Gets the delivery timeout in seconds.
	`protected void`	`processMessage(Message msg)`
	`protected Message`	`processRequest(Message msg)`
	`String`	`setAddress(int node, String addr)` Sets the IP address of a peer Unet node.
	`int`	`setAdvertise(int t)` Sets the advertisement interval.
	`void`	`setBroadcastAddress(String addr)` Sets the network broadcast address.
	`void`	`setDataRate(float r)` Set data rate.
	`void`	`setMonitorTimeout(int monitorTimeout)` Sets monitor socket timeout in ms.
	`void`	`setPort(int port)` Sets port number.
	`int`	`setPort(int node, int port)` Sets the UDP port number used by UdpLink on a peer Unet node.
	`int`	`setRetries(int retries)` Sets the maximum number of retries for delivery.
	`float`	`setTimeout(float timeout)` Sets delivery timeout in seconds.
	`protected 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`

- Field Detail
  - public static final String description
  - public static final String title
- Property Detail
  - int address
  - int advertise
  - String broadcastAddress
  - float dataRate
  - int monitorTimeout
  - int port
  - int port
  - int port
  - int retries
  - float timeout
- Method Detail
  - public String getAddress(int node)
    
    Gets the IP address of a peer Unet node.
    Parameters:
    node - Unet address of peer node
    Returns:
    IP address of peer node, if known, null otherwise
  - public int getAdvertise()
    
    Gets the advertisement interval.
    Returns:
    advertisement interval in seconds (0 = disabled)
  - public String getBroadcastAddress()
    
    Gets the network broadcast address.
    Returns:
    network broadcast address
  - public float getDataRate()
    
    Get data rate.
    Returns:
    data rate in bps (0 if unknown)
  - public int getMTU()
    
    Get maximum frame size.
    Returns:
    maximum frame size in bytes
  - public int getMonitorTimeout()
    
    Gets the monitor socket timeout in ms.
    Returns:
    monitor timeout
  - @Override protected List<Parameter> getParameterList()
  - @Override protected List<Parameter> getParameterList(int ndx)
  - public int getPort()
    
    Gets the port number.
    Returns:
    port number
  - public int getPort(int node)
    
    Gets the UDP port number used by UdpLink on a peer Unet node.
    Parameters:
    node - Unet address of peer node
    Returns:
    UDP port number used by peer node, if known, 0 otherwise
  - public int getRTU()
    
    Get recommended frame size.
    Returns:
    recommended frame size in bytes
  - public int getRetries()
    
    Gets the maximum number of retries for delivery.
    Returns:
    retries
  - public float getTimeout()
    
    Gets the delivery timeout in seconds.
    Returns:
    timeout
  - @Override protected void processMessage(Message msg)
  - @Override protected Message processRequest(Message msg)
  - public String setAddress(int node, String addr)
    
    Sets the IP address of a peer Unet node.
    Hostname or IP address may be specified to include a port number, separared by a ":". A "(unknown)" address removes the mapping.
    Parameters:
    node - Unet address of peer node
    addr - hostname or IP address of peer node
  - public int setAdvertise(int t)
    
    Sets the advertisement interval.
    Parameters:
    t - advertisement interval in seconds (0 = disable)
  - public void setBroadcastAddress(String addr)
    
    Sets the network broadcast address.
    Parameters:
    addr - broadcast address
  - public void setDataRate(float r)
    
    Set data rate. Since UDP data rate is generally not known at the node, we allow a user to set a rate based on knowledge of the network.
    Parameters:
    r - data rate in bps (0 if unknown)
  - public void setMonitorTimeout(int monitorTimeout)
    
    Sets monitor socket timeout in ms. This can only be changed during agent creation, before the agent is started.
    Parameters:
    monitorTimeout - monitor timeout
  - public void setPort(int port)
    
    Sets port number.
    Parameters:
    port - port number
  - public int setPort(int node, int port)
    
    Sets the UDP port number used by UdpLink on a peer Unet node.
    Parameters:
    node - Unet address of peer node
    port - UDP port number used by peer node
  - public int setRetries(int retries)
    
    Sets the maximum number of retries for delivery.
    Parameters:
    retries - retry count
  - public float setTimeout(float timeout)
    
    Sets delivery timeout in seconds.
    Parameters:
    timeout - timeout
  - @Override protected void setup()
  - @Override public void shutdown()
  - @Override public void startup()

Summary:
Field
Property
Method

| Detail:
Field
Property
Method

[Java] Class UdpLink

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String description

public static final String title

Property Detail

int address

int advertise

String broadcastAddress

float dataRate

int monitorTimeout

int port

int port

int port

int retries

float timeout

Method Detail

public String getAddress(int node)

public int getAdvertise()

public String getBroadcastAddress()

public float getDataRate()

public int getMTU()

public int getMonitorTimeout()

@Override protected List<Parameter> getParameterList()

@Override protected List<Parameter> getParameterList(int ndx)

public int getPort()

public int getPort(int node)

public int getRTU()

public int getRetries()

public float getTimeout()

@Override protected void processMessage(Message msg)

@Override protected Message processRequest(Message msg)

public String setAddress(int node, String addr)

public int setAdvertise(int t)

public void setBroadcastAddress(String addr)

public void setDataRate(float r)

public void setMonitorTimeout(int monitorTimeout)

public void setPort(int port)

public int setPort(int node, int port)

public int setRetries(int retries)

public float setTimeout(float timeout)

@Override protected void setup()

@Override public void shutdown()

@Override public void startup()