FailureNtf (UnetStack 3.4.0 API)

Summary:
Constructor
Method

| Detail:
Constructor
Method

org.arl.unet.FailureNtf

Failure notification related to a request, optionally indicating a reason for failure.

Constructor Summary

Constructors
Constructor and description
`FailureNtf ()` Constructs a failure notification message.
`FailureNtf (Message msg)` Constructs a failure notification with no reason specified.
`FailureNtf (String reason)` Constructs a failure notification message.
`FailureNtf (Message msg, String reason)` Constructs a failure notification message.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`getReason()` Gets the reason why the request failed.
	`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`

- Constructor Detail
  - public FailureNtf()
    
    Constructs a failure notification message.
  - public FailureNtf(Message msg)
    
    Constructs a failure notification with no reason specified.
    Parameters:
    msg - message to which this notification corresponds to.
  - public FailureNtf(String reason)
    
    Constructs a failure notification message.
    Parameters:
    reason - descriptive reason for failure.
  - public FailureNtf(Message msg, String reason)
    
    Constructs a failure notification message.
    Parameters:
    msg - message to which this notification corresponds to.
    reason - descriptive reason for failure.
- Method Detail
  - public String getReason()
    
    Gets the reason why the request failed.
    Returns:
    descriptive reason string or null.
  - @Override public String toString()

Summary:
Constructor
Method

| Detail:
Constructor
Method

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