TxAckReq (UnetStack 3.4.0 API)

Summary:
Field
Property
Constructor
Method

org.arl.unet.mac.TxAckReq

ACK request message at the RX node. This message is sent by the client agent when it hears the ReservationStatusNtf, or when the client agent has received all the data. Usually sent to a MAC agent which provides MacCapability.RELIABILITY. The payload information is transmitted across in a ACK PDU.

Field Summary

Fields
Modifiers	Name	Description
`protected byte[]`	`payload`
`protected Object`	`requestID`

Properties Summary

Properties
Type	Name and description
`byte[]`	`payload`
`Object`	`requestID`

Constructor Summary

Constructors
Constructor and description
`TxAckReq ()` Constructor to set the performative to Performative.REQUEST.
`TxAckReq (AgentID recipient)` Constructor to set the recipient agentID

Methods Summary

Methods
Type Params	Return Type	Name and description
	`byte[]`	`getPayload()` Gets the payload information as a byte[].
	`Object`	`getRequestID()` Gets the unique identifier associated with a reservation request.
	`void`	`setPayload(byte[] payload)` Sets payload with information using a byte[], any information that is to be communicated with the Tx client agent.
	`void`	`setRequestID(Object requestID)` Sets the identifier of the reservation request to a unique value.
	`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[] payload
  - protected Object requestID
- Property Detail
  - byte[] payload
  - Object requestID
- Constructor Detail
  - public TxAckReq()
    
    Constructor to set the performative to Performative.REQUEST.
  - public TxAckReq(AgentID recipient)
    
    Constructor to set the recipient agentID
    Parameters:
    recipient - AgentID
- Method Detail
  - public byte[] getPayload()
    
    Gets the payload information as a byte[].
    Returns:
    payload information
  - public Object getRequestID()
    
    Gets the unique identifier associated with a reservation request.
    Returns:
    requestID
  - public void setPayload(byte[] payload)
    
    Sets payload with information using a byte[], any information that is to be communicated with the Tx client agent.
    Parameters:
    payload - information in byte[]
  - public void setRequestID(Object requestID)
    
    Sets the identifier of the reservation request to a unique value.
    Parameters:
    requestID - unique identifier
  - @Override public String toString()

Summary:
Field
Property
Constructor
Method

Copyright 2013-21, Acoustic Research Laboratory, National University of Singapore, and Subnero Pte Ltd