|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.robokind.api.messaging.DefaultMessageSender<Msg,Rec,L>
Msg
- type of Message capable of sendingRec
- type of Record which is sentL
- type of Listener notifiedpublic class DefaultMessageSender<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
Default MessageSender implementation.
Field Summary | |
---|---|
protected RecordSender<Rec> |
myRecordSender
RecordSender used to send Records. |
Constructor Summary | |
---|---|
DefaultMessageSender()
Creates an empty DefaultMessageSender. |
Method Summary | |
---|---|
void |
addMessageListener(L listener)
Adds a Listener to be notified when a Message has been sent. |
protected void |
fireMessageEvent(Msg message)
Notifies listeners of a Message being sent. |
void |
removeMessageListener(L listener)
Removes a Listener from being notified. |
void |
sendMessage(Msg message)
Sends the given Message. |
void |
setAdapter(org.robokind.api.common.utils.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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected RecordSender<Rec> myRecordSender
Constructor Detail |
---|
public DefaultMessageSender()
Method Detail |
---|
public void setRecordSender(RecordSender<Rec> sender)
MessageSender
setRecordSender
in interface MessageSender<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
sender
- the RecordSender to setpublic void setAdapter(org.robokind.api.common.utils.Adapter<Msg,Rec> adapter)
MessageSender
setAdapter
in interface MessageSender<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
adapter
- the Adapter to setpublic void start() throws Exception
MessageSender
start
in interface MessageSender<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
Exception
- if there is an error startingpublic void stop()
MessageSender
stop
in interface MessageSender<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
public void sendMessage(Msg message)
MessageSender
sendMessage
in interface MessageSender<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
message
- the Message to sendprotected void fireMessageEvent(Msg message)
message
- Message being sentpublic void addMessageListener(L listener)
MessageSender
addMessageListener
in interface MessageSender<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
listener
- the Listener to be notifiedpublic void removeMessageListener(L listener)
MessageSender
removeMessageListener
in interface MessageSender<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
listener
- the Listener to remove
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |