com.openxc.sinks

Class AbstractQueuedCallbackSink

java.lang.Object

com.openxc.sinks.AbstractQueuedCallbackSink

All Implemented Interfaces:

VehicleDataSink

Direct Known Subclasses:

MessageListenerSink, RemoteCallbackSink

public abstract class AbstractQueuedCallbackSink
extends java.lang.Object
implements VehicleDataSink

Functionality to notify multiple clients asynchronously of new measurements. This class encapsulates the functionality to keep a thread-safe list of listeners that want to be notified of updates asynchronously. Subclasses need only to implement the propagateMessage(VehicleMessage) to add the actual logic for looping over the list of receivers and send them new values. New measurements are queued up and propagated to receivers in a separate thread, to avoid blocking the original sender of the data.

Constructor Summary

Constructors

Constructor and Description
AbstractQueuedCallbackSink()

Method Summary

Modifier and Type	Method and Description
void	clearQueue()
protected abstract void	propagateMessage(VehicleMessage message)
void	receive(VehicleMessage message) Receive a data point with a name, a value and a event value.
void	stop() Release any acquired resources and either stop sending measurements (if a source) or stop expecting to receive them (if a sink).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractQueuedCallbackSink

public AbstractQueuedCallbackSink()

Method Detail

stop

public void stop()

Description copied from interface: VehicleDataSink

Release any acquired resources and either stop sending measurements (if a source) or stop expecting to receive them (if a sink).

Specified by:

stop in interface VehicleDataSink

receive

public void receive(VehicleMessage message)
             throws DataSinkException

Description copied from interface: VehicleDataSink

Receive a data point with a name, a value and a event value. The implementation of this method should not block, lest the vehicle data source get behind in processing data from a source potentially external to the system.

Specified by:

receive in interface VehicleDataSink

Parameters:

message - The new measurement.

Throws:

DataSinkException

clearQueue

public void clearQueue()

propagateMessage

protected abstract void propagateMessage(VehicleMessage message)