io.grpc

Interface Compressor

All Known Subinterfaces:

Codec

All Known Implementing Classes:

Codec.Gzip, Codec.Identity

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1704")
public interface Compressor

Represents a message compressor.

Method Summary

Modifier and Type	Method and Description
java.io.OutputStream	compress(java.io.OutputStream os) Wraps an existing output stream with a compressing output stream.
java.lang.String	getMessageEncoding() Returns the message encoding that this compressor uses.

Method Detail

getMessageEncoding

java.lang.String getMessageEncoding()

Returns the message encoding that this compressor uses.

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

compress

java.io.OutputStream compress(java.io.OutputStream os)
                       throws java.io.IOException

Wraps an existing output stream with a compressing output stream.

Parameters:

os - The output stream of uncompressed data

Returns:

An output stream that compresses

Throws:

java.io.IOException