Top Constructors Methods
io.vertx.core.eventbus.impl.codecs

public Class ByteArrayMessageCodec

extends Object
implements MessageCodec<byte[], byte[]>
Class Inheritance
All Implemented Interfaces
io.vertx.core.eventbus.MessageCodec
Imports
io.vertx.core.buffer.Buffer, io.vertx.core.eventbus.MessageCodec
Author
Tim Fox

Constructor Summary

AccessConstructor and Description
public
ByteArrayMessageCodec()

Method Summary

Modifier and TypeMethod and Description
public byte[]
decodeFromWire(int
the position in the buffer where the message should be read from.
pos, Buffer
the buffer to read the message from
buffer)

Implements io.vertx.core.eventbus.MessageCodec.decodeFromWire.

References Deprecated Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

Called by Vert.x when a message is decoded from the wire.

public void
encodeToWire(Buffer
the message should be written into this buffer
buffer, byte[]
the message that is being sent
byteArray)

Implements io.vertx.core.eventbus.MessageCodec.encodeToWire.

References Deprecated Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

Called by Vert.x when marshalling a message to the wire.

public String
name()

Implements io.vertx.core.eventbus.MessageCodec.name.

The codec name.

public byte
systemCodecID()

Implements io.vertx.core.eventbus.MessageCodec.systemCodecID.

Used to identify system codecs.

public byte[]
transform(byte[]
the sent message
bytes)

Implements io.vertx.core.eventbus.MessageCodec.transform.

If a message is sent locally across the event bus, this method is called to transform the message from the sent type S to the received type R

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

ByteArrayMessageCodecback to summary
public ByteArrayMessageCodec()

Method Detail

decodeFromWireback to summary
public byte[] decodeFromWire(int pos, Buffer buffer)

Implements io.vertx.core.eventbus.MessageCodec.decodeFromWire.

Doc from io.vertx.core.eventbus.MessageCodec.decodeFromWire.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Called by Vert.x when a message is decoded from the wire.

Parameters
pos:int

the position in the buffer where the message should be read from.

buffer:Buffer

the buffer to read the message from

Returns:byte[]

the read message

Annotations
@Override
encodeToWireback to summary
public void encodeToWire(Buffer buffer, byte[] byteArray)

Implements io.vertx.core.eventbus.MessageCodec.encodeToWire.

Doc from io.vertx.core.eventbus.MessageCodec.encodeToWire.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Called by Vert.x when marshalling a message to the wire.

Parameters
buffer:Buffer

the message should be written into this buffer

byteArray:byte[]

the message that is being sent

Annotations
@Override
nameback to summary
public String name()

Implements io.vertx.core.eventbus.MessageCodec.name.

Doc from io.vertx.core.eventbus.MessageCodec.name.

The codec name. Each codec must have a unique name. This is used to identify a codec when sending a message and for unregistering codecs.

Returns:String

the name

Annotations
@Override
systemCodecIDback to summary
public byte systemCodecID()

Implements io.vertx.core.eventbus.MessageCodec.systemCodecID.

Doc from io.vertx.core.eventbus.MessageCodec.systemCodecID.

Used to identify system codecs. Should always return -1 for a user codec.

Returns:byte

-1 for a user codec.

Annotations
@Override
transformback to summary
public byte[] transform(byte[] bytes)

Implements io.vertx.core.eventbus.MessageCodec.transform.

Doc from io.vertx.core.eventbus.MessageCodec.transform.

If a message is sent locally across the event bus, this method is called to transform the message from the sent type S to the received type R

Parameters
bytes:byte[]

the sent message

Returns:byte[]

the transformed message

Annotations
@Override