Top Description Inners Methods
org.apache.sshd.common.compression

public Interface Compression

extends CompressionInformation
Known Direct Implementers
org.apache.sshd.common.compression.BaseCompression
Imports
java.io.IOException, org.apache.sshd.common.util.buffer.Buffer
Interface used to compress the stream of data between the SSH server and clients.
Author
Apache MINA SSHD Project

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Compression.Type

Enum identifying if this object will be used to compress or uncompress data.

Method Summary

Modifier and TypeMethod and Description
public void
compress(Buffer
the buffer containing the data to compress
buffer)

Compress the given buffer in place.

public void
init(Compression.Type
compression type
type, int
compression level
level)

Initialize this object to either compress or uncompress data.

public void
uncompress(Buffer
the buffer containing the data to uncompress
from, Buffer
the buffer receiving the uncompressed data
to)

Uncompress the data in a buffer into another buffer.

Inherited from org.apache.sshd.common.compression.CompressionInformation:
isCompressionExecutedisDelayed

Method Detail

compressback to summary
public void compress(Buffer buffer) throws IOException

Compress the given buffer in place.

Parameters
buffer:Buffer

the buffer containing the data to compress

Exceptions
IOException:
if an error occurs
initback to summary
public void init(Compression.Type type, int level)

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 methods can be called.

Parameters
type:Compression.Type

compression type

level:int

compression level

uncompressback to summary
public void uncompress(Buffer from, Buffer to) throws IOException

Uncompress the data in a buffer into another buffer.

Parameters
from:Buffer

the buffer containing the data to uncompress

to:Buffer

the buffer receiving the uncompressed data

Exceptions
IOException:
if an error occurs
org.apache.sshd.common.compression back to summary

public final Enum Compression.Type

extends Enum<Compression.Type>
Class Inheritance
Enum identifying if this object will be used to compress or uncompress data.

Field Summary

Modifier and TypeField and Description
public static final Compression.Type
Deflater

public static final Compression.Type
Inflater

Constructor Summary

AccessConstructor and Description
private
Type()

Method Summary

Modifier and TypeMethod and Description
public static Compression.Type
valueOf(String name)

public static Compression.Type[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

Deflaterback to summary
public static final Compression.Type Deflater
Inflaterback to summary
public static final Compression.Type Inflater

Constructor Detail

Typeback to summary
private Type()

Method Detail

valueOfback to summary
public static Compression.Type valueOf(String name)
valuesback to summary
public static Compression.Type[] values()