Usually the event bus only allows a certain set of message types to be sent across the event bus, including primitive types,
boxed primitive types, byte[], io., io.,
io..
By specifying a message codec you can pass any other type across the event bus, e.g. POJOs.
With a message codec the type sent does not have to be the same as the type received, e.g. you could send
a Buffer and have it be received as a JsonObject.
Instances of this class must be thread-safe as they may be used concurrently by different threads.
| Modifier and Type | Method and Description |
|---|---|
| public R | Returns: the read messagethe position in the buffer where the message should be read from. pos, Buffer the buffer to read the message from buffer)
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, S the message that is being sent s)
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 | |
| public byte | |
| public R | Returns: the transformed messagethe sent message s)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 |
| decodeFromWire | back to summary |
|---|---|
| public R decodeFromWire(int pos, Buffer buffer)
References Deprecated
See corresponding docs for further information. Called by Vert.x when a message is decoded from the wire.
| |
| encodeToWire | back to summary |
|---|---|
| public void encodeToWire(Buffer buffer, S s)
References Deprecated
See corresponding docs for further information. Called by Vert.x when marshalling a message to the wire.
| |
| name | back to summary |
|---|---|
| public String 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.
| |
| systemCodecID | back to summary |
|---|---|
| public byte systemCodecID() Used to identify system codecs. Should always return -1 for a user codec.
| |
| transform | back to summary |
|---|---|
| public R transform(S s) 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
| |