com.openxc.interfaces.network

Class NetworkVehicleInterface

java.lang.Object

com.openxc.sources.BaseVehicleDataSource

com.openxc.sources.ContextualVehicleDataSource

com.openxc.sources.BytestreamDataSource

com.openxc.interfaces.network.NetworkVehicleInterface

All Implemented Interfaces:

DataPipeline.Operator, VehicleInterface, VehicleDataSink, VehicleDataSource, java.lang.Runnable

public class NetworkVehicleInterface
extends BytestreamDataSource
implements VehicleInterface

A vehicle data source reading measurements from an OpenXC network device. This class looks for a network device and expects to read OpenXC-compatible, newline separated JSON messages.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BROADCAST_NETWORK_DISCONNECTED

Fields inherited from class com.openxc.sources.BytestreamDataSource

mConnectionLock, mDataFormatValue, mDeviceChanged, RECONNECTION_ATTEMPT_WAIT_TIME_S, SLOW_RECONNECTION_ATTEMPT_WAIT_TIME_S

Constructor Summary

Constructors

Constructor and Description
NetworkVehicleInterface(android.content.Context context, java.lang.String uriString)
NetworkVehicleInterface(android.content.Context context, java.net.URI uri)
NetworkVehicleInterface(SourceCallback callback, android.content.Context context, java.net.URI uri) Construct an instance of NetworkVehicleInterface with a receiver callback and custom device URI.

Method Summary

Modifier and Type	Method and Description
protected void	connect() Initiate a connection to the vehicle interface.
protected void	disconnect() Perform any cleanup necessary to disconnect from the interface.
protected java.lang.String	getTag() Return a string suitable as a tag for logging.
boolean	isConnected() Return true if the data source is actively connected to its target, be it a USB endpoint, a Bluetooth channel, a trace file, etc.
protected int	read(byte[] bytes) Read data from the source into the given array.
protected void	sendNetworkDisconnectBroadcast()
boolean	setResource(java.lang.String otherResource) Change the resource used by the instance to connect to the interface, restarting any necessary services.
java.lang.String	toString()
static boolean	validateResource(java.lang.String uriString) Return true if the address and port are valid.
protected boolean	write(byte[] bytes) Writes given data to the socket.

Methods inherited from class com.openxc.sources.BytestreamDataSource

connected, disconnected, isRunning, receive, run, setFastPolling, start, stop, stopConnectionAttempts, waitForConnection

Methods inherited from class com.openxc.sources.ContextualVehicleDataSource

getContext

Methods inherited from class com.openxc.sources.BaseVehicleDataSource

getCallback, handleMessage, onPipelineActivated, onPipelineDeactivated, setCallback, waitForCallback

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.openxc.sources.VehicleDataSource

setCallback, stop

Methods inherited from interface com.openxc.DataPipeline.Operator

onPipelineActivated, onPipelineDeactivated

Methods inherited from interface com.openxc.sinks.VehicleDataSink

receive, stop

Field Detail

BROADCAST_NETWORK_DISCONNECTED

public static final java.lang.String BROADCAST_NETWORK_DISCONNECTED

See Also:

Constant Field Values

Constructor Detail

NetworkVehicleInterface

public NetworkVehicleInterface(SourceCallback callback,
                               android.content.Context context,
                               java.net.URI uri)
                        throws DataSourceException

Construct an instance of NetworkVehicleInterface with a receiver callback and custom device URI. If the device cannot be found at initialization, the object will block waiting for a signal to check again.

Parameters:

context - The Activity or Service context, used to get access to the Android NetworkManager.

callback - An object implementing the SourceCallback that should receive data as it is received and parsed.

uri - The network host's address.

Throws:

DataSourceException - If no connection could be established

NetworkVehicleInterface

public NetworkVehicleInterface(android.content.Context context,
                               java.net.URI uri)
                        throws DataSourceException

Throws:

DataSourceException

NetworkVehicleInterface

public NetworkVehicleInterface(android.content.Context context,
                               java.lang.String uriString)
                        throws DataSourceException

Throws:

DataSourceException

Method Detail

setResource

public boolean setResource(java.lang.String otherResource)
                    throws DataSourceException

Description copied from interface: VehicleInterface

Change the resource used by the instance to connect to the interface, restarting any necessary services.

Specified by:

setResource in interface VehicleInterface

Parameters:

otherResource - The new resource to use for the interface.

Returns:

true if the resource was different and the interface was restarted.

Throws:

DataSourceException

validateResource

public static boolean validateResource(java.lang.String uriString)

Return true if the address and port are valid.

Returns:

true if the address and port are valid.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isConnected

public boolean isConnected()

Description copied from interface: VehicleDataSource

Return true if the data source is actively connected to its target, be it a USB endpoint, a Bluetooth channel, a trace file, etc. The source is capable of providing new vehicle data. Returns true if connected, false otherwise.

Specified by:

isConnected in interface VehicleInterface

Specified by:

isConnected in interface VehicleDataSource

Overrides:

isConnected in class BytestreamDataSource

read

protected int read(byte[] bytes)
            throws java.io.IOException

Description copied from class: BytestreamDataSource

Read data from the source into the given array. No more than bytes.length bytes will be read, and there is no guarantee that any bytes will be read at all.

Specified by:

read in class BytestreamDataSource

Parameters:

bytes - the destination array for bytes from the data source.

Returns:

the number of bytes that were actually copied into bytes.

Throws:

java.io.IOException - if the source is unexpectedly closed or returns an error.

connect

protected void connect()
                throws NetworkSourceException

Description copied from class: BytestreamDataSource

Initiate a connection to the vehicle interface.

Specified by:

connect in class BytestreamDataSource

Throws:

NetworkSourceException

disconnect

protected void disconnect()

Description copied from class: BytestreamDataSource

Perform any cleanup necessary to disconnect from the interface.

Specified by:

disconnect in class BytestreamDataSource

write

protected boolean write(byte[] bytes)

Writes given data to the socket.

Specified by:

write in class BytestreamDataSource

Parameters:

bytes - data to write to the socket.

Returns:

true if the data was written successfully.

getTag

protected java.lang.String getTag()

Description copied from class: BaseVehicleDataSource

Return a string suitable as a tag for logging.

Overrides:

getTag in class BaseVehicleDataSource

sendNetworkDisconnectBroadcast

protected void sendNetworkDisconnectBroadcast()