org.eclipse.kapua.gateway.client

Interface BinaryPayloadCodec

All Known Implementing Classes:

KuraBinaryPayloadCodec

public interface BinaryPayloadCodec

A codec for BLOB based payload transports

Method Summary

Modifier and Type	Method and Description
Payload	decode(ByteBuffer buffer) Decode a Payload structure from the provided BLOB
ByteBuffer	encode(Payload payload, ByteBuffer buffer) Encode a Payload structure into a BLOB

Method Detail

encode

ByteBuffer encode(Payload payload,
                  ByteBuffer buffer)
           throws Exception

Encode a Payload structure into a BLOB

The payload information gets encoded into a blob and appended at the end of the provided buffer. If the provided buffer is null a new buffer will be allocated.

Note: The returning buffer may not be the same as the provided buffer. If the provided buffer has less remaining space than required a new buffer is allocated and returned, which will contain both the existing content as well as the newly appended.

Parameters:

payload - The payload to encode, must not be null

buffer - An optional buffer to append the output to, may be null

Returns:

A buffer with the appended payload output, must never be null

Throws:

Exception - if anything goes wrong

decode

Payload decode(ByteBuffer buffer)
        throws Exception

Decode a Payload structure from the provided BLOB

Parameters:

buffer - The buffer to read from, must not be null

Returns:

the decoded payload structure, may be null

Throws:

Exception - if anything goes wrong