com.openxc.sinks

Interface VehicleDataSink

All Known Subinterfaces:

VehicleInterface

All Known Implementing Classes:

AbstractQueuedCallbackSink, BluetoothVehicleInterface, ContextualVehicleDataSink, DweetSink, FileRecorderSink, MessageListenerSink, NetworkVehicleInterface, RemoteCallbackSink, TestSink, TestVehicleInterface, UploaderSink, UsbVehicleInterface, UserSink

public interface VehicleDataSink

The interface for all vehicle data destination endpoints. A VehicleDataSink in a DataPipeline is given new measurements via the receive methods. Data sinks are registered with a VehicleService receive all raw messages from the vehicle data sources as they arrive without having to explicitly register for asynchronous updates on specific measurements. Common applications of this class are trace file recording, web streaming or custom CAN message handling.

Method Summary

Modifier and Type	Method and Description
void	receive(VehicleMessage measurement) 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).

Method Detail

receive

void receive(VehicleMessage measurement)
      throws DataSinkException

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.

Parameters:

measurement - The new measurement.

Throws:

DataSinkException

stop

void stop()

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