UdpLink (UnetStack 3.0.2 API)

org.arl.unet.link.UdpLink

UDP link agent provides UDP based link implementation.
Services:
- Services.LINK
- Services.DATAGRAM
Capabilities:
- DatagramCapability.RELIABILITY
Parameters:
- DatagramParam
- UdpLinkParam

Field Summary

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

Inherited fields
Fields inherited from class	Fields
`class UnetAgent`	`NON_BLOCKING, BLOCKING`
`class Agent`	`NON_BLOCKING, BLOCKING`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`float`	`getDataRate()` Get data rate.
	`int`	`getMTU()` Get maximum frame size.
	`int`	`getMonitorTimeout()` Gets the monitor socket timeout in ms.
	`String`	`getMulticastAddr()` Gets the multicast address.
	`String`	`getMulticastIface()` Gets the multicast network interface.
	`int`	`getMulticastPort()` Gets the multicast port number.
	`int`	`getMulticastTTL()` Gets the multicast time to live.
	`protected List<Parameter>`	`getParameterList()` Returns list of all link parameters.
	`int`	`getRetries()` Gets the maximum number of retries for delivery.
	`float`	`getTimeout()` Gets the delivery timeout in seconds.
	`protected void`	`processMessage(Message msg)` Process messages other than requests.
	`protected Message`	`processRequest(Message msg)` Handles incoming DatagramReq requests.
	`void`	`setDataRate(float r)` Set data rate.
	`void`	`setMonitorTimeout(int monitorTimeout)` Sets monitor socket timeout in ms.
	`void`	`setMulticastAddr(String multicastAddr)` Sets the multicast address.
	`void`	`setMulticastIface(String multicastIface)` Sets multicast network interface.
	`void`	`setMulticastPort(int multicastPort)` Sets multicast port number.
	`void`	`setMulticastTTL(int multicastTTL)` Sets multicast time to live.
	`void`	`setRetries(int retries)` Sets the maximum number of retries for delivery.
	`void`	`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`	register, register, getLogLevel, setLogLevel, getServices, getTitle, deregister, deregister, getParameterClasses, getParameterClasses, println, run, add, toString, clone, currentTimeMillis, nanoTime, getName, stop, getState, topic, topic, topic, topic, topic, topic, send, receive, receive, receive, receive, receive, receive, receive, receive, getPlatform, request, request, subscribe, getStore, getContainer, wake, agent, agentForService, agentForService, agentsForService, agentsForService, getAgentID, unsubscribe, platformSend, setQueueSize, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll
`class Agent`	println, run, add, toString, register, register, clone, currentTimeMillis, nanoTime, getName, stop, getState, setLogLevel, topic, topic, topic, topic, topic, topic, send, receive, receive, receive, receive, receive, receive, receive, receive, getPlatform, request, request, subscribe, getStore, getContainer, deregister, deregister, wake, agent, agentForService, agentForService, agentsForService, agentsForService, getAgentID, unsubscribe, platformSend, setQueueSize, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Field Detail
  - public static final String description
  - public static final String title
- Method Detail
  - 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
  - public String getMulticastAddr()
    
    Gets the multicast address.
    Returns:
    multicast address.
  - public String getMulticastIface()
    
    Gets the multicast network interface.
    Returns:
    multicast network interface
  - public int getMulticastPort()
    
    Gets the multicast port number.
    Returns:
    multicast port number
  - public int getMulticastTTL()
    
    Gets the multicast time to live.
    Returns:
    multicast time to live.
  - @Override protected List<Parameter> getParameterList()
    
    Returns list of all link parameters.
    Returns:
    list of parameters
  - 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)
    
    Process messages other than requests.
    Parameters:
    msg - incoming message.
  - @Override protected Message processRequest(Message msg)
    
    Handles incoming DatagramReq requests.
    Parameters:
    msg - incoming request.
    Returns:
    response message to send back.
  - 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 setMulticastAddr(String multicastAddr)
    
    Sets the multicast address.
    Parameters:
    multicastAddr - multicast address
  - public void setMulticastIface(String multicastIface)
    
    Sets multicast network interface.
    Parameters:
    multicastIface - multicast network interface
  - public void setMulticastPort(int multicastPort)
    
    Sets multicast port number.
    Parameters:
    multicastPort - multicast port number
  - public void setMulticastTTL(int multicastTTL)
    
    Sets multicast time to live.
    Parameters:
    multicastTTL - multicast time to live
  - public void setRetries(int retries)
    
    Sets the maximum number of retries for delivery.
    Parameters:
    retries - retry count
  - public void 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
Method

| Detail:
Field
Method

[Java] Class UdpLink

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String description

public static final String title

Method Detail

public float getDataRate()

public int getMTU()

public int getMonitorTimeout()

public String getMulticastAddr()

public String getMulticastIface()

public int getMulticastPort()

public int getMulticastTTL()

@Override protected List<Parameter> getParameterList()

public int getRetries()

public float getTimeout()

@Override protected void processMessage(Message msg)

@Override protected Message processRequest(Message msg)

public void setDataRate(float r)

public void setMonitorTimeout(int monitorTimeout)

public void setMulticastAddr(String multicastAddr)

public void setMulticastIface(String multicastIface)

public void setMulticastPort(int multicastPort)

public void setMulticastTTL(int multicastTTL)

public void setRetries(int retries)

public void setTimeout(float timeout)

@Override protected void setup()

@Override public void shutdown()

@Override public void startup()