DatagramCancelReq (UnetStack 3.4.0 API)

Summary:
Field
Property
Constructor
Method

org.arl.unet.DatagramCancelReq

Request to cancel ongoing datagram transfer.

Field Summary

Fields
Modifiers	Name	Description
`protected String`	`id`

Properties Summary

Properties
Type	Name and description
`String`	`id`

Constructor Summary

Constructors
Constructor and description
`DatagramCancelReq ()`
`DatagramCancelReq (AgentID recipient)` Create a cancellation request for all ongoing transfers.
`DatagramCancelReq (DatagramReq request)` Create a cancellation request for a specified datagram request.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`getId()` Gets the datagram request ID.
	`void`	`setId(String id)` Sets datagram request ID.
	`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 String id
- Property Detail
  - String id
- Constructor Detail
  - public DatagramCancelReq()
  - public DatagramCancelReq(AgentID recipient)
    
    Create a cancellation request for all ongoing transfers.
    Parameters:
    recipient - recipient of this message
  - public DatagramCancelReq(DatagramReq request)
    
    Create a cancellation request for a specified datagram request.
    Parameters:
    request - datagram request
- Method Detail
  - public String getId()
    
    Gets the datagram request ID.
    Returns:
    datagram request ID
  - public void setId(String id)
    
    Sets datagram request ID.
    Parameters:
    id - datagram request ID
  - @Override public String toString()

Summary:
Field
Property
Constructor
Method

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