org.freehep.record.source

Interface AsynchronousRecordSource

All Superinterfaces:

RecordSource

public interface AsynchronousRecordSource
extends RecordSource

Record source with non-blocking positioning methods. Typical uses would be for live sources (e.g. sampling data from a running experiment) or reading data over a slow connection.

Version:

$Id: AsynchronousRecordSource.java 13906 2011-10-19 22:01:30Z onoprien $

Method Summary

Methods

Modifier and Type	Method and Description
void	addRecordListener(RecordReadyListener l) Add a record listener that will be notified when the record is ready
boolean	isNonBlocking() Test if non-blocking mode is enabled.
boolean	isRecordReady() Returns true is the requested record is available.
void	removeRecordListener(RecordReadyListener l) Remove a record listener
void	setNonBlocking(boolean value) Sets non-blocking mode.
void	waitForRecordReady() This method will block until the requested record is ready

Methods inherited from interface org.freehep.record.source.RecordSource

close, current, getCurrentIndex, getCurrentRecord, getCurrentTag, getEstimatedSize, getName, getRecordClass, getTags, hasCurrent, hasIndex, hasNext, hasPrevious, hasRewind, hasShift, hasTag, jump, jump, next, parseTag, previous, releaseRecord, rewind, shift, size, supportsCurrent, supportsIndex, supportsNext, supportsPrevious, supportsRewind, supportsShift, supportsTag

Method Detail

setNonBlocking

void setNonBlocking(boolean value)

Sets non-blocking mode. When non blocking is set, all methods that would normally block waiting for the source positioning operation to complete, such as next() previous(), current(), jump(...), shift(...), will instead return immediately. The caller is then responsible to use this interface to check when the requested record is ready before calling getCurrentObject() etc. If non-blocking is not enabled, AsynchronousRecordSource behaves like a regular source.

isNonBlocking

boolean isNonBlocking()

Test if non-blocking mode is enabled.

Returns:

true if non-blocking mode is enabled.

isRecordReady

boolean isRecordReady()

Returns true is the requested record is available.

waitForRecordReady

void waitForRecordReady()
                        throws InterruptedException

This method will block until the requested record is ready

Throws:

InterruptedException

addRecordListener

void addRecordListener(RecordReadyListener l)

Add a record listener that will be notified when the record is ready

removeRecordListener

void removeRecordListener(RecordReadyListener l)

Remove a record listener