akka.stream.scaladsl

Class Compression

java.lang.Object

akka.stream.scaladsl.Compression

public class Compression
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Compression()

Method Summary

Modifier and Type	Method and Description
static Flow<ByteString,ByteString,NotUsed>	deflate() Creates a flow that deflate-compresses a stream of ByteString.
static Flow<ByteString,ByteString,NotUsed>	gunzip(int maxBytesPerChunk) Creates a Flow that decompresses a gzip-compressed stream of data.
static Flow<ByteString,ByteString,NotUsed>	gzip() Creates a flow that gzip-compresses a stream of ByteStrings.
static Flow<ByteString,ByteString,NotUsed>	inflate(int maxBytesPerChunk) Creates a Flow that decompresses a deflate-compressed stream of data.
static int	MaxBytesPerChunkDefault()

Methods inherited from class java.lang.Object

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

Constructor Detail

Compression

public Compression()

Method Detail

MaxBytesPerChunkDefault

public static final int MaxBytesPerChunkDefault()

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 ByteString so that it is guaranteed that every 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.

FIXME: should compression level / strategy / flush mode be configurable? See https://github.com/akka/akka/issues/21849

Returns:

(undocumented)

gunzip

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

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

Parameters:

maxBytesPerChunk - Maximum length of an output ByteString chunk.

Returns:

(undocumented)

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 ByteString so that it is guaranteed that every 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.

FIXME: should compression level / strategy / flush mode be configurable? See https://github.com/akka/akka/issues/21849

Returns:

(undocumented)

inflate

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

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

Parameters:

maxBytesPerChunk - Maximum length of an output ByteString chunk.

Returns:

(undocumented)