eu.hgross.blaubot.messaging

Interface IBlaubotChannel

All Known Implementing Classes:

BlaubotChannel

public interface IBlaubotChannel

The channel is the main object to be used for sending and receiving messages. A subscription can be made by the subscribe(IBlaubotMessageListener) and subscribe() methods. Additional message listeners can be added using addMessageListener(IBlaubotMessageListener) or removed using removeMessageListener(IBlaubotMessageListener). A subscription can be removed using unsubscribe(). A channel uses a message queue that is drained using a defined IBlaubotMessagePickerStrategy. To send messages, use the publish methods. The picking strategy and some other configurations can be changed at runtime, using the BlaubotChannelConfig, which is retrievable using getChannelConfig().

Method Summary

Modifier and Type	Method and Description
void	addMessageListener(IBlaubotMessageListener messageListener) Add a message listener to this channel to get notifications when messages arrive.
void	clearMessageQueue() Clears the message queue.
BlaubotChannelConfig	getChannelConfig() Gets the channel config
boolean	publish(BlaubotMessage blaubotMessage) Deprecated. we don't allow the pre-creation of BlaubotMessages anymore
boolean	publish(BlaubotMessage blaubotMessage, boolean excludeSender) Deprecated. we don't allow the pre-creation of BlaubotMessages anymore
boolean	publish(BlaubotMessage blaubotMessage, long timeout) Deprecated. we don't allow the pre-creation of BlaubotMessages anymore
boolean	publish(BlaubotMessage blaubotMessage, long timeout, boolean excludeSender) Deprecated. we don't allow the pre-creation of BlaubotMessages anymore
boolean	publish(byte[] payload) Post the payload to this channel's queue.
boolean	publish(byte[] payload, boolean excludeSender) Post the payload to this channel's queue.
boolean	publish(byte[] payload, long timeout) Post the payload to this channel's queue.
boolean	publish(byte[] payload, long timeout, boolean excludeSender) Post the payload to this channel's queue.
void	removeMessageListener(IBlaubotMessageListener messageListener) Removes a previously added message listener from this channel If after the operation no listener is attached to this channel anymore, unsubscribe() is called automatically.
void	subscribe() Subscribes to the channel
void	subscribe(IBlaubotMessageListener blaubotMessageListener) Subscribes to this channel and attaches a message listener
void	unsubscribe() Remove the subscription of this channel

Method Detail

publish

boolean publish(BlaubotMessage blaubotMessage)

Deprecated. we don't allow the pre-creation of BlaubotMessages anymore

Posts a BlaubotMessage to the message queue of this channel to be dispatched to subscribers later.

Parameters:

blaubotMessage - the message

Returns:

true, iff the message was added to the queue or false, if the queue was full while trying to publish

publish

boolean publish(BlaubotMessage blaubotMessage,
                boolean excludeSender)

Deprecated. we don't allow the pre-creation of BlaubotMessages anymore

Posts a BlaubotMessage to the message queue of this channel to be dispatched to subscribers later. Will block, if the channel's message queue is full.

Parameters:

blaubotMessage - the message

excludeSender - if true, the message will not be dispatched back to this channel but to all other subscribers.

Returns:

true, iff the message was added to the queue or false, if the queue was full while trying to publish

publish

boolean publish(BlaubotMessage blaubotMessage,
                long timeout)

Deprecated. we don't allow the pre-creation of BlaubotMessages anymore

Posts a BlaubotMessage to the message queue of this channel to be dispatched to subscribers later. Blocks for 'timeout' milliseconds, if the channel's message queue is full.

Parameters:

blaubotMessage - the mssage

timeout - the timeout in ms

Returns:

true, iff the message was added to the queue or false, if the timeout elapsed before

publish

boolean publish(BlaubotMessage blaubotMessage,
                long timeout,
                boolean excludeSender)

Deprecated. we don't allow the pre-creation of BlaubotMessages anymore

Posts a BlaubotMessage to the message queue of this channel to be dispatched to subscribers later. Blocks for 'timeout' milliseconds, if the channel's message queue is full.

Parameters:

blaubotMessage - the mssage

timeout - the timeout in ms

excludeSender - if true, the message will not be dispatched back to this channel but to all other subscribers.

Returns:

true, iff the message was added to the queue or false, if the timeout elapsed before

publish

boolean publish(byte[] payload)

Post the payload to this channel's queue. The payload will be wrapped in a BlaubotMessage.

Parameters:

payload - the payload as byte array

Returns:

true, iff the message was added to the queue or false, if the queue was full while trying to publish

publish

boolean publish(byte[] payload,
                boolean excludeSender)

Post the payload to this channel's queue. The payload will be wrapped in a BlaubotMessage.

Parameters:

payload - the payload as byte array

excludeSender - if true, the message will not be dispatched back to this channel but to all other subscribers.

Returns:

true, iff the message was added to the queue or false, if the queue was full while trying to publish

publish

boolean publish(byte[] payload,
                long timeout)

Post the payload to this channel's queue. The payload will be wrapped in a BlaubotMessage. Blocks for 'timeout' milliseconds, if the channel's message queue is full.

Parameters:

payload - the payload as byte array

timeout - the timeout in ms

Returns:

true, iff the message was added to the queue or false, if the timeout elapsed before

publish

boolean publish(byte[] payload,
                long timeout,
                boolean excludeSender)

Post the payload to this channel's queue. The payload will be wrapped in a BlaubotMessage. Blocks for 'timeout' milliseconds, if the channel's message queue is full.

Parameters:

payload - the payload as byte array

timeout - the timeout in ms

excludeSender - if true, the message will not be dispatched back to this channel but to all other subscribers.

Returns:

true, iff the message was added to the queue or false, if the timeout elapsed before

subscribe

void subscribe(IBlaubotMessageListener blaubotMessageListener)

Subscribes to this channel and attaches a message listener

Parameters:

blaubotMessageListener - the listener to be informed about new messages on this channel

subscribe

void subscribe()

Subscribes to the channel

unsubscribe

void unsubscribe()

Remove the subscription of this channel

getChannelConfig

BlaubotChannelConfig getChannelConfig()

Gets the channel config

Returns:

the channel config

clearMessageQueue

void clearMessageQueue()

Clears the message queue. Useful in situations when the blaubot instance gets disconnected and there are still unsent messages in the queue.

addMessageListener

void addMessageListener(IBlaubotMessageListener messageListener)

Add a message listener to this channel to get notifications when messages arrive. Note that this method does not subscribe automatically subscribe to the channel. Call subscribe() if you want to get messages dispatched to this channel.

Parameters:

messageListener - the message listener to add

removeMessageListener

void removeMessageListener(IBlaubotMessageListener messageListener)

Removes a previously added message listener from this channel If after the operation no listener is attached to this channel anymore, unsubscribe() is called automatically.

Parameters:

messageListener - the listener to remove