Package org.infinispan.protostream

Interface MessageMarshaller<T>

All Superinterfaces:

BaseMarshaller<T>

public interface MessageMarshaller<T>
extends BaseMarshaller<T>

Contract to be implemented by marshallers for Protobuf message (entity) types. The marshaller implementation must be stateless (or behave as if stateless) and must be thread-safe.

Since:

1.0

Author:

[email protected]

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MessageMarshaller.ProtoStreamReader	An high-level interface for the wire encoding of a Protobuf stream that allows reading named (and typed) message fields.
static interface	MessageMarshaller.ProtoStreamWriter	An high-level interface for the wire encoding of a Protobuf stream that allows writing named (and typed) message fields.

Method Summary

Modifier and Type	Method	Description
T	readFrom(MessageMarshaller.ProtoStreamReader reader)	Read the fields written by writeTo(ProtoStreamWriter, Object).
void	writeTo(MessageMarshaller.ProtoStreamWriter writer, T t)	Write the fields defined in the schema.

Methods inherited from interface org.infinispan.protostream.BaseMarshaller

getJavaClass, getTypeName

Method Detail

readFrom

T readFrom(MessageMarshaller.ProtoStreamReader reader)
    throws IOException

Read the fields written by writeTo(ProtoStreamWriter, Object). Should read them in the exact same order as were written to ensure maximum performance. Not obeying the order will lead to poor performance and will cause warnings to be logged but will still work.

Throws:

IOException

writeTo

void writeTo(MessageMarshaller.ProtoStreamWriter writer,
             T t)
      throws IOException

Write the fields defined in the schema. Please establish a consistent order and always write them in the same order. Two common choices for ordering field writes are schema definition order and field number order.

Throws:

IOException