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

public Class ShortMessageCodec

extends Object
implements MessageCodec<Short, Short>
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
ShortMessageCodec()

Method Summary

Modifier and TypeMethod and Description
public Short
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, Short
the message that is being sent
s)

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 Short
transform(Short
the sent message
s)

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

ShortMessageCodecback to summary
public ShortMessageCodec()

Method Detail

decodeFromWireback to summary
public Short 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:Short

the read message

Annotations
@Override
encodeToWireback to summary
public void encodeToWire(Buffer buffer, Short s)

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

s:Short

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 Short transform(Short s)

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
s:Short

the sent message

Returns:Short

the transformed message

Annotations
@Override