eu.bandm.tools.message

Class MessageAsync<M extends Message>

java.lang.Object

eu.bandm.tools.message.SingleSender<M>

eu.bandm.tools.message.MessageAsync<M>

All Implemented Interfaces:

MessageReceiver<M>

public class MessageAsync<M extends Message>
extends SingleSender<M>
implements MessageReceiver<M>

A sub-class of SingleSender which lets the drain's receive method run asynchronouously in a separate thread.

All received messages are stored internally in a buffer, and the MessageReceiver.receive(Message) method of the current drain is executed in a loop in an own, specially constructed Thread, consuming all these messages asynchronouously.
The caller of the here defined receive(Message) thus returns immediately, after writing the message into a buffer object. (This is currently a LinkedBlockingQueue.)

Field Summary

Fields inherited from class eu.bandm.tools.message.SingleSender

receiver

Constructor Summary

Constructors

Constructor and Description
MessageAsync() After calling this constructor, a call to SingleSender.setReceiver(MessageReceiver) is necessary before you can use SingleSender.send(Message).
MessageAsync(MessageReceiver<? super M> r)

Method Summary

Modifier and Type	Method and Description
void	receive(M m) Returns immediately after storing the message to the internal buffer.

Methods inherited from class eu.bandm.tools.message.SingleSender

getReceiver, send, setReceiver

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageAsync

public MessageAsync()

After calling this constructor, a call to SingleSender.setReceiver(MessageReceiver) is necessary before you can use SingleSender.send(Message). Otherwise code will crash intentionally. Cf the documentation of the super constructor.

MessageAsync

public MessageAsync(MessageReceiver<? super M> r)

Method Detail

receive

public void receive(M m)

Returns immediately after storing the message to the internal buffer.

Will block whenever this buffer is full. Normally this should never happen, since the consumer thread should not "starve" under normal scheduling discipline.
Overrun is probably some kamikaze problem with the producer, since the buffer has a capacity of Integer.MAX_VALUE messages.

Specified by:

receive in interface MessageReceiver<M extends Message>