Vert.x 4.5.13 · io.vertx.core.eventbus.impl.codecs.JsonObjectMessageCodec

Access	Constructor and Description
public	JsonObjectMessageCodec()

Method Summary

Modifier and Type	Method and Description
public JsonObject	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` and `JsonObject` are deprecated or reference (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, JsonObject the message that is being sent jsonObject) Implements io.vertx.core.eventbus.MessageCodec.encodeToWire. References Deprecated `Buffer` and `JsonObject` are deprecated or reference (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 JsonObject	transform(JsonObject the sent message jsonObject) Implements io.vertx.core.eventbus.MessageCodec.transform. References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. 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:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

JsonObjectMessageCodec	back to summary
public JsonObjectMessageCodec()

Method Detail

decodeFromWire back to summary

decodeFromWire	back to summary
public JsonObject decodeFromWire(int pos, Buffer buffer) Implements io.vertx.core.eventbus.MessageCodec.decodeFromWire. Doc from io.vertx.core.eventbus.MessageCodec.decodeFromWire. References Deprecated `Buffer` and `JsonObject` are deprecated or reference (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:JsonObject the read message Annotations @Override

public JsonObject decodeFromWire(int pos, Buffer buffer)

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

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

References Deprecated

Buffer and JsonObject are deprecated or reference (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:JsonObject

the read message

Annotations

@Override

encodeToWire back to summary

encodeToWire	back to summary
public void encodeToWire(Buffer buffer, JsonObject jsonObject) Implements io.vertx.core.eventbus.MessageCodec.encodeToWire. Doc from io.vertx.core.eventbus.MessageCodec.encodeToWire. References Deprecated `Buffer` and `JsonObject` are deprecated or reference (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 jsonObject:JsonObject the message that is being sent Annotations @Override

public void encodeToWire(Buffer buffer, JsonObject jsonObject)

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

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

References Deprecated

Buffer and JsonObject are deprecated or reference (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
jsonObject:JsonObject: the message that is being sent

Annotations

@Override

name	back 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

name

back 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

systemCodecID	back 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

systemCodecID

back 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

transform back to summary

transform	back to summary
public JsonObject transform(JsonObject jsonObject) Implements io.vertx.core.eventbus.MessageCodec.transform. Doc from io.vertx.core.eventbus.MessageCodec.transform. References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. 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 jsonObject:JsonObject the sent message Returns:JsonObject the transformed message Annotations @Override

public JsonObject transform(JsonObject jsonObject)

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

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

References Deprecated

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

See corresponding docs for further information.

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

jsonObject:JsonObject: the sent message

Returns:JsonObject

the transformed message

Annotations

@Override

public Class JsonObjectMessageCodec

Constructor Summary

Method Summary

Constructor Detail

Method Detail