agi.parallel.infrastructure

Interface IMessageEndpoint

All Known Subinterfaces:

IJobSchedulerContext

All Known Implementing Classes:

ClusterJobScheduler

public interface IMessageEndpoint

Represents a client of the messaging system.

Method Summary

Modifier and Type	Method and Description
void	addNewMessageListener(NewMessageListener listener) Adds a handler for an event that occurs when a new message arrives.
java.util.UUID	getId() Gets the id of the participant's mailbox.
void	postMessage(java.lang.Object message, java.util.UUID target) Posts a message to the specified target mailbox.
void	postMessage(java.lang.Object message, java.util.UUID target, boolean quietlyFail) Posts a message to the specified target mailbox.
java.lang.Object	receiveMessage() Receives a message from the participant's mailbox.
java.lang.Object	receiveMessage(int millisecondsTimeout) Receives a message from the participant's mailbox.
java.lang.Object	receiveMessage(int millisecondsTimeout, java.util.UUID[] sender) Receives a message from the participant's mailbox.
java.lang.Object	receiveMessage(java.util.UUID[] sender) Receives a message from the participant's mailbox.

Method Detail

addNewMessageListener

void addNewMessageListener(NewMessageListener listener)

Adds a handler for an event that occurs when a new message arrives.

getId

java.util.UUID getId()

Gets the id of the participant's mailbox.

postMessage

void postMessage(java.lang.Object message,
                 java.util.UUID target)

Posts a message to the specified target mailbox.

Parameters:

message - The message.

target - The target.

Throws:

JobSchedulerException - If target mailbox does not exist.

postMessage

void postMessage(java.lang.Object message,
                 java.util.UUID target,
                 boolean quietlyFail)

Posts a message to the specified target mailbox.

Parameters:

message - The message.

target - The target.

quietlyFail - If true will not throw an exception if target does not exist.

Throws:

JobSchedulerException - If target mailbox does not exist.

receiveMessage

java.lang.Object receiveMessage()

Receives a message from the participant's mailbox. Blocks the current thread until a message arrives.

Returns:

The message.

Throws:

JobSchedulerException - If target mailbox does not exist.

receiveMessage

java.lang.Object receiveMessage(java.util.UUID[] sender)

Receives a message from the participant's mailbox. Blocks the current thread until a message arrives.

Parameters:

sender - The address of the sender of the message.

Returns:

The message.

receiveMessage

java.lang.Object receiveMessage(int millisecondsTimeout)

Receives a message from the participant's mailbox. Blocks the current thread until a message arrives

Parameters:

millisecondsTimeout - The number of milliseconds to wait, or -1 to wait indefinitely.

Returns:

The message.null if timeout is elapsed.

receiveMessage

java.lang.Object receiveMessage(int millisecondsTimeout,
                                java.util.UUID[] sender)

Receives a message from the participant's mailbox. Blocks the current thread until a message arrives

Parameters:

millisecondsTimeout - The number of milliseconds to wait, or -1 to wait indefinitely.

sender - The address of the sender of the message.

Returns:

The message. null if timeout is elapsed.