com.openxc.sinks

Class UploaderSink

java.lang.Object

com.openxc.sinks.ContextualVehicleDataSink

com.openxc.sinks.UploaderSink

All Implemented Interfaces:

VehicleDataSink

public class UploaderSink
extends ContextualVehicleDataSink

Upload a stream of all incoming vehicle data to a remote HTTP server. The remote HTTP server specified should be expecting POST requests with the data being a JSON array of OpenXC JSON message objects, e.g.: [{"name": "steering_wheel_angle", "value": 42}, {"name": "parking_brake_status", "value": false}] The UploaderSink has a small buffer to preserve records across short network outages, but do not expect it to be especially reliable. No guarantee is provided about the preservation of records - to do that, a subclass would need to write the data to a file when no network connection is available.

Constructor Summary

Constructors

Constructor and Description
UploaderSink(android.content.Context context, java.lang.String path)
UploaderSink(android.content.Context context, java.net.URI uri) Initialize and start a new UploaderSink immediately.

Method Summary

Modifier and Type	Method and Description
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).
java.lang.String	toString()
static boolean	validatePath(java.lang.String path) Returns true if the path is not null and if it is a valid URI.

Methods inherited from class com.openxc.sinks.ContextualVehicleDataSink

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

UploaderSink

public UploaderSink(android.content.Context context,
                    java.net.URI uri)

Initialize and start a new UploaderSink immediately.

Parameters:

uri - the URI to send HTTP POST requests to with the JSON data.

UploaderSink

public UploaderSink(android.content.Context context,
                    java.lang.String path)
             throws DataSinkException

Throws:

DataSinkException

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

Specified by:

stop in class ContextualVehicleDataSink

receive

public void receive(VehicleMessage message)

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

Specified by:

receive in class ContextualVehicleDataSink

Parameters:

message - The new measurement.

validatePath

public static boolean validatePath(java.lang.String path)

Returns true if the path is not null and if it is a valid URI.

Parameters:

path - a URI to validate

Returns:

true if path is a valid URI.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object