net.openhft.chronicle.bytes

Interface MethodEncoder

public interface MethodEncoder

Interface defining the required operations for a method encoder.

A method encoder is responsible for encoding a method call into a BytesOut object and decoding the method call from a BytesIn object. This encoding/decoding is often necessary for serializing method calls or for sending method calls over a network for remote procedure calls (RPC).

Implementations of this interface should ensure that the encode and decode methods are properly synchronized if they're intended to be used in a multi-threaded context.

Method Summary

Modifier and Type	Method and Description
Object[]	decode(Object[] lastObjects, BytesIn<?> in) Decodes a method call from a BytesIn object into an array of objects.
void	encode(Object[] objects, BytesOut<?> out) Encodes a method call, represented by an array of objects, into a BytesOut object.
long	messageId() Returns a unique identifier for the method being encoded.

Method Detail

messageId

long messageId()

Returns a unique identifier for the method being encoded.

Returns:

the unique identifier of the method

encode

void encode(Object[] objects,
            BytesOut<?> out)
     throws IllegalArgumentException,
            BufferUnderflowException,
            IllegalStateException,
            BufferOverflowException,
            ArithmeticException,
            net.openhft.chronicle.core.io.InvalidMarshallableException

Encodes a method call, represented by an array of objects, into a BytesOut object.

Parameters:

objects - the objects representing a method call

out - the BytesOut object to write the method call to

Throws:

IllegalArgumentException - if an argument is not valid

BufferUnderflowException - if there is not enough data available in the buffer

IllegalStateException - if a state-dependent method has been invoked at an inappropriate time

BufferOverflowException - if there is not enough space in the buffer

ArithmeticException - if numeric overflow occurs

net.openhft.chronicle.core.io.InvalidMarshallableException - if an object is not correctly marshallable

decode

Object[] decode(Object[] lastObjects,
                BytesIn<?> in)
         throws BufferUnderflowException,
                IllegalStateException,
                net.openhft.chronicle.core.io.InvalidMarshallableException

Decodes a method call from a BytesIn object into an array of objects.

Parameters:

lastObjects - the previous objects used for the method call, can be used for delta encoding

in - the BytesIn object to read the method call from

Returns:

the objects representing a method call

Throws:

BufferUnderflowException - if there is not enough data available in the buffer

IllegalStateException - if a state-dependent method has been invoked at an inappropriate time

net.openhft.chronicle.core.io.InvalidMarshallableException - if an object is not correctly marshallable