org.mini2Dx.minibus

Class MessageBus

java.lang.Object

org.mini2Dx.minibus.MessageBus

public class MessageBus
extends java.lang.Object

A message bus to publishing MessageDatas

Constructor Summary

Constructors

Constructor and Description
MessageBus() Constructor

Method Summary

Modifier and Type	Method and Description
void	broadcast(MessageExchange source, java.lang.String messageType) Broadcasts a message to all MessageExchanges from a specified MessageExchange
void	broadcast(MessageExchange source, java.lang.String messageType, MessageData messageData) Broadcasts a message with MessageData to all MessageExchanges from a specified MessageExchange
void	broadcast(java.lang.String messageType) Broadcasts a message to all MessageExchanges from an anonymous source
void	broadcast(java.lang.String messageType, MessageData messageData) Broadcasts a message with MessageData to all MessageExchanges from an anonymous source
void	broadcastQuery(java.lang.String messageType, MessageData messageData, java.lang.String responseMessageType, boolean requiresDirectResponse, MessageHandler queryHandler) Broadcasts a message and calls a MessageHandler when a response message is received.
void	broadcastQuery(java.lang.String messageType, MessageData messageData, java.lang.String responseMessageType, MessageHandler queryHandler) Broadcasts a message and calls a MessageHandler when a response message is received.
void	broadcastQuery(java.lang.String messageType, java.lang.String responseMessageType, boolean requiresDirectResponse, MessageHandler queryHandler) Broadcasts a message and calls a MessageHandler when a response message is received.
void	broadcastQuery(java.lang.String messageType, java.lang.String responseMessageType, MessageHandler queryHandler) Broadcasts a message and calls a MessageHandler when a response message is received.
MessageExchange	createConcurrentExchange(MessageHandler... messageHandlers) Creates a ConcurrentMessageExchange that processes messages on its own Thread.
MessageExchange	createImmediateExchange(MessageHandler... messageHandlers) Creates a ImmediateMessageExchange that processes messages immediately when they are received
MessageExchange	createIntervalExchange(float interval, MessageHandler messageHandlers) Creates a IntervalMessageExchange that processes messages after a certain amount of time has elapsed.
MessageExchange	createOnUpdateExchange(MessageHandler... messageHandlers) Creates a OnUpdateMessageExchange that processes messages when update(float) is called
int	getAnonymousExchangeId() Returns the id of the MessageExchange used for anonymous sending
int	getQueryMessagePoolSize() Returns the amount of QueryMessageExchange instances available
int	getTotalActiveExchanges() Returns the total amount of active MessageExchanges (including QueryMessageExchanges
void	send(MessageExchange source, MessageExchange destination, java.lang.String messageType) Sends a message from one MessageExchange to another
void	send(MessageExchange source, MessageExchange destination, java.lang.String messageType, MessageData messageData) Sends a message with MessageData from one MessageExchange to another
void	sendTo(MessageExchange destination, java.lang.String messageType) Sends a message to a MessageExchange from an anonymous source
void	sendTo(MessageExchange destination, java.lang.String messageType, MessageData messageData) Sends a message with MessageData to a MessageExchange from an anonymous source
void	update(float delta) Updates all MessageExchanges

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageBus

public MessageBus()

Constructor

Method Detail

update

public void update(float delta)

Updates all MessageExchanges

Parameters:

delta - (in seconds) The timestep or amount of time that has elapsed since the last frame

createImmediateExchange

public MessageExchange createImmediateExchange(MessageHandler... messageHandlers)

Creates a ImmediateMessageExchange that processes messages immediately when they are received

Parameters:

messageHandlers - The MessageHandler instances for processing messages received by the MessageExchange

Returns:

A new ImmediateMessageExchange

createIntervalExchange

public MessageExchange createIntervalExchange(float interval,
                                              MessageHandler messageHandlers)

Creates a IntervalMessageExchange that processes messages after a certain amount of time has elapsed.

Parameters:

interval - The interval between processing MessageDatas (in seconds)

messageHandlers - The MessageHandler instances for processing messages received by the MessageExchange

Returns:

A new IntervalMessageExchange

createOnUpdateExchange

public MessageExchange createOnUpdateExchange(MessageHandler... messageHandlers)

Creates a OnUpdateMessageExchange that processes messages when update(float) is called

Parameters:

messageHandlers - The MessageHandler instances for processing messages received by the MessageExchange

Returns:

A new OnUpdateMessageExchange

createConcurrentExchange

public MessageExchange createConcurrentExchange(MessageHandler... messageHandlers)

Creates a ConcurrentMessageExchange that processes messages on its own Thread. The exchanger/thread can be stopped by calling MessageExchange.dispose()

Parameters:

messageHandlers - The MessageHandler instances for processing messages received by the MessageExchange

Returns:

A new ConcurrentMessageExchange running on its own thread

broadcast

public void broadcast(java.lang.String messageType)

Broadcasts a message to all MessageExchanges from an anonymous source

Parameters:

messageType - The message type

broadcast

public void broadcast(java.lang.String messageType,
                      MessageData messageData)

Broadcasts a message with MessageData to all MessageExchanges from an anonymous source

Parameters:

messageType - The message type

messageData - The MessageData to be published

broadcast

public void broadcast(MessageExchange source,
                      java.lang.String messageType)

Broadcasts a message to all MessageExchanges from a specified MessageExchange

Parameters:

source - The MessageExchange to broadcast the MessageData from

messageType - The message type

broadcast

public void broadcast(MessageExchange source,
                      java.lang.String messageType,
                      MessageData messageData)

Broadcasts a message with MessageData to all MessageExchanges from a specified MessageExchange

Parameters:

source - The MessageExchange to broadcast the MessageData from

messageType - The message type

messageData - The MessageData to broadcast

send

public void send(MessageExchange source,
                 MessageExchange destination,
                 java.lang.String messageType)

Sends a message from one MessageExchange to another

Parameters:

source - The MessageExchange the MessageData is sent from

destination - The MessageExchange the MessageData is sent to

messageType - The message type

send

public void send(MessageExchange source,
                 MessageExchange destination,
                 java.lang.String messageType,
                 MessageData messageData)

Sends a message with MessageData from one MessageExchange to another

Parameters:

source - The MessageExchange the MessageData is sent from

destination - The MessageExchange the MessageData is sent to

messageType - The message type

messageData - The MessageData that is sent

sendTo

public void sendTo(MessageExchange destination,
                   java.lang.String messageType)

Sends a message to a MessageExchange from an anonymous source

Parameters:

destination - The MessageExchange the MessageData is sent to

messageType - The message type

sendTo

public void sendTo(MessageExchange destination,
                   java.lang.String messageType,
                   MessageData messageData)

Sends a message with MessageData to a MessageExchange from an anonymous source

Parameters:

destination - The MessageExchange the MessageData is sent to

messageType - The message type

messageData - The MessageData that is sent

broadcastQuery

public void broadcastQuery(java.lang.String messageType,
                           java.lang.String responseMessageType,
                           MessageHandler queryHandler)

Broadcasts a message and calls a MessageHandler when a response message is received.

Parameters:

messageType - The message type to send

responseMessageType - The required message type of the response

queryHandler - The MessageHandler to call when the response is received

broadcastQuery

public void broadcastQuery(java.lang.String messageType,
                           java.lang.String responseMessageType,
                           boolean requiresDirectResponse,
                           MessageHandler queryHandler)

Broadcasts a message and calls a MessageHandler when a response message is received.

Parameters:

messageType - The message type to send

responseMessageType - The required message type of the response

requiresDirectResponse - True if a direct response is required. A direct response is a message sent explicitly from a MessageExchange to the MessageExchange used to send the query.

queryHandler - The MessageHandler to call when the response is received

broadcastQuery

public void broadcastQuery(java.lang.String messageType,
                           MessageData messageData,
                           java.lang.String responseMessageType,
                           MessageHandler queryHandler)

Broadcasts a message and calls a MessageHandler when a response message is received.

Parameters:

messageType - The message type to send

messageData - The MessageData to send

responseMessageType - The required message type of the response

queryHandler - The MessageHandler to call when the response is received

broadcastQuery

public void broadcastQuery(java.lang.String messageType,
                           MessageData messageData,
                           java.lang.String responseMessageType,
                           boolean requiresDirectResponse,
                           MessageHandler queryHandler)

Broadcasts a message and calls a MessageHandler when a response message is received.

Parameters:

messageType - The message type to send

messageData - The MessageData to send

responseMessageType - The required message type of the response

requiresDirectResponse - True if a direct response is required. A direct response is a message sent explicitly from a MessageExchange to the MessageExchange used to send the query.

queryHandler - The MessageHandler to call when the response is received

getQueryMessagePoolSize

public int getQueryMessagePoolSize()

Returns the amount of QueryMessageExchange instances available

Returns:

0 if no queries have ever completed

getAnonymousExchangeId

public int getAnonymousExchangeId()

Returns the id of the MessageExchange used for anonymous sending

Returns:

getTotalActiveExchanges

public int getTotalActiveExchanges()

Returns the total amount of active MessageExchanges (including QueryMessageExchanges

Returns: