org.robokind.api.messaging
Interface MessageSender<Msg,Rec,L extends Listener<Msg>>

Type Parameters:

Msg - type of message to send

Rec - type of Record a message is converted to before being sent

L - type of Listener the MessageSender will accept

All Known Implementing Classes:

DefaultMessageSender

public interface MessageSender<Msg,Rec,L extends Listener<Msg>>

High-Level Message sender. Uses an Adapter to convert Messages to Records. Uses a RecordSender to send the Records. Notifies Listeners of Messages sent.

Author:

Matthew Stevenson

Method Summary

void	addMessageListener(L listener) Adds a Listener to be notified when a Message has been sent.
void	removeMessageListener(L listener) Removes a Listener from being notified.
void	sendMessage(Msg message) Sends the given Message.
void	setAdapter(Adapter<Msg,Rec> adapter) Sets the Adapter used to convert Messages to Records.
void	setRecordSender(RecordSender<Rec> sender) Sets the RecordSender responsible for sending Records.
void	start() Initializes and connects the MessageSender, making it ready to send Messages.
void	stop() Stops the MessageSender, making it unable to send Messages.

Method Detail

setRecordSender

void setRecordSender(RecordSender<Rec> sender)

Sets the RecordSender responsible for sending Records.

Parameters:

sender - the RecordSender to set

setAdapter

void setAdapter(Adapter<Msg,Rec> adapter)

Sets the Adapter used to convert Messages to Records.

Parameters:

adapter - the Adapter to set

start

void start()
           throws Exception

Initializes and connects the MessageSender, making it ready to send Messages.

Throws:

Exception - if there is an error starting

stop

void stop()

Stops the MessageSender, making it unable to send Messages.

sendMessage

void sendMessage(Msg message)

Sends the given Message.

Parameters:

message - the Message to send

addMessageListener

void addMessageListener(L listener)

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

Parameters:

listener - the Listener to be notified

removeMessageListener

void removeMessageListener(L listener)

Removes a Listener from being notified.

Parameters:

listener - the Listener to remove