Package com.linecorp.armeria.common.grpc.protocol

Class ArmeriaMessageDeframer

java.lang.Object

com.linecorp.armeria.common.grpc.protocol.ArmeriaMessageDeframer

All Implemented Interfaces:

HttpDecoder<DeframedMessage>, StreamDecoder<HttpData,DeframedMessage>

@UnstableApi
public class ArmeriaMessageDeframer
extends Object
implements HttpDecoder<DeframedMessage>

A deframer of messages transported in the gRPC wire format. See gRPC Wire Format for more detail on the protocol.

The logic has been mostly copied from io.grpc.internal.MessageDeframer, while removing the buffer abstraction in favor of using ByteBuf directly, and allowing the delivery of uncompressed frames as a ByteBuf to optimize message parsing.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NO_MAX_INBOUND_MESSAGE_SIZE

Constructor Summary

Constructors

Constructor	Description
ArmeriaMessageDeframer(int maxMessageLength)	Construct an ArmeriaMessageDeframer for reading messages out of a gRPC request or response.
ArmeriaMessageDeframer(int maxMessageLength, ByteBufAllocator alloc, boolean grpcWebText)	Construct an ArmeriaMessageDeframer for reading messages out of a gRPC request or response with the specified parameters.

Method Summary

Modifier and Type	Method	Description
ArmeriaMessageDeframer	decompressor(@Nullable Decompressor decompressor)	Sets the Decompressor for this deframer.
void	process(StreamDecoderInput in, StreamDecoderOutput<DeframedMessage> out)	Decodes a stream of data to N objects.
ByteBuf	toByteBuf(HttpData in)	Converts the specified StreamDecoder type object into a ByteBuf that is added to StreamDecoderInput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.common.stream.HttpDecoder

processHeaders, processInformationalHeaders, processTrailers

Methods inherited from interface com.linecorp.armeria.common.stream.StreamDecoder

processOnComplete, processOnError

Field Details

NO_MAX_INBOUND_MESSAGE_SIZE

public static final int NO_MAX_INBOUND_MESSAGE_SIZE

See Also:

• Constant Field Values

Constructor Details

ArmeriaMessageDeframer

public ArmeriaMessageDeframer(int maxMessageLength)

Construct an ArmeriaMessageDeframer for reading messages out of a gRPC request or response.

ArmeriaMessageDeframer

public ArmeriaMessageDeframer(int maxMessageLength,
 ByteBufAllocator alloc,
 boolean grpcWebText)

Construct an ArmeriaMessageDeframer for reading messages out of a gRPC request or response with the specified parameters.

Method Details

toByteBuf

public ByteBuf toByteBuf(HttpData in)

Description copied from interface: StreamDecoder

Converts the specified StreamDecoder type object into a ByteBuf that is added to StreamDecoderInput.

Specified by:

toByteBuf in interface HttpDecoder<DeframedMessage>

Specified by:

toByteBuf in interface StreamDecoder<HttpData,DeframedMessage>

process

public void process(StreamDecoderInput in,
 StreamDecoderOutput<DeframedMessage> out)
             throws Exception

Description copied from interface: StreamDecoder

Decodes a stream of data to N objects. This method will be called whenever an object is signaled from Publisher.

Specified by:

process in interface StreamDecoder<HttpData,DeframedMessage>

Throws:

Exception

decompressor

public ArmeriaMessageDeframer decompressor(@Nullable
 @Nullable Decompressor decompressor)

Sets the Decompressor for this deframer.