RemoteMessageReq (unet-framework 7.0.0 API)

org.arl.unet.remote.RemoteMessageReq

Request to send an application message to a remote node.

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`MIME_TYPE_BIN`
`static java.lang.String`	`MIME_TYPE_CHAT`
`static java.lang.String`	`MIME_TYPE_CMD`
`static java.lang.String`	`MIME_TYPE_TEXT`
`static java.lang.String`	`MIME_TYPE_UDP_PORTAL`
`static float`	`TTL_MAILBOX`	Special TTL to indicate that the previous unsent message with the same mailbox should be replaced by this one.
`protected java.lang.String`	`mailbox`
`protected java.lang.String`	`messageClass`
`protected java.lang.String`	`mimeType`
`protected java.lang.String`	`remoteRecipient`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`mailbox`
`java.lang.String`	`messageClass`
`java.lang.String`	`mimeType`
`java.lang.String`	`remoteRecipient`
`java.lang.String`	`remoteRecipient`

Constructor Summary

Constructors
Constructor and description
`RemoteMessageReq ()`
`RemoteMessageReq (org.arl.fjage.AgentID recipient)`
`RemoteMessageReq (org.arl.fjage.AgentID recipient, DatagramReq req)`
`RemoteMessageReq (RemoteMessageNtf msg)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getMailbox()` Gets the mailbox name when using TTL_MAILBOX.
	`java.lang.String`	`getMessageClass()` Gets the message class.
	`java.lang.String`	`getMimeType()` Gets the MIME type of the data.
	`java.lang.String`	`getRemoteRecipient()` Gets the remote recipient.
	`void`	`setMailbox(java.lang.String mailbox)` Sets the mailbox name when using TTL_MAILBOX.
	`void`	`setMessageClass(java.lang.String messageClass)` Sets the message class.
	`void`	`setMimeType(java.lang.String mimeType)` Sets the MIME type of the data.
	`void`	`setProtocol(int protocol)`
	`void`	`setRemoteRecipient(java.lang.String remoteRecipient)` Sets the remote recipient.
	`void`	`setRemoteRecipient(org.arl.fjage.AgentID remoteRecipient)` Sets the remote recipient.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DatagramReq`	setData, getData, getProgress, toString, setPriority, getPriority, getProtocol, setProtocol, getReliability, setReliability, getRobustness, setRobustness, getShortcircuit, setShortcircuit, setProgress, getTo, getRoute, setTo, setTtl, getTtl, setRoute, setPerformative, getPerformative, setRecipient, getRecipient, setSender, getSender, setMessageID, getMessageID, setInReplyTo, getInReplyTo, setSentAt, getSentAt, getJsonCache, setJsonCache, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Field Detail
  - public static final java.lang.String MIME_TYPE_BIN
  - public static final java.lang.String MIME_TYPE_CHAT
  - public static final java.lang.String MIME_TYPE_CMD
  - public static final java.lang.String MIME_TYPE_TEXT
  - public static final java.lang.String MIME_TYPE_UDP_PORTAL
  - public static final float TTL_MAILBOX
    
    Special TTL to indicate that the previous unsent message with the same mailbox should be replaced by this one.
  - protected java.lang.String mailbox
  - protected java.lang.String messageClass
  - protected java.lang.String mimeType
  - protected java.lang.String remoteRecipient
- Property Detail
  - java.lang.String mailbox
  - java.lang.String messageClass
  - java.lang.String mimeType
  - java.lang.String remoteRecipient
  - java.lang.String remoteRecipient
- Constructor Detail
  - public RemoteMessageReq()
  - public RemoteMessageReq(org.arl.fjage.AgentID recipient)
  - public RemoteMessageReq(org.arl.fjage.AgentID recipient, DatagramReq req)
  - public RemoteMessageReq(RemoteMessageNtf msg)
- Method Detail
  - public java.lang.String getMailbox()
    
    Gets the mailbox name when using TTL_MAILBOX.
    Returns:
    mailbox name
  - public java.lang.String getMessageClass()
    
    Gets the message class.
    Returns:
    message class
  - public java.lang.String getMimeType()
    
    Gets the MIME type of the data.
    Returns:
    MIME type
  - public java.lang.String getRemoteRecipient()
    
    Gets the remote recipient.
    Returns:
    remote recipient (named topic or agentID)
  - public void setMailbox(java.lang.String mailbox)
    
    Sets the mailbox name when using TTL_MAILBOX.
    Parameters:
    mailbox - mailbox name
  - public void setMessageClass(java.lang.String messageClass)
    
    Sets the message class. Message class may be used by the remote agent to route messages.
    Parameters:
    messageClass - message class
  - public void setMimeType(java.lang.String mimeType)
    
    Sets the MIME type of the data.
    Parameters:
    mimeType - MIME type
  - @java.lang.Override public void setProtocol(int protocol)
  - public void setRemoteRecipient(java.lang.String remoteRecipient)
    
    Sets the remote recipient.
    Parameters:
    remoteRecipient - remote recipient (named topic or agentID)
  - public void setRemoteRecipient(org.arl.fjage.AgentID remoteRecipient)
    
    Sets the remote recipient.
    Parameters:
    remoteRecipient - remote recipient (named topic or agentID)
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class RemoteMessageReq

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String MIME_TYPE_BIN

public static final java.lang.String MIME_TYPE_CHAT

public static final java.lang.String MIME_TYPE_CMD

public static final java.lang.String MIME_TYPE_TEXT

public static final java.lang.String MIME_TYPE_UDP_PORTAL

public static final float TTL_MAILBOX

protected java.lang.String mailbox

protected java.lang.String messageClass

protected java.lang.String mimeType

protected java.lang.String remoteRecipient

Property Detail

java.lang.String mailbox

java.lang.String messageClass

java.lang.String mimeType

java.lang.String remoteRecipient

java.lang.String remoteRecipient

Constructor Detail

public RemoteMessageReq()

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

public RemoteMessageReq(org.arl.fjage.AgentID recipient, DatagramReq req)

public RemoteMessageReq(RemoteMessageNtf msg)

Method Detail

public java.lang.String getMailbox()

public java.lang.String getMessageClass()

public java.lang.String getMimeType()

public java.lang.String getRemoteRecipient()

public void setMailbox(java.lang.String mailbox)

public void setMessageClass(java.lang.String messageClass)

public void setMimeType(java.lang.String mimeType)

@java.lang.Override public void setProtocol(int protocol)

public void setRemoteRecipient(java.lang.String remoteRecipient)

public void setRemoteRecipient(org.arl.fjage.AgentID remoteRecipient)

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