io.servicetalk.encoding.api

Interface BufferDecoderGroup

All Known Implementing Classes:

EmptyBufferDecoderGroup

public interface BufferDecoderGroup

A group of BufferDecoders used when multiple options may be supported.

Method Summary

Modifier and Type	Method and Description
CharSequence	advertisedMessageEncoding() Get the combined encoding to advertise.
List<BufferDecoder>	decoders() Get the supported BufferDecoder for this group.

Method Detail

decoders

List<BufferDecoder> decoders()

Get the supported BufferDecoder for this group.

Returns:

the supported BufferDecoder for this group.

advertisedMessageEncoding

@Nullable
CharSequence advertisedMessageEncoding()

Get the combined encoding to advertise. This is typically a combination of BufferDecoder.encodingName() contained in this group. This value is commonly used in Accept-Encoding (or equivalent) metadata to advertise/communicate the supported algorithms.

Returns:

the combined encoding to advertise. This is typically a combination of BufferDecoder.encodingName() contained in this group. This value is commonly used in Accept-Encoding (or equivalent) metadata to advertise/communicate the supported algorithms.