eu.hgross.blaubot.messaging

Class BlaubotMessageReceiver

java.lang.Object

eu.hgross.blaubot.messaging.BlaubotMessageReceiver

public class BlaubotMessageReceiver
extends java.lang.Object

A message receiver handles incoming data streams from an IBlaubotConnection. It converts the byte stream into BlaubotMessage instances and notifies it's listeners when a message was completely read. Message listeners can be activated and deactivated.

Constructor Summary

Constructors

Constructor and Description
BlaubotMessageReceiver(IBlaubotConnection blaubotConnection)

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the message receiver (reading from the connection).
void	addMessageListener(IBlaubotMessageListener messageListener)
void	deactivate(IActionListener actionListener) Deactivates the message receiver (completes current message readings, if any and then shuts down)
boolean	equals(java.lang.Object o)
IBlaubotConnection	getBlaubotConnection() The blaubot connection used to receive messages.
long	getReceivedChunkMessages()
long	getReceivedMessages()
long	getReceivedPayloadBytes()
int	hashCode()
void	removeMessageListener(IBlaubotMessageListener messageListener)
void	setForwardChunks(boolean forwardChunks) If set to true, the receiver will not collect chunks and dispatch the whole (pieced together) message to the listeners, but simply forward the chunks to the listeners.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BlaubotMessageReceiver

public BlaubotMessageReceiver(IBlaubotConnection blaubotConnection)

Method Detail

addMessageListener

public void addMessageListener(IBlaubotMessageListener messageListener)

removeMessageListener

public void removeMessageListener(IBlaubotMessageListener messageListener)

getBlaubotConnection

public IBlaubotConnection getBlaubotConnection()

The blaubot connection used to receive messages.

Returns:

the connection object used to receive messages

activate

public void activate()

Activates the message receiver (reading from the connection). If the receiver was already started, it will start a new consumer-thread that will sequentially take over the work from the previous thread.

deactivate

public void deactivate(IActionListener actionListener)

Deactivates the message receiver (completes current message readings, if any and then shuts down)

Parameters:

actionListener - callback to be informed when the receiver was closed (thread finished), can be null

getReceivedMessages

public long getReceivedMessages()

Returns:

number of received messages so far (including chunks)

getReceivedPayloadBytes

public long getReceivedPayloadBytes()

Returns:

number of received payload bytes so far (including chunks)

setForwardChunks

public void setForwardChunks(boolean forwardChunks)

If set to true, the receiver will not collect chunks and dispatch the whole (pieced together) message to the listeners, but simply forward the chunks to the listeners. Default: false

Parameters:

forwardChunks - iff true, chunk forwarding is active

getReceivedChunkMessages

public long getReceivedChunkMessages()

Returns:

number of received chunk messages (chunks themselves)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object