ReservationReq (UnetStack 3.4.0 API)

org.arl.unet.mac.ReservationReq

Request message sent by a client agent, to reserve the channel for a certain duration of time. Reservation notification message indicates the current state of channel reservation for a ReservationReq message.
See Also:
ReservationStatusNtf

Field Summary

Fields
Modifiers	Name	Description
`protected float`	`duration`
`protected byte[]`	`payload`
`protected Priority`	`priority`
`protected boolean`	`reliable`
`protected Long`	`startTime`
`protected int`	`to`
`protected float`	`ttl`

Properties Summary

Properties
Type	Name and description
`float`	`duration`
`byte[]`	`payload`
`Priority`	`priority`
`boolean`	`reliable`
`Long`	`startTime`
`int`	`to`
`float`	`ttl`

Constructor Summary

Constructors
Constructor and description
`ReservationReq ()` Constructor to set the performative to Performative.REQUEST.
`ReservationReq (AgentID recipient)` Constructor to specify the agent which provides Services.MAC.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`float`	`getDuration()` Gets the duration for which the channel will be reserved (in seconds).
	`byte[]`	`getPayload()` Gets the payload information in byte[].
	`Priority`	`getPriority()` Gets the priority of the reservation request.
	`Long`	`getStartTime()` Gets the starting time for the reservation request.
	`int`	`getTo()` Gets the NodeInfoParam.address of the destination node.
	`float`	`getTtl()` Gets the time-to-live for the reservation request.
	`boolean`	`isReliable()` Gets the value of reliable.
	`void`	`setDuration(float duration)` Sets the duration for which the channel will be reserved, with the destination (in seconds).
	`void`	`setPayload(byte[] payload)` Sets payload with meta information(in a byte[]), that the TX client agent communicates with RX node.
	`void`	`setPriority(Priority priority)` Sets the priority of the reservation request.
	`void`	`setReliable(boolean reliable)` Sets value to specify if current reservation requires reliability (in the form of mac layer acknowledgements), if supported by the underlying MAC agent.
	`void`	`setStartTime(Long time)` Sets the starting time for the reservation request.
	`void`	`setTo(int to)` Sets the address of the destination node.
	`void`	`setTtl(float ttl)` Sets the time-to-live for the reservation request.
	`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 float duration
  - protected byte[] payload
  - protected Priority priority
  - protected boolean reliable
  - protected Long startTime
  - protected int to
  - protected float ttl
- Property Detail
  - float duration
  - byte[] payload
  - Priority priority
  - boolean reliable
  - Long startTime
  - int to
  - float ttl
- Constructor Detail
  - public ReservationReq()
    
    Constructor to set the performative to Performative.REQUEST.
  - public ReservationReq(AgentID recipient)
    
    Constructor to specify the agent which provides Services.MAC.
    Parameters:
    recipient - AgentID.
- Method Detail
  - public float getDuration()
    
    Gets the duration for which the channel will be reserved (in seconds).
    Returns:
    duration
  - public byte[] getPayload()
    
    Gets the payload information in byte[].
    Returns:
    payload information in byte[]
  - public Priority getPriority()
    
    Gets the priority of the reservation request.
    Returns:
    priority
  - public Long getStartTime()
    
    Gets the starting time for the reservation request. The time is in microseconds according to the Physical agent's clock.
    Returns:
    starting time in microseconds, or null if no specified starting time.
  - public int getTo()
    
    Gets the NodeInfoParam.address of the destination node.
    Returns:
    to address
  - public float getTtl()
    
    Gets the time-to-live for the reservation request.
    Returns:
    time-to-live, NaN if none defined.
  - public boolean isReliable()
    
    Gets the value of reliable.
    Returns:
    reliable
  - public void setDuration(float duration)
    
    Sets the duration for which the channel will be reserved, with the destination (in seconds).
    Parameters:
    duration - in milliseconds
  - public void setPayload(byte[] payload)
    
    Sets payload with meta information(in a byte[]), that the TX client agent communicates with RX node.
    Parameters:
    payload - info in byte[]
  - public void setPriority(Priority priority)
    
    Sets the priority of the reservation request. A priority are advisory, and an underlying agent may choose to ignore it, if it does not support prioritization.
    Parameters:
    priority - priority assigned to the request.
  - public void setReliable(boolean reliable)
    
    Sets value to specify if current reservation requires reliability (in the form of mac layer acknowledgements), if supported by the underlying MAC agent.
    Parameters:
    reliable - value to set/unset mac layer acknowledgements
  - public void setStartTime(Long time)
    
    Sets the starting time for the reservation request. The time is in microseconds according to the Physical agent's clock.
    Parameters:
    time - starting time in microseconds, or null to disable starting time.
  - public void setTo(int to)
    
    Sets the address of the destination node.
    Parameters:
    to - destination address
  - public void setTtl(float ttl)
    
    Sets the time-to-live for the reservation request. Time-to-live is advisory, and an agent may choose it ignore it. If a reservation request is dropped, a ReservationStatusNtf indicating a FAILURE must be sent for that request.
    Parameters:
    ttl - time-to-live or NaN if no limit defined.
  - @Override public String toString()

Summary:
Field
Property
Constructor
Method

[Java] Class ReservationReq

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected float duration

protected byte[] payload

protected Priority priority

protected boolean reliable

protected Long startTime

protected int to

protected float ttl

Property Detail

float duration

byte[] payload

Priority priority

boolean reliable

Long startTime

int to

float ttl

Constructor Detail

public ReservationReq()

public ReservationReq(AgentID recipient)

Method Detail

public float getDuration()

public byte[] getPayload()

public Priority getPriority()

public Long getStartTime()

public int getTo()

public float getTtl()

public boolean isReliable()

public void setDuration(float duration)

public void setPayload(byte[] payload)

public void setPriority(Priority priority)

public void setReliable(boolean reliable)

public void setStartTime(Long time)

public void setTo(int to)

public void setTtl(float ttl)

@Override public String toString()