org.robokind.api.messaging
Interface RecordReceiver<T>

Type Parameters:
T - type of Record which can be received

public interface RecordReceiver<T>

Receives records sent from a RecordSender.

Author:
Matthew Stevenson

Nested Class Summary
static interface RecordReceiver.RecordHandler<T>
          A RecordHandler is used by the RecordReceiver to handle the Records it receives.
 
Method Summary
 void pause()
          Pauses the RecordReceiver.
 void resume()
          Resumes a paused RecordReceiver.
 void setRecordHandler(RecordReceiver.RecordHandler<T> handler)
          Sets the RecordHandler used to handle incoming Records.
 void start()
          Starts the PollingService.
 void stop()
          Completely stops a RecordReceiver.
 void unsetRecordHandler()
          Removes the current RecordHandler.
 

Method Detail

setRecordHandler

void setRecordHandler(RecordReceiver.RecordHandler<T> handler)
Sets the RecordHandler used to handle incoming Records.

Parameters:
handler - the RecordHandler to set

unsetRecordHandler

void unsetRecordHandler()
Removes the current RecordHandler. A RecordReceiver with no RecordHandler will ignore and discard received Records.


start

void start()
           throws IllegalStateException
Starts the PollingService. Once called, the service begins fetching Records.

Throws:
IllegalStateException - if no message handler is set

pause

void pause()
Pauses the RecordReceiver. Records may arrive, but they will nor be handled until the Receiver is resumed.


resume

void resume()
Resumes a paused RecordReceiver.


stop

void stop()
Completely stops a RecordReceiver.



Copyright © 2011. All Rights Reserved.