|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.robokind.api.messaging.DefaultMessageBlockingReceiver<Msg,Rec>
Msg
- type of message to returnRec
- type of record to receivepublic class DefaultMessageBlockingReceiver<Msg,Rec>
Default implementation of the MessageBlockingReceiver. Blocks until a Record is received. Uses an Adapter to adapt Records to Messages and notifies Listeners.
Field Summary |
---|
Fields inherited from interface org.robokind.api.messaging.MessageBlockingReceiver |
---|
DEFAULT_TIMEOUT_LENGTH |
Constructor Summary | |
---|---|
DefaultMessageBlockingReceiver()
Creates an empty DefaultMessageBlockingReceiver. |
|
DefaultMessageBlockingReceiver(long timeout)
Creates an empty DefaultMessageBlockingReceiver. |
Method Summary | |
---|---|
void |
addMessageListener(org.jflux.api.core.Listener<Msg> listener)
Adds a Listener to be notified when a Message has been received. |
int |
clearMessages()
Removes any pending messages for this receiver. |
protected void |
fireMessageEvent(Msg message)
Notifies listeners of a Message |
long |
getTimeout()
|
Msg |
getValue()
Blocks while waiting for a Message. |
void |
removeMessageListener(org.jflux.api.core.Listener<Msg> listener)
Removes a Listener from being notified. |
void |
setAdapter(org.jflux.api.core.Adapter<Rec,Msg> adapter)
Sets the Adapter used to convert Records to Messages. |
void |
setRecordReceiver(RecordBlockingReceiver<Rec> receiver)
Sets the RecordAsyncReceiver used to receive Records. |
void |
setTimeout(long timeout)
|
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 |
---|
public DefaultMessageBlockingReceiver()
public DefaultMessageBlockingReceiver(long timeout)
timeout
- timeout length for receiving messagesMethod Detail |
---|
public void setRecordReceiver(RecordBlockingReceiver<Rec> receiver)
service
- theRecordReceiver to setpublic void setAdapter(org.jflux.api.core.Adapter<Rec,Msg> adapter)
adapter
- the Adapter to setpublic void setTimeout(long timeout)
setTimeout
in interface MessageBlockingReceiver<Msg>
public long getTimeout()
getTimeout
in interface MessageBlockingReceiver<Msg>
public void start()
MessageBlockingReceiver
start
in interface MessageBlockingReceiver<Msg>
public void stop()
MessageBlockingReceiver
stop
in interface MessageBlockingReceiver<Msg>
public Msg getValue()
MessageBlockingReceiver
getValue
in interface org.jflux.api.core.Source<Msg>
getValue
in interface MessageBlockingReceiver<Msg>
protected void fireMessageEvent(Msg message)
message
- public int clearMessages()
MessageBlockingReceiver
clearMessages
in interface MessageBlockingReceiver<Msg>
public void addMessageListener(org.jflux.api.core.Listener<Msg> listener)
MessageBlockingReceiver
addMessageListener
in interface MessageBlockingReceiver<Msg>
listener
- the Listener to be notifiedpublic void removeMessageListener(org.jflux.api.core.Listener<Msg> listener)
MessageBlockingReceiver
removeMessageListener
in interface MessageBlockingReceiver<Msg>
listener
- the Listener to remove
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |