org.robokind.api.messaging
Class DefaultMessageAsyncReceiver<Msg,Rec,L extends Listener<Msg>>

java.lang.Object
  org.robokind.api.messaging.DefaultMessageAsyncReceiver<Msg,Rec,L>

Type Parameters:

Msg - type of Message received

Rec - type of underlying Record received

L - type of Listener to notify

All Implemented Interfaces:

MessageAsyncReceiver<Msg,Rec,L>

public class DefaultMessageAsyncReceiver<Msg,Rec,L extends Listener<Msg>>
extends Object
implements MessageAsyncReceiver<Msg,Rec,L>

Default MessageAsyncReceiver implementation. Uses a RecordAdapterHandler as a RecordHandler to passes Records to an Adapter for deserialization.

Author:

Matthew Stevenson

Constructor Summary

DefaultMessageAsyncReceiver()
Creates an empty DefaultMessageAsyncReceiver.

Method Summary

void	addMessageListener(L listener) Adds a Listener to be notified when a Message has been received.
protected void	fireMessageEvent(Msg message) Notifies listeners of a Message
void	pause() Pauses a MessageAsyncReceiver.
void	removeMessageListener(L listener) Removes a Listener from being notified.
void	resume() Resumes a paused MessageAsyncReceiver.
void	setAdapter(Adapter<Rec,Msg> adapter) Sets the Adapter used to convert Records to Messages.
void	setRecordReceiver(RecordAsyncReceiver<Rec> service) Sets the RecordAsyncReceiver used to receive Records.
void	start() Initializes and connects the MessageAsyncReceiver, and begins receiving Messages.
void	stop() Stops the MessageAsyncReceiver, making it unable to receive Messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMessageAsyncReceiver

public DefaultMessageAsyncReceiver()

Creates an empty DefaultMessageAsyncReceiver.

Method Detail

setRecordReceiver

public void setRecordReceiver(RecordAsyncReceiver<Rec> service)

Description copied from interface: MessageAsyncReceiver

Sets the RecordAsyncReceiver used to receive Records.

Specified by:

setRecordReceiver in interface MessageAsyncReceiver<Msg,Rec,L extends Listener<Msg>>

Parameters:

service - theRecordReceiver to set

setAdapter

public void setAdapter(Adapter<Rec,Msg> adapter)

Description copied from interface: MessageAsyncReceiver

Sets the Adapter used to convert Records to Messages.

Specified by:

setAdapter in interface MessageAsyncReceiver<Msg,Rec,L extends Listener<Msg>>

Parameters:

adapter - the Adapter to set

start

public void start()
           throws Exception

Description copied from interface: MessageAsyncReceiver

Initializes and connects the MessageAsyncReceiver, and begins receiving Messages.

Specified by:

start in interface MessageAsyncReceiver<Msg,Rec,L extends Listener<Msg>>

Throws:

Exception - if there is an error starting

pause

public void pause()

Description copied from interface: MessageAsyncReceiver

Pauses a MessageAsyncReceiver.

Specified by:

pause in interface MessageAsyncReceiver<Msg,Rec,L extends Listener<Msg>>

resume

public void resume()

Description copied from interface: MessageAsyncReceiver

Resumes a paused MessageAsyncReceiver.

Specified by:

resume in interface MessageAsyncReceiver<Msg,Rec,L extends Listener<Msg>>

stop

public void stop()

Description copied from interface: MessageAsyncReceiver

Stops the MessageAsyncReceiver, making it unable to receive Messages.

Specified by:

stop in interface MessageAsyncReceiver<Msg,Rec,L extends Listener<Msg>>

fireMessageEvent

protected void fireMessageEvent(Msg message)

Notifies listeners of a Message

Parameters:

message -

addMessageListener

public void addMessageListener(L listener)

Description copied from interface: MessageAsyncReceiver

Adds a Listener to be notified when a Message has been received.

Specified by:

addMessageListener in interface MessageAsyncReceiver<Msg,Rec,L extends Listener<Msg>>

Parameters:

listener - the Listener to be notified

removeMessageListener

public void removeMessageListener(L listener)

Description copied from interface: MessageAsyncReceiver

Removes a Listener from being notified.

Specified by:

removeMessageListener in interface MessageAsyncReceiver<Msg,Rec,L extends Listener<Msg>>

Parameters:

listener - the Listener to remove