com.openxc.sinks.VehicleDataSink Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openxc-it Show documentation

Instrumentation test suite for OpenXC library

The newest version!

package com.openxc.sinks;

import com.openxc.remote.RawMeasurement;

/**
 * The interface for all vehicle data destination endpoints.
 *
 * A VehicleDataSink in a {@link com.openxc.DataPipeline} is given new
 * measurements via the receive methods. Data sinks are registered with a
 * {@link com.openxc.remote.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.
 */
public 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.
     *
     * @param measurement The new measurement.
     */
    public boolean receive(RawMeasurement measurement) throws DataSinkException;

    /**
     * Release any acquired resources and either stop sending measurements (if a
     * source) or stop expecting to receive them (if a sink).
     */
    public void stop();
}