TxAckReq (unet-framework 7.0.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 an ACK PDU.

Field Summary

Fields
Modifiers	Name	Description
`protected byte[]`	`payload`
`protected java.lang.String`	`requestID`

Properties Summary

Properties
Type	Name and description
`byte[]`	`payload`
`java.lang.String`	`requestID`

Constructor Summary

Constructors
Constructor and description
`TxAckReq ()` Constructor to set the performative to org.arl.fjage.Performative#REQUEST.
`TxAckReq (org.arl.fjage.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[].
	`java.lang.String`	`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(java.lang.String requestID)` Sets the identifier of the reservation request to a unique value.
	`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[] payload
  - protected java.lang.String requestID
- Property Detail
  - byte[] payload
  - java.lang.String requestID
- Constructor Detail
  - public TxAckReq()
    
    Constructor to set the performative to org.arl.fjage.Performative#REQUEST.
  - public TxAckReq(org.arl.fjage.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 java.lang.String 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(java.lang.String requestID)
    
    Sets the identifier of the reservation request to a unique value.
    Parameters:
    requestID - unique identifier
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation