com.google.code.proto.streamio

Class PBStreamWriter

java.lang.Object

com.google.code.proto.streamio.PBStreamWriter

public class PBStreamWriter
extends Object

A writer for an output stream of Google protocol buffer generated messages.

Usage:
List<YourProtocolBufferMessage> messages = getGPBMessages...
PBStreamWriter.writeToStream(out, messages);

Author:

nichole

Constructor Summary

Constructors

Constructor and Description
PBStreamWriter()

Method Summary

Modifier and Type	Method and Description
static void	writeToStream(OutputStream out, List<? extends com.google.protobuf.GeneratedMessage> messages) Write GeneratedMessages to the given output stream.
static void	writeToStream(OutputStream out, List<? extends com.google.protobuf.GeneratedMessage> messages, ByteOption byteOption) Write GeneratedMessages to the given output stream, and use the a specialized PBWireByteMarkerHelper to write the delimiters.

Methods inherited from class java.lang.Object

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

Constructor Detail

PBStreamWriter

public PBStreamWriter()

Method Detail

writeToStream

public static void writeToStream(OutputStream out,
                                 List<? extends com.google.protobuf.GeneratedMessage> messages)
                          throws IOException

Write GeneratedMessages to the given output stream. It uses a byte marker and array for delimiting messages. Note the default here is to use the bytemarker for unsigned bytes (only uses range 0-127).

Parameters:

out - output stream being written to

messages - messages generated by Google's protocol buffer

Throws:

IOException

writeToStream

public static void writeToStream(OutputStream out,
                                 List<? extends com.google.protobuf.GeneratedMessage> messages,
                                 ByteOption byteOption)
                          throws IOException

Write GeneratedMessages to the given output stream, and use the a specialized PBWireByteMarkerHelper to write the delimiters. This is where the bytemarked for unsigned bytes can be used (this is prefered for socket to socket message passing, but if your client is javascript, you will need to write and read using the default

Parameters:

out - output stream being written to

messages - messages generated by Google's protocol buffer

byteOption - option to choose signed bytes or unsigned bytes when writing to stream. null results in a default UNSIGNED.

Throws:

IOException