nats.client

Interface Message

All Known Implementing Classes:

DefaultMessage

public interface Message

A NATS message.

Author:

Mike Heath

Method Summary

Modifier and Type	Method and Description
String	getBody() Returns the body of the message.
String	getQueueGroup() Returns the queue group of the message.
String	getSubject() Returns the subject used to send the message.
boolean	isRequest() Returns true if the message originated from a request, false if the message originated from a publish.
void	reply(String message) Sends a reply to this message.
void	reply(String message, long delay, TimeUnit unit) Sends a reply to this message after the specified delay has passed.

Method Detail

isRequest

boolean isRequest()

Returns true if the message originated from a request, false if the message originated from a publish. If the message originated from a request, the reply(String) and reply(String, long, java.util.concurrent.TimeUnit) may be used to reply to the request.

Returns:

true if the message originated from a request, false if the message originated from a publish.

getSubject

String getSubject()

Returns the subject used to send the message.

Returns:

the subject used to send the message.

getBody

String getBody()

Returns the body of the message.

Returns:

the body of the message.

getQueueGroup

String getQueueGroup()

Returns the queue group of the message.

Returns:

the queue group of the message.

reply

void reply(String message)

Sends a reply to this message. If the the message did not contain a replyTo field, a NatsException will be thrown.

Parameters:

message - the message with which to reply to the requester

Throws:

UnsupportedOperationException - if the message did not originate from a request

reply

void reply(String message,
           long delay,
           TimeUnit unit)

Sends a reply to this message after the specified delay has passed. This method returns immediate and sends the delayed response asynchronously. If the the message did not contain a replyTo field, a NatsException will be thrown.

Parameters:

message - the message with which to reply to the requester

delay - the amount of time to wait before sending the reply

unit - the time unit of the delay argument

Throws:

UnsupportedOperationException - if the message did not originate from a request