com.openxc.messages.streamers

Class BinaryStreamer

java.lang.Object

com.openxc.messages.streamers.VehicleMessageStreamer

com.openxc.messages.streamers.BinaryStreamer

public class BinaryStreamer
extends VehicleMessageStreamer

A class to deserialize and serialize binary-formatted vehicle messages from byte streams. The BinaryStreamer wraps the BinaryFormatter and handles messages delimiting. It uses standard message length delimiters as recommended by the protobuf docs and specific in the OpenXC message format. Unlike the BinaryFormatter, the BinaryStreamer is not stateless. It maintains an internal buffer of bytes so that if partial messages is received it can eventually receive an parse the entire thing.

Constructor Summary

Constructors

Constructor and Description
BinaryStreamer()

Method Summary

Modifier and Type	Method and Description
static void	dumpToLog(byte[] bytes, int length)
java.lang.String	getRawMessage()
VehicleMessage	parseMessage(java.lang.String line)
VehicleMessage	parseNextMessage() Deserialize and return the next messages from the internally buffered stream.
void	receive(byte[] bytes, int length) Add additional bytes to the buffer from the data source.
byte[]	serializeForStream(VehicleMessage message) Serialize the message and insert any required delimiters for insertion into a message stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryStreamer

public BinaryStreamer()

Method Detail

parseNextMessage

public VehicleMessage parseNextMessage()

Description copied from class: VehicleMessageStreamer

Deserialize and return the next messages from the internally buffered stream.

Specified by:

parseNextMessage in class VehicleMessageStreamer

Returns:

the next deserialized VehicleMessage.

parseMessage

public VehicleMessage parseMessage(java.lang.String line)

Specified by:

parseMessage in class VehicleMessageStreamer

getRawMessage

public java.lang.String getRawMessage()

Specified by:

getRawMessage in class VehicleMessageStreamer

serializeForStream

public byte[] serializeForStream(VehicleMessage message)
                          throws SerializationException

Description copied from class: VehicleMessageStreamer

Serialize the message and insert any required delimiters for insertion into a message stream.

Specified by:

serializeForStream in class VehicleMessageStreamer

Parameters:

message - the message to serialize.

Throws:

SerializationException - if the message cannot be serialized.

dumpToLog

public static void dumpToLog(byte[] bytes,
                             int length)

receive

public void receive(byte[] bytes,
                    int length)

Description copied from class: VehicleMessageStreamer

Add additional bytes to the buffer from the data source.

Overrides:

receive in class VehicleMessageStreamer

Parameters:

bytes - an array of bytes received from the interface.

length - number of bytes received, and thus the amount that should be read from the array.