io.grpc

Class Codec.Identity

java.lang.Object

io.grpc.Codec.Identity

All Implemented Interfaces:

Codec, Compressor, Decompressor

Enclosing interface:

Codec

public static final class Codec.Identity
extends Object
implements Codec

The "identity", or "none" codec. This codec is special in that it can be used to explicitly disable Call compression on a Channel that by default compresses.

Nested Class Summary

Nested classes/interfaces inherited from interface io.grpc.Codec

Codec.Gzip, Codec.Identity

Field Summary

Fields

Modifier and Type	Field and Description
static Codec	NONE Special sentinel codec indicating that no compression should be used.

Method Summary

Modifier and Type	Method and Description
OutputStream	compress(OutputStream os) Wraps an existing output stream with a compressing output stream.
InputStream	decompress(InputStream is) Wraps an existing input stream with a decompressing input stream.
String	getMessageEncoding() Returns the message encoding that this compressor uses.

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final Codec NONE

Special sentinel codec indicating that no compression should be used. Users should use reference equality to see if compression is disabled.

Method Detail

decompress

public InputStream decompress(InputStream is)
                       throws IOException

Description copied from interface: Decompressor

Wraps an existing input stream with a decompressing input stream.

Specified by:

decompress in interface Decompressor

Parameters:

is - The input stream of uncompressed data

Returns:

An input stream that decompresses

Throws:

IOException

getMessageEncoding

public String getMessageEncoding()

Description copied from interface: Compressor

Returns the message encoding that this compressor uses.

This can be values such as "gzip", "deflate", "snappy", etc.

Specified by:

getMessageEncoding in interface Compressor

Specified by:

getMessageEncoding in interface Decompressor

compress

public OutputStream compress(OutputStream os)
                      throws IOException

Description copied from interface: Compressor

Wraps an existing output stream with a compressing output stream.

Specified by:

compress in interface Compressor

Parameters:

os - The output stream of uncompressed data

Returns:

An output stream that compresses

Throws:

IOException