eu.hgross.blaubot.messaging

Class BlaubotChannelConfig

java.lang.Object

java.util.Observable

eu.hgross.blaubot.messaging.BlaubotChannelConfig

public class BlaubotChannelConfig
extends java.util.Observable

Configuration for a BlaubotChannel. Can limit message rates and set picking strategies as well as priorities. The channel configuration is local - changes made are only reflected to the local device and not communicated to other devices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlaubotChannelConfig.MessagePickerStrategy Unique identifier for PickingStrategy-Implementations.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MESSAGE_RATE_NO_LIMIT Use this constant for {BlaubotChannelConfig#setMessageRateLimit} to not use a message rate limit.

Constructor Summary

Constructors

Constructor and Description
BlaubotChannelConfig(short channelId) Constructs a channel config for a channel id using the default MessagePickerStrategy (PROCESS_ALL).

Method Summary

Modifier and Type	Method and Description
short	getChannelId() The channel id
protected IBlaubotMessagePickerStrategy	getMessagePicker() Gets the mesage picker strategy specified by the user
int	getMinMessageRateDelay() The minimun delay between two messages.
BlaubotChannelConfig.MessagePickerStrategy	getPickerStrategy()
BlaubotMessage.Priority	getPriority() The priority for messages sent through this channel.
int	getQueueCapacity() The max size of the message queue
boolean	isTransmitIfNoSubscribers() Check whether mesages are sent even if there are no known subscribers to this channel.
boolean	isTransmitReflexiveMessages() Check if reflexive messages to this channel are sent through the network or directly posted to your listeners instead.
BlaubotChannelConfig	setMessagePickerStrategy(BlaubotChannelConfig.MessagePickerStrategy strategy) Sets the MessagePickerStrategy that defines, how fast messages are send or discarded.
BlaubotChannelConfig	setMessageRateLimit(int minMessageRateDelay) Sets the message rate limit.
BlaubotChannelConfig	setPriority(BlaubotMessage.Priority priority) Sets the priority for messages sent through this channel.
void	setQueueCapacity(int queueCapacity) Sets max the size of the message queue.
void	setTransmitIfNoSubscribers(boolean transmitIfNoSubscribers) Sets a flag to avoid sending messages, if there are no known subscribers yet.
void	setTransmitReflexiveMessages(boolean transmitReflexiveMessages) If set to true, reflexive messages (messages that are posted to a channel to which we are subscribed) are not send to the master device but directly posted to the registered listeners.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_RATE_NO_LIMIT

public static final int MESSAGE_RATE_NO_LIMIT

Use this constant for {BlaubotChannelConfig#setMessageRateLimit} to not use a message rate limit.

See Also:

Constant Field Values

Constructor Detail

BlaubotChannelConfig

public BlaubotChannelConfig(short channelId)

Constructs a channel config for a channel id using the default MessagePickerStrategy (PROCESS_ALL). To change the MessagePickerStrategy, @see {BlaubotChannelConfig#setMessagePickerStrategy}.

Parameters:

channelId - the channel's id

Method Detail

setQueueCapacity

public void setQueueCapacity(int queueCapacity)

Sets max the size of the message queue. Attention: If there are currently more than queueCapacity messages in the message queue, all messages that exceed the queue capacity will be dropped. This is likely to happen, if the queue size is decreased at runtime.

Parameters:

queueCapacity - the new capacity.

getQueueCapacity

public int getQueueCapacity()

The max size of the message queue

Returns:

max number of messages in the queue

getChannelId

public short getChannelId()

The channel id

Returns:

channel id

getMessagePicker

protected IBlaubotMessagePickerStrategy getMessagePicker()

Gets the mesage picker strategy specified by the user

Returns:

the message picker strategy

getPickerStrategy

public BlaubotChannelConfig.MessagePickerStrategy getPickerStrategy()

Returns:

the currently used picker strategy

setMessagePickerStrategy

public BlaubotChannelConfig setMessagePickerStrategy(BlaubotChannelConfig.MessagePickerStrategy strategy)

Sets the MessagePickerStrategy that defines, how fast messages are send or discarded.

Parameters:

strategy - the strategy to use

Returns:

this channel config instance

See Also:

BlaubotChannelConfig.MessagePickerStrategy

setMessageRateLimit

public BlaubotChannelConfig setMessageRateLimit(int minMessageRateDelay)

Sets the message rate limit.

Parameters:

minMessageRateDelay - the minimum delay between two messages that are picked to be sent in milliseconds

Returns:

this channel config object

setPriority

public BlaubotChannelConfig setPriority(BlaubotMessage.Priority priority)

Sets the priority for messages sent through this channel.

Parameters:

priority - the priority

Returns:

this config instance

getPriority

public BlaubotMessage.Priority getPriority()

The priority for messages sent through this channel.

Returns:

the priority

getMinMessageRateDelay

public int getMinMessageRateDelay()

The minimun delay between two messages.

Returns:

minimun delay between two messages as configured by the user

isTransmitReflexiveMessages

public boolean isTransmitReflexiveMessages()

Check if reflexive messages to this channel are sent through the network or directly posted to your listeners instead. This means the messages published by a sending device which is also subscribed to this channel will not have to send and receive the message to receive it on it's handlers. Of course, all ohter devices have to receive this message.

Returns:

true, if reflexive messages will be sent through the network. Otherwise these message will not cause unnecessary traffic on the sending device.

setTransmitReflexiveMessages

public void setTransmitReflexiveMessages(boolean transmitReflexiveMessages)

If set to true, reflexive messages (messages that are posted to a channel to which we are subscribed) are not send to the master device but directly posted to the registered listeners. This means the messages published by a sending device which is also subscribed to this channel will not have to send and receive the message to receive it on it's handlers. Of course, all ohter devices have to receive this message.

Parameters:

transmitReflexiveMessages - true to reduce traffic in these cases on the sending device

isTransmitIfNoSubscribers

public boolean isTransmitIfNoSubscribers()

Check whether mesages are sent even if there are no known subscribers to this channel.

Returns:

true, if messages are sent even if there are no subscribers to this channel

setTransmitIfNoSubscribers

public void setTransmitIfNoSubscribers(boolean transmitIfNoSubscribers)

Sets a flag to avoid sending messages, if there are no known subscribers yet.

Parameters:

transmitIfNoSubscribers - If set to true, messages published to this channel are always send