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

Type Parameters:

T - type of Record which can be received

public interface RecordAsyncReceiver<T>

Asynchronously receives records sent from a RecordSender.

Author:

Matthew Stevenson

Nested Class Summary

static interface

RecordAsyncReceiver.RecordHandler<T> A RecordHandler is used by the RecordAsyncReceiver to handle the Records it receives.

Method Summary

void	pause() Pauses the RecordAsyncReceiver.
void	resume() Resumes a paused RecordAsyncReceiver.
void	setRecordHandler(RecordAsyncReceiver.RecordHandler<T> handler) Sets the RecordHandler used to handle incoming Records.
void	start() Starts the PollingService.
void	stop() Completely stops a RecordAsyncReceiver.
void	unsetRecordHandler() Removes the current RecordHandler.

Method Detail

setRecordHandler

void setRecordHandler(RecordAsyncReceiver.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 RecordAsyncReceiver 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 RecordAsyncReceiver. Records may arrive, but they will nor be handled until the Receiver is resumed.

resume

void resume()

Resumes a paused RecordAsyncReceiver.

stop

void stop()

Completely stops a RecordAsyncReceiver.