Package io.grpc

Class Codec.Identity

  • All Implemented Interfaces:
    Codec, Compressor, Decompressor
    Enclosing interface:
    Codec

    public static final class Codec.Identity
    extends java.lang.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.
    • Field Summary

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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.io.OutputStream compress​(java.io.OutputStream os)
      Wraps an existing output stream with a compressing output stream.
      java.io.InputStream decompress​(java.io.InputStream is)
      Wraps an existing input stream with a decompressing input stream.
      java.lang.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 java.io.InputStream decompress​(java.io.InputStream is)
        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
      • getMessageEncoding

        public java.lang.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 java.io.OutputStream compress​(java.io.OutputStream os)
        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