com.openxc.sources

Class BytestreamDataSource

java.lang.Object

com.openxc.sources.BaseVehicleDataSource

com.openxc.sources.ContextualVehicleDataSource

com.openxc.sources.BytestreamDataSource

All Implemented Interfaces:

DataPipeline.Operator, VehicleDataSource, java.lang.Runnable

Direct Known Subclasses:

BluetoothVehicleInterface, NetworkVehicleInterface, UsbVehicleInterface

public abstract class BytestreamDataSource
extends ContextualVehicleDataSource
implements java.lang.Runnable

Common functionality for data sources that read a stream of newline-separated messages in a separate thread from the main activity.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.locks.ReadWriteLock	mConnectionLock
protected java.lang.String	mDataFormatValue
protected java.util.concurrent.locks.Condition	mDeviceChanged
protected static int	RECONNECTION_ATTEMPT_WAIT_TIME_S
protected static int	SLOW_RECONNECTION_ATTEMPT_WAIT_TIME_S

Constructor Summary

Constructors

Constructor and Description
BytestreamDataSource(SourceCallback callback, android.content.Context context)

Method Summary

Modifier and Type	Method and Description
protected abstract void	connect() Initiate a connection to the vehicle interface.
protected void	connected() Must have the connection lock before calling this function
protected abstract void	disconnect() Perform any cleanup necessary to disconnect from the interface.
protected void	disconnected() Must have the connection lock before calling this function
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 boolean	isRunning() Returns true if this source should be running, or if it should die.
protected abstract int	read(byte[] bytes) Read data from the source into the given array.
void	receive(VehicleMessage command)
void	run()
protected void	setFastPolling(boolean enabled)
void	start()
void	stop() Clear the callback so no further updates are sent.
protected void	stopConnectionAttempts()
protected void	waitForConnection() If not already connected to the data source, initiate the connection and block until ready to be read.
protected abstract boolean	write(byte[] bytes)

Methods inherited from class com.openxc.sources.ContextualVehicleDataSource

getContext

Methods inherited from class com.openxc.sources.BaseVehicleDataSource

getCallback, getTag, handleMessage, onPipelineActivated, onPipelineDeactivated, setCallback, waitForCallback

Methods inherited from class java.lang.Object

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

Field Detail

RECONNECTION_ATTEMPT_WAIT_TIME_S

protected static final int RECONNECTION_ATTEMPT_WAIT_TIME_S

See Also:

Constant Field Values

SLOW_RECONNECTION_ATTEMPT_WAIT_TIME_S

protected static final int SLOW_RECONNECTION_ATTEMPT_WAIT_TIME_S

See Also:

Constant Field Values

mConnectionLock

protected final java.util.concurrent.locks.ReadWriteLock mConnectionLock

mDeviceChanged

protected final java.util.concurrent.locks.Condition mDeviceChanged

mDataFormatValue

protected java.lang.String mDataFormatValue

Constructor Detail

BytestreamDataSource

public BytestreamDataSource(SourceCallback callback,
                            android.content.Context context)

Method Detail

start

public void start()

stop

public void stop()

Description copied from class: BaseVehicleDataSource

Clear the callback so no further updates are sent. Subclasses should be sure to call super.stop() so they also stop sending updates when killed by a user.

Specified by:

stop in interface VehicleDataSource

Overrides:

stop in class BaseVehicleDataSource

setFastPolling

protected void setFastPolling(boolean enabled)

waitForConnection

protected void waitForConnection()
                          throws java.lang.InterruptedException

If not already connected to the data source, initiate the connection and block until ready to be read. You must have the mConnectionLock locked before calling this function.

Throws:

java.lang.InterruptedException - if the interrupted while blocked -- probably shutting down.

stopConnectionAttempts

protected void stopConnectionAttempts()

run

public void run()

Specified by:

run in interface java.lang.Runnable

receive

public void receive(VehicleMessage command)
             throws DataSinkException

Throws:

DataSinkException

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 VehicleDataSource

Specified by:

isConnected in class BaseVehicleDataSource

disconnected

protected void disconnected()

Must have the connection lock before calling this function

Overrides:

disconnected in class BaseVehicleDataSource

connected

protected void connected()

Must have the connection lock before calling this function

Overrides:

connected in class BaseVehicleDataSource

isRunning

protected boolean isRunning()

Returns true if this source should be running, or if it should die. This is different than isConnected - they just happen to return the same thing in this base data source.

read

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

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.

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.

write

protected abstract boolean write(byte[] bytes)

disconnect

protected abstract void disconnect()

Perform any cleanup necessary to disconnect from the interface.

connect

protected abstract void connect()
                         throws DataSourceException

Initiate a connection to the vehicle interface.

Throws:

DataSourceException