ReservationStatusNtf (unet-framework 7.0.0 API)

org.arl.unet.mac.ReservationStatusNtf

Notification message to indicate the status of channel reservation for a particular request.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`from`
`protected byte[]`	`payload`
`protected ReservationStatus`	`status`
`protected int`	`to`

Properties Summary

Properties
Type	Name and description
`int`	`from`
`byte[]`	`payload`
`ReservationStatus`	`status`
`int`	`to`

Constructor Summary

Constructors
Constructor and description
`ReservationStatusNtf ()` Constructor to set the performative to org.arl.fjage.Performative#INFORM.
`ReservationStatusNtf (org.arl.fjage.AgentID recipient)` Constructor to specify the recipient agent/topic.
`ReservationStatusNtf (ReservationReq request)` Constructor to specify the original request associated with this message.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`getFrom()` Gets the address of the source node.
	`byte[]`	`getPayload()` Gets payload information in byte[] format.
	`ReservationStatus`	`getStatus()` Gets the current status of channel reservation for a particular reservation request.
	`int`	`getTo()` Gets the address (NodeInfoParam.address) of the destination node.
	`void`	`setFrom(int from)` Sets the address of the source node.
	`void`	`setPayload(byte[] payload)` Sets payload information using a byte[].
	`void`	`setStatus(ReservationStatus status)` Sets the current status of channel reservation for a particular reservation request.
	`void`	`setTo(int to)` Sets the address of the destination node.
	`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 int from
  - protected byte[] payload
  - protected ReservationStatus status
  - protected int to
- Property Detail
  - int from
  - byte[] payload
  - ReservationStatus status
  - int to
- Constructor Detail
  - public ReservationStatusNtf()
    
    Constructor to set the performative to org.arl.fjage.Performative#INFORM.
  - public ReservationStatusNtf(org.arl.fjage.AgentID recipient)
    
    Constructor to specify the recipient agent/topic.
    Parameters:
    recipient - ntf AgentID
  - public ReservationStatusNtf(ReservationReq request)
    
    Constructor to specify the original request associated with this message.
    Parameters:
    request - request associated with this message
- Method Detail
  - public int getFrom()
    
    Gets the address of the source node.
    Returns:
    source address
  - public byte[] getPayload()
    
    Gets payload information in byte[] format.
    Returns:
    payload information
  - public ReservationStatus getStatus()
    
    Gets the current status of channel reservation for a particular reservation request.
    Returns:
    current status
  - public int getTo()
    
    Gets the address (NodeInfoParam.address) of the destination node.
    Returns:
    destination address
  - public void setFrom(int from)
    
    Sets the address of the source node.
    Parameters:
    from - source address
  - public void setPayload(byte[] payload)
    
    Sets payload information using a byte[].
    Parameters:
    payload - payload info in byte[]
  - public void setStatus(ReservationStatus status)
    
    Sets the current status of channel reservation for a particular reservation request.
    Parameters:
    status - to one of the values in ReservationStatus
  - public void setTo(int to)
    
    Sets the address of the destination node.
    Parameters:
    to - destination address
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class ReservationStatusNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected int from

protected byte[] payload

protected ReservationStatus status

protected int to

Property Detail

int from

byte[] payload

ReservationStatus status

int to

Constructor Detail

public ReservationStatusNtf()

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

public ReservationStatusNtf(ReservationReq request)

Method Detail

public int getFrom()

public byte[] getPayload()

public ReservationStatus getStatus()

public int getTo()

public void setFrom(int from)

public void setPayload(byte[] payload)

public void setStatus(ReservationStatus status)

public void setTo(int to)

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