Package org.capnproto

Class Serialize

java.lang.Object

org.capnproto.Serialize

public final class Serialize
extends Object

Serialization using the standard (unpacked) stream encoding: https://capnproto.org/encoding.html#serialization-over-a-stream

Constructor Summary

Constructors

Constructor	Description
Serialize()

Method Summary

Modifier and Type	Method	Description
static long	computeSerializedSizeInWords(MessageBuilder message)
static void	fillBuffer(ByteBuffer buffer, ReadableByteChannel bc)
static MessageReader	read(ByteBuffer bb)
static MessageReader	read(ByteBuffer bb, ReaderOptions options)	Upon return, `bb.position()` will be at the end of the message.
static MessageReader	read(ReadableByteChannel bc)
static MessageReader	read(ReadableByteChannel bc, ReaderOptions options)
static Optional<MessageReader>	tryRead(ReadableByteChannel bc)	Attempts to read a message from the provided BufferedInputStream with default options.
static Optional<MessageReader>	tryRead(ReadableByteChannel bc, ReaderOptions options)	Attempts to read a message from the provided BufferedInputStream with the provided options.
static void	write(WritableByteChannel outputChannel, MessageBuilder message)	Serializes a MessageBuilder to a WritableByteChannel.
static void	write(WritableByteChannel outputChannel, MessageReader message)	Serializes a MessageReader to a WritableByteChannel.

Methods inherited from class java.lang.Object

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

Constructor Detail

Serialize

public Serialize()

Method Detail

fillBuffer

public static void fillBuffer(ByteBuffer buffer,
                              ReadableByteChannel bc)
                       throws IOException

Throws:

IOException

tryRead

public static Optional<MessageReader> tryRead(ReadableByteChannel bc)
                                       throws IOException

Attempts to read a message from the provided BufferedInputStream with default options. Returns null if the input stream reached end-of-stream on first read.

Throws:

IOException

tryRead

public static Optional<MessageReader> tryRead(ReadableByteChannel bc,
                                              ReaderOptions options)
                                       throws IOException

Attempts to read a message from the provided BufferedInputStream with the provided options. Returns null if the input stream reached end-of-stream on first read.

Throws:

IOException

read

public static MessageReader read(ReadableByteChannel bc)
                          throws IOException

Throws:

IOException

read

public static MessageReader read(ReadableByteChannel bc,
                                 ReaderOptions options)
                          throws IOException

Throws:

IOException

read

public static MessageReader read(ByteBuffer bb)
                          throws IOException

Throws:

IOException

read

public static MessageReader read(ByteBuffer bb,
                                 ReaderOptions options)
                          throws IOException

Upon return, `bb.position()` will be at the end of the message.

Throws:

IOException

computeSerializedSizeInWords

public static long computeSerializedSizeInWords(MessageBuilder message)

write

public static void write(WritableByteChannel outputChannel,
                         MessageBuilder message)
                  throws IOException

Serializes a MessageBuilder to a WritableByteChannel.

Throws:

IOException

write

public static void write(WritableByteChannel outputChannel,
                         MessageReader message)
                  throws IOException

Serializes a MessageReader to a WritableByteChannel.

Throws:

IOException