Package akka.stream.scaladsl

Class Compression

java.lang.Object

akka.stream.scaladsl.Compression

public class Compression
extends java.lang.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>	gunzip(int maxBytesPerChunk)	Creates a Flow that decompresses a gzip-compressed stream of data.
static int	gunzip$default$1()
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>	inflate(int maxBytesPerChunk)	Creates a Flow that decompresses a deflate-compressed stream of data.
static Flow<ByteString,ByteString,NotUsed>	inflate(int maxBytesPerChunk, boolean nowrap)	Creates a Flow that decompresses a deflate-compressed stream of data.
static int	inflate$default$1()
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 strategy / flush mode be configurable? See https://github.com/akka/akka/issues/21849

gzip

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

Same as gzip() with a custom level.

Parameters:

level - Compression level (0-9)

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.

gunzip$default$1

public static int gunzip$default$1()

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 strategy / flush mode be configurable? See https://github.com/akka/akka/issues/21849

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

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.

inflate

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

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

Parameters:

maxBytesPerChunk - Maximum length of an output ByteString chunk.

nowrap - if true then use GZIP compatible decompression

inflate$default$1

public static int inflate$default$1()