DatagramReq (UnetStack 3.4.0 API)

org.arl.unet.DatagramReq

Datagram request message to send across data to a destination.

Field Summary

Fields
Modifiers	Name	Description
`protected byte[]`	`data`
`protected Priority`	`priority`
`protected int`	`protocol`
`protected Boolean`	`reliability`
`protected boolean`	`shortcircuit`
`protected int`	`to`
`protected float`	`ttl`

Properties Summary

Properties
Type	Name and description
`byte[]`	`data`
`Priority`	`priority`
`int`	`protocol`
`Boolean`	`reliability`
`int`	`to`
`float`	`ttl`

Constructor Summary

Constructors
Constructor and description
`DatagramReq ()`
`DatagramReq (AgentID recipient)` Constructs datagram with parameter.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`byte[]`	`getData()` Gets the data in bytes.
	`Priority`	`getPriority()` Gets the priority of the datagram.
	`int`	`getProtocol()` Gets the protocol number.
	`Boolean`	`getReliability()` Gets the reliability.
	`boolean`	`getShortcircuit()` Gets whether the datagram may be short circuited.
	`int`	`getTo()` Gets to/destination node address.
	`float`	`getTtl()` Gets the time-to-live for the datagram.
	`void`	`setData(byte[] data)` Sets data to be send across.
	`void`	`setPriority(Priority priority)` Sets the priority of the datagram.
	`void`	`setProtocol(int protocol)` Sets the protocol number.
	`void`	`setReliability(Boolean reliability)` Sets the reliability.
	`void`	`setShortcircuit(boolean b)` Sets whether the datagram may be short circuited.
	`void`	`setTo(int to)` Sets the to/destination node address.
	`void`	`setTtl(float ttl)` Sets the time-to-live for the datagram.
	`String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Message`	`setPerformative, toString, getSender, setMessageID, getSentAt, setRecipient, getInReplyTo, setSentAt, setSender, getPerformative, getRecipient, getMessageID, setInReplyTo, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected byte[] data
  - protected Priority priority
  - protected int protocol
  - protected Boolean reliability
  - protected boolean shortcircuit
  - protected int to
  - protected float ttl
- Property Detail
  - byte[] data
  - Priority priority
  - int protocol
  - Boolean reliability
  - int to
  - float ttl
- Constructor Detail
  - public DatagramReq()
  - public DatagramReq(AgentID recipient)
    
    Constructs datagram with parameter.
    Parameters:
    recipient - agent ID
- Method Detail
  - public byte[] getData()
    
    Gets the data in bytes.
    Returns:
    data in bytes
  - public Priority getPriority()
    
    Gets the priority of the datagram.
    Returns:
    priority
  - public int getProtocol()
    
    Gets the protocol number.
    Returns:
    protocol number
  - public Boolean getReliability()
    
    Gets the reliability.
    Returns:
    true if reliable, false if unreliable, null if unspecified
  - public boolean getShortcircuit()
    
    Gets whether the datagram may be short circuited.
    Returns:
    true if it may be short circuited, false otherwise.
  - public int getTo()
    
    Gets to/destination node address.
    Returns:
    to address
  - public float getTtl()
    
    Gets the time-to-live for the datagram.
    Returns:
    time-to-live (seconds), NaN if none defined.
  - public void setData(byte[] data)
    
    Sets data to be send across.
    Parameters:
    data - in bytes
  - public void setPriority(Priority priority)
    
    Sets the priority of the datagram. A priority are advisory, and an agent may choose to ignore it, if it does not support prioritization.
    Parameters:
    priority - priority assigned to the request.
  - public void setProtocol(int protocol)
    
    Sets the protocol number.
    Parameters:
    protocol - number
  - public void setReliability(Boolean reliability)
    
    Sets the reliability.
    Parameters:
    reliability - true if reliable, false if unreliable, null if unspecified
  - public void setShortcircuit(boolean b)
    
    Sets whether the datagram may be short circuited.
    Parameters:
    b - true if it may be short circuited, false otherwise.
  - public void setTo(int to)
    
    Sets the to/destination node address.
    Parameters:
    to - address
  - public void setTtl(float ttl)
    
    Sets the time-to-live for the datagram. Time-to-live is advisory, and an agent may choose it ignore it.
    Parameters:
    ttl - time-to-live (seconds) or NaN if no limit defined.
  - @Override public String toString()

Summary:
Field
Property
Constructor
Method

[Java] Class DatagramReq

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected byte[] data

protected Priority priority

protected int protocol

protected Boolean reliability

protected boolean shortcircuit

protected int to

protected float ttl

Property Detail

byte[] data

Priority priority

int protocol

Boolean reliability

int to

float ttl

Constructor Detail

public DatagramReq()

public DatagramReq(AgentID recipient)

Method Detail

public byte[] getData()

public Priority getPriority()

public int getProtocol()

public Boolean getReliability()

public boolean getShortcircuit()

public int getTo()

public float getTtl()

public void setData(byte[] data)

public void setPriority(Priority priority)

public void setProtocol(int protocol)

public void setReliability(Boolean reliability)

public void setShortcircuit(boolean b)

public void setTo(int to)

public void setTtl(float ttl)

@Override public String toString()