co.paralleluniverse.galaxy

Interface Messenger

public interface Messenger

The grid's messaging service. All messages are guaranteed delivery in the order they've been sent.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMessageListener(long topic, MessageListener listener) Adds a message listener on a lonng topic.
void	addMessageListener(String topic, MessageListener listener) Adds a message listener on a String topic.
long	createTopic() Returns a new topic.
void	removeMessageListener(long topic, MessageListener listener) Removes a message listener from a lonng topic.
void	removeMessageListener(String topic, MessageListener listener) Removes a message listener from a String topic.
void	send(short node, long topic, byte[] data) Sends a message to a known node, on a long topic.
void	send(short node, long topic, Streamable data) Sends a message to a known node, on a long topic.
void	send(short node, String topic, byte[] data) Sends a message to a known node, on a String topic.
void	send(short node, String topic, Streamable data) Sends a message to a known node, on a String topic.
void	sendToOwnerOf(long ref, long topic, byte[] data) Sends a message to a the owner of a known grid object node, on a long topic.
void	sendToOwnerOf(long ref, long topic, Streamable data) Sends a message to a the owner of a known grid object node, on a long topic.
void	sendToOwnerOf(long ref, String topic, byte[] data) Sends a message to a the owner of a known grid object node, on a String topic.
void	sendToOwnerOf(long ref, String topic, Streamable data) Sends a message to a the owner of a known grid object node, on a String topic.
ListenableFuture<Void>	sendToOwnerOfAsync(long ref, long topic, byte[] data) Sends a message to a the owner of a known grid object node, on a long topic.
ListenableFuture<Void>	sendToOwnerOfAsync(long ref, long topic, Streamable data) Sends a message to a the owner of a known grid object node, on a long topic.
ListenableFuture<Void>	sendToOwnerOfAsync(long ref, String topic, byte[] data) Sends a message to a the owner of a known grid object node, on a String topic.
ListenableFuture<Void>	sendToOwnerOfAsync(long ref, String topic, Streamable data) Sends a message to a the owner of a known grid object node, on a String topic.

Method Detail

createTopic

long createTopic()

Returns a new topic. This topic will be unique among all invocations of this method in a JVM instance.

addMessageListener

void addMessageListener(long topic,
                      MessageListener listener)

Adds a message listener on a lonng topic.

Parameters:

topic - The topic.

listener - The listener.

addMessageListener

void addMessageListener(String topic,
                      MessageListener listener)

Adds a message listener on a String topic.

Parameters:

topic - The topic.

listener - The listener.

removeMessageListener

void removeMessageListener(long topic,
                         MessageListener listener)

Removes a message listener from a lonng topic.

Parameters:

topic - The topic.

listener - The listener.

removeMessageListener

void removeMessageListener(String topic,
                         MessageListener listener)

Removes a message listener from a String topic.

Parameters:

topic - The topic.

listener - The listener.

send

void send(short node,
        String topic,
        byte[] data)

Sends a message to a known node, on a String topic.

Parameters:

node - The node to which to send the message.

topic - The message's topic.

data - The message.

send

void send(short node,
        long topic,
        Streamable data)

Sends a message to a known node, on a long topic.

Parameters:

node - The node to which to send the message.

topic - The message's topic.

data - The message.

send

void send(short node,
        String topic,
        Streamable data)

Sends a message to a known node, on a String topic.

Parameters:

node - The node to which to send the message.

topic - The message's topic.

data - The message.

send

void send(short node,
        long topic,
        byte[] data)

Sends a message to a known node, on a long topic.

Parameters:

node - The node to which to send the message.

topic - The message's topic.

data - The message.

sendToOwnerOf

void sendToOwnerOf(long ref,
                 long topic,
                 byte[] data)
                   throws TimeoutException

Sends a message to a the owner of a known grid object node, on a long topic.

Parameters:

ref - The grid ref to whose owner the message is to be sent.

topic - The message's topic.

data - The message.

Throws:

TimeoutException - This exception is thrown if the operation has times-out.

sendToOwnerOf

void sendToOwnerOf(long ref,
                 String topic,
                 byte[] data)
                   throws TimeoutException

Sends a message to a the owner of a known grid object node, on a String topic.

Parameters:

ref - The grid ref to whose owner the message is to be sent.

topic - The message's topic.

data - The message.

Throws:

TimeoutException - This exception is thrown if the operation has times-out.

sendToOwnerOf

void sendToOwnerOf(long ref,
                 long topic,
                 Streamable data)
                   throws TimeoutException

Sends a message to a the owner of a known grid object node, on a long topic.

Parameters:

ref - The grid ref to whose owner the message is to be sent.

topic - The message's topic.

data - The message.

Throws:

TimeoutException - This exception is thrown if the operation has times-out.

sendToOwnerOf

void sendToOwnerOf(long ref,
                 String topic,
                 Streamable data)
                   throws TimeoutException

Sends a message to a the owner of a known grid object node, on a String topic.

Parameters:

ref - The grid ref to whose owner the message is to be sent.

topic - The message's topic.

data - The message.

Throws:

TimeoutException - This exception is thrown if the operation has times-out.

sendToOwnerOfAsync

ListenableFuture<Void> sendToOwnerOfAsync(long ref,
                                        long topic,
                                        byte[] data)

Sends a message to a the owner of a known grid object node, on a long topic.

Parameters:

ref - The grid ref to whose owner the message is to be sent.

topic - The message's topic.

data - The message.

sendToOwnerOfAsync

ListenableFuture<Void> sendToOwnerOfAsync(long ref,
                                        String topic,
                                        byte[] data)

Sends a message to a the owner of a known grid object node, on a String topic.

Parameters:

ref - The grid ref to whose owner the message is to be sent.

topic - The message's topic.

data - The message.

sendToOwnerOfAsync

ListenableFuture<Void> sendToOwnerOfAsync(long ref,
                                        long topic,
                                        Streamable data)

Sends a message to a the owner of a known grid object node, on a long topic.

Parameters:

ref - The grid ref to whose owner the message is to be sent.

topic - The message's topic.

data - The message.

sendToOwnerOfAsync

ListenableFuture<Void> sendToOwnerOfAsync(long ref,
                                        String topic,
                                        Streamable data)

Sends a message to a the owner of a known grid object node, on a String topic.

Parameters:

ref - The grid ref to whose owner the message is to be sent.

topic - The message's topic.

data - The message.