io.scalecube.services.transport.api

类 ServiceMessageCodec

java.lang.Object

io.scalecube.services.transport.api.ServiceMessageCodec

public final class ServiceMessageCodec
extends Object

构造器概要

构造器

构造器和说明
ServiceMessageCodec() Message codec with default Headers/Data Codecs.
ServiceMessageCodec(io.scalecube.services.transport.api.HeadersCodec headersCodec, Collection<io.scalecube.services.transport.api.DataCodec> dataCodecs) Constructor.

方法概要

限定符和类型	方法和说明
io.scalecube.services.api.ServiceMessage	decode(io.netty.buffer.ByteBuf dataBuffer, io.netty.buffer.ByteBuf headersBuffer) Decode buffers.
static io.scalecube.services.api.ServiceMessage	decodeData(io.scalecube.services.api.ServiceMessage message, Type dataType) Decode message.
<T> T	encodeAndTransform(io.scalecube.services.api.ServiceMessage message, java.util.function.BiFunction<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf,T> transformer) Encode a message, transform it to T.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ServiceMessageCodec

public ServiceMessageCodec()

Message codec with default Headers/Data Codecs.

另请参阅:

HeadersCodec.DEFAULT_INSTANCE, DataCodec.getAllInstances()

ServiceMessageCodec

public ServiceMessageCodec(io.scalecube.services.transport.api.HeadersCodec headersCodec,
                           Collection<io.scalecube.services.transport.api.DataCodec> dataCodecs)

Constructor. Creates instance out of HeadersCodec instance and DataCodec collection.

NOTE: If client set several data codecs for one content type (see what's content type here: DataCodec.contentType()), then the last one specified will be used. Client's collection of data codes override data codecs from SPI.

参数:

headersCodec - codec for service message headers; optional, if not set then JdkCodec will be used.

dataCodecs - codecs for service message data; optional, if not set then DataCodec.INSTANCES will be used.

方法详细资料

encodeAndTransform

public <T> T encodeAndTransform(io.scalecube.services.api.ServiceMessage message,
                                java.util.function.BiFunction<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf,T> transformer)
                         throws io.scalecube.services.exceptions.MessageCodecException

Encode a message, transform it to T.

参数:

message - the message to transform

transformer - a function that accepts data and header ByteBuf and return the required T

返回:

the object (transformed message)

抛出:

io.scalecube.services.exceptions.MessageCodecException - when encoding cannot be done.

decode

public io.scalecube.services.api.ServiceMessage decode(io.netty.buffer.ByteBuf dataBuffer,
                                                       io.netty.buffer.ByteBuf headersBuffer)
                                                throws io.scalecube.services.exceptions.MessageCodecException

Decode buffers.

参数:

dataBuffer - the buffer of the data (payload)

headersBuffer - the buffer of the headers

返回:

a new Service message with ByteBuf data and with parsed headers.

抛出:

io.scalecube.services.exceptions.MessageCodecException - when decode fails

decodeData

public static io.scalecube.services.api.ServiceMessage decodeData(io.scalecube.services.api.ServiceMessage message,
                                                                  Type dataType)
                                                           throws io.scalecube.services.exceptions.MessageCodecException

Decode message.

参数:

message - the original message (with ByteBuf data)

dataType - the type of the data.

返回:

a new Service message that upon ServiceMessage.data() returns the actual data (of type data type)

抛出:

io.scalecube.services.exceptions.MessageCodecException - when decode fails