public interface

Compression

net.schmizz.sshj.transport.compression.Compression
Known Indirect Subclasses

Class Overview

Interface used to compress the stream of data between the SSH server and clients.

Summary

Nested Classes
enum Compression.Mode Enum identifying if this object will be used to compress or uncompress data. 
Public Methods
abstract void compress(Buffer buffer)
Compress the given buffer in place.
abstract void init(Compression.Mode mode)
Initialize this object to either compress or uncompress data.
abstract boolean isDelayed()
Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data before the session has been authenticated.
abstract void uncompress(Buffer from, Buffer to)
Uncompress the data in a buffer into another buffer.

Public Methods

public abstract void compress (Buffer buffer)

Compress the given buffer in place.

Parameters
buffer The buffer containing the data to compress s

public abstract void init (Compression.Mode mode)

Initialize this object to either compress or uncompress data. This method must be called prior to any calls to either compress or uncompress. Once the object has been initialized, only one of compress or uncompress method can be called.

Parameters
mode

public abstract boolean isDelayed ()

Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data before the session has been authenticated.

Returns
  • if the compression is delayed after authentication or not

public abstract void uncompress (Buffer from, Buffer to)

Uncompress the data in a buffer into another buffer.

Parameters
from The buffer containing the data to uncompress
to The buffer receiving the uncompressed data
Throws
TransportException