com.google.code.proto.streamio

Interface IPBWireByteMarkerHelper

All Known Implementing Classes:

AbstractPBWireByteMarkerHelper, PBWireSignedByteMarkerHelper, PBWireUnsignedByteMarkerHelper

public interface IPBWireByteMarkerHelper

Interface for class to help write delimiting byte markers for Google protocol buffer generated messages used with PBStreamReader. The delimeter is a byte array holding the size of the generated message that will follow.

Author:

nichole

Method Summary

Modifier and Type	Method and Description
int	bytesToInteger(byte[] marker) Convert the marker byte array to an integer where each item is part of byte shifted integer
byte[]	createMessageDelimiter(com.google.protobuf.GeneratedMessage message) Create a delimiter for the given GeneratedMessage.
int	estimateTotalContentLength(List<? extends com.google.protobuf.GeneratedMessage> messages) Estimate the total number of bytes that will be used in a stream for a list of messages - this includes delimeters.
int	getByteMarkerSize() Get the number of bytes holding a message size, where these bytes are within the delimiter byte array and follow the byte marker.
int	getDelimiterSize() Get the total number of bytes of a delimeter for a generated message.
byte	getMarkerForStart() Get the byte marker used to identify the start of the delimiter.
byte[]	integerToBytesBigEndian(int value) Convert the integer into a byte array composed of byte shifted parts of the integer.

Method Detail

bytesToInteger

int bytesToInteger(byte[] marker)

Convert the marker byte array to an integer where each item is part of byte shifted integer

Parameters:

marker - big endian byte marker

Returns:

value held in marker

createMessageDelimiter

byte[] createMessageDelimiter(com.google.protobuf.GeneratedMessage message)

Create a delimiter for the given GeneratedMessage.

Parameters:

message - instance of GeneratedMessage

Returns:

byte array of size delimiterSize, to be used preceding serialized GeneratedMessages in a stream. The delimiter to separate serialized objects is a start byte of followed by a byteMarkerSize big-endian bytes holding the length

estimateTotalContentLength

int estimateTotalContentLength(List<? extends com.google.protobuf.GeneratedMessage> messages)

Estimate the total number of bytes that will be used in a stream for a list of messages - this includes delimeters. This is useful to set the content-length in an HTTP response.

Parameters:

messages - instances of GeneratedMessage

Returns:

total number of bytes needed for a list of generated messages. The total includes the delimiters too.

getByteMarkerSize

int getByteMarkerSize()

Get the number of bytes holding a message size, where these bytes are within the delimiter byte array and follow the byte marker.

Returns:

number of bytes holding a message size.

getDelimiterSize

int getDelimiterSize()

Get the total number of bytes of a delimeter for a generated message.

Returns:

the number of bytes in a delimiter

getMarkerForStart

byte getMarkerForStart()

Get the byte marker used to identify the start of the delimiter.

Returns:

byte marker used to identify the start of the delimiter

integerToBytesBigEndian

byte[] integerToBytesBigEndian(int value)

Convert the integer into a byte array composed of byte shifted parts of the integer.

Parameters:

value - the integer to be represented by the returned byte array

Returns:

big endian byte array holding value