|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.robokind.api.messaging.DefaultMessageReceiver<Msg,Rec,L>
Msg
- type of Message receivedRec
- type of underlying Record receivedL
- type of Listener to notifypublic class DefaultMessageReceiver<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
Default MessageReceiver implementation. Uses a RecordAdapterHandler as a RecordHandler to passes Records to an Adapter for deserialization.
Constructor Summary | |
---|---|
DefaultMessageReceiver()
Creates an empty DefaultMessageReceiver. |
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 MessageReceiver. |
void |
removeMessageListener(L listener)
Removes a Listener from being notified. |
void |
resume()
Resumes a paused MessageReceiver. |
void |
setAdapter(org.robokind.api.common.utils.Adapter<Rec,Msg> adapter)
Sets the Adapter used to convert Records to Messages. |
void |
setRecordReceiver(RecordReceiver<Rec> service)
Sets the RecordReceiver used to receive Records. |
void |
start()
Initializes and connects the MessageReceiver, and begins receiving Messages. |
void |
stop()
Stops the MessageReceiver, 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 |
---|
public DefaultMessageReceiver()
Method Detail |
---|
public void setRecordReceiver(RecordReceiver<Rec> service)
MessageReceiver
setRecordReceiver
in interface MessageReceiver<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
service
- theRecordReceiver to setpublic void setAdapter(org.robokind.api.common.utils.Adapter<Rec,Msg> adapter)
MessageReceiver
setAdapter
in interface MessageReceiver<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
adapter
- the Adapter to setpublic void start() throws Exception
MessageReceiver
start
in interface MessageReceiver<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
Exception
- if there is an error startingpublic void pause()
MessageReceiver
pause
in interface MessageReceiver<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
public void resume()
MessageReceiver
resume
in interface MessageReceiver<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
public void stop()
MessageReceiver
stop
in interface MessageReceiver<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
protected void fireMessageEvent(Msg message)
message
- public void addMessageListener(L listener)
MessageReceiver
addMessageListener
in interface MessageReceiver<Msg,Rec,L extends org.robokind.api.common.utils.Listener<Msg>>
listener
- the Listener to be notifiedpublic void removeMessageListener(L listener)
MessageReceiver
removeMessageListener
in interface MessageReceiver<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 |