DatagramNtf (unet-framework 7.0.0 API)

org.arl.unet.DatagramNtf

Notification of received datagram message created by DatagramReq.

Field Summary

Fields
Modifiers	Name	Description
`protected byte[]`	`data`
`protected int`	`from`
`protected Priority`	`priority`
`protected int`	`protocol`
`protected int`	`to`
`protected float`	`ttl`

Properties Summary

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

Constructor Summary

Constructors
Constructor and description
`DatagramNtf ()`
`DatagramNtf (org.arl.fjage.AgentID recipient)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`byte[]`	`getData()` Gets the data as byte array.
	`int`	`getFrom()` Gets the from/source node address.
	`Priority`	`getPriority()` Gets the priority of the datagram.
	`int`	`getProtocol()` Gets the protocol number.
	`int`	`getTo()` Gets to or destination address.
	`float`	`getTtl()` Gets the time-to-live for the datagram.
	`void`	`setData(byte[] data)` Sets the data as byte array.
	`void`	`setFrom(int from)` Sets from or source address.
	`void`	`setPriority(Priority priority)` Sets the priority of the datagram.
	`void`	`setProtocol(int protocol)` Sets protocol number.
	`void`	`setTo(int to)` Sets the to address.
	`void`	`setTtl(float ttl)` Sets the time-to-live for the datagram.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.arl.fjage.Message`	org.arl.fjage.Message#toString(), org.arl.fjage.Message#setPerformative(org.arl.fjage.Performative), org.arl.fjage.Message#getPerformative(), org.arl.fjage.Message#setRecipient(org.arl.fjage.AgentID), org.arl.fjage.Message#getRecipient(), org.arl.fjage.Message#setSender(org.arl.fjage.AgentID), org.arl.fjage.Message#getSender(), org.arl.fjage.Message#setMessageID(java.lang.String), org.arl.fjage.Message#getMessageID(), org.arl.fjage.Message#setInReplyTo(java.lang.String), org.arl.fjage.Message#getInReplyTo(), org.arl.fjage.Message#setSentAt(long), org.arl.fjage.Message#getSentAt(), org.arl.fjage.Message#getJsonCache(), org.arl.fjage.Message#setJsonCache(java.lang.String), org.arl.fjage.Message#wait(long, int), org.arl.fjage.Message#wait(long), org.arl.fjage.Message#wait(), org.arl.fjage.Message#equals(java.lang.Object), org.arl.fjage.Message#hashCode(), org.arl.fjage.Message#getClass(), org.arl.fjage.Message#notify(), org.arl.fjage.Message#notifyAll()

- Field Detail
  - protected byte[] data
  - protected int from
  - protected Priority priority
  - protected int protocol
  - protected int to
  - protected float ttl
- Property Detail
  - byte[] data
  - int from
  - Priority priority
  - int protocol
  - int to
  - float ttl
- Constructor Detail
  - public DatagramNtf()
  - public DatagramNtf(org.arl.fjage.AgentID recipient)
- Method Detail
  - public byte[] getData()
    
    Gets the data as byte array.
    Returns:
    data in bytes
  - public int getFrom()
    
    Gets the from/source node address.
    Returns:
    from address
  - public Priority getPriority()
    
    Gets the priority of the datagram.
    Returns:
    priority
  - public int getProtocol()
    
    Gets the protocol number.
    Returns:
    protocol number
  - public int getTo()
    
    Gets to or destination 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 the data as byte array.
    Parameters:
    data - in byte array
  - public void setFrom(int from)
    
    Sets from or source address.
    Parameters:
    from - address
  - 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 protocol number.
    Parameters:
    protocol - number
  - public void setTo(int to)
    
    Sets the to 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.
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class DatagramNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected byte[] data

protected int from

protected Priority priority

protected int protocol

protected int to

protected float ttl

Property Detail

byte[] data

int from

Priority priority

int protocol

int to

float ttl

Constructor Detail

public DatagramNtf()

public DatagramNtf(org.arl.fjage.AgentID recipient)

Method Detail

public byte[] getData()

public int getFrom()

public Priority getPriority()

public int getProtocol()

public int getTo()

public float getTtl()

public void setData(byte[] data)

public void setFrom(int from)

public void setPriority(Priority priority)

public void setProtocol(int protocol)

public void setTo(int to)

public void setTtl(float ttl)

@java.lang.Override public java.lang.String toString()