Package org.apache.pekko.stream.javadsl

Class Compression

java.lang.Object

org.apache.pekko.stream.javadsl.Compression

public class Compression
extends Object

Constructor Summary

Constructors

Constructor	Description
Compression()

Method Summary

Modifier and Type	Method	Description
static Flow<ByteString,ByteString,NotUsed>	deflate()	Creates a flow that deflate-compresses a stream of ByteString.
static Flow<ByteString,ByteString,NotUsed>	deflate(int level, boolean nowrap)	Same as deflate() with configurable level and nowrap
static Flow<ByteString,ByteString,NotUsed>	gzip()	Creates a flow that gzip-compresses a stream of ByteStrings.
static Flow<ByteString,ByteString,NotUsed>	gzip(int level)	Same as gzip() with a custom level.
static Flow<ByteString,ByteString,NotUsed>	gzipDecompress(int maxBytesPerChunk)	Creates a Flow that decompresses gzip-compressed stream of data.
static Flow<ByteString,ByteString,NotUsed>	inflate(int maxBytesPerChunk)	Creates a Flow that decompresses deflate-compressed stream of data.
static Flow<ByteString,ByteString,NotUsed>	inflate(int maxBytesPerChunk, boolean nowrap)	Same as inflate(int) with configurable maximum output length and nowrap

Methods inherited from class java.lang.Object

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

Constructor Details

Compression

public Compression()

Method Details

gzipDecompress

public static Flow<ByteString,ByteString,NotUsed> gzipDecompress(int maxBytesPerChunk)

Creates a Flow that decompresses gzip-compressed stream of data.

Parameters:

maxBytesPerChunk - Maximum length of the output pekko.util.ByteString chunk.

Since:

1.3.0

inflate

public static Flow<ByteString,ByteString,NotUsed> inflate(int maxBytesPerChunk)

Creates a Flow that decompresses deflate-compressed stream of data.

Parameters:

maxBytesPerChunk - Maximum length of the output pekko.util.ByteString chunk.

inflate

public static Flow<ByteString,ByteString,NotUsed> inflate(int maxBytesPerChunk,
 boolean nowrap)

Same as inflate(int) with configurable maximum output length and nowrap

Parameters:

maxBytesPerChunk - Maximum length of the output pekko.util.ByteString chunk.

nowrap - if true then use GZIP compatible decompression

gzip

public static Flow<ByteString,ByteString,NotUsed> gzip()

Creates a flow that gzip-compresses a stream of ByteStrings. Note that the compressor will SYNC_FLUSH after every pekko.util.ByteString so that it is guaranteed that every pekko.util.ByteString coming out of the flow can be fully decompressed without waiting for additional data. This may come at a compression performance cost for very small chunks.

gzip

public static Flow<ByteString,ByteString,NotUsed> gzip(int level)

Same as gzip() with a custom level.

Parameters:

level - Compression level (0-9)

deflate

public static Flow<ByteString,ByteString,NotUsed> deflate()

Creates a flow that deflate-compresses a stream of ByteString. Note that the compressor will SYNC_FLUSH after every pekko.util.ByteString so that it is guaranteed that every pekko.util.ByteString coming out of the flow can be fully decompressed without waiting for additional data. This may come at a compression performance cost for very small chunks.

deflate

public static Flow<ByteString,ByteString,NotUsed> deflate(int level,
 boolean nowrap)

Same as deflate() with configurable level and nowrap

Parameters:

level - Compression level (0-9)

nowrap - if true then use GZIP compatible compression