Package org.apache.pekko.stream.scaladsl

Class Compression$

java.lang.Object

org.apache.pekko.stream.scaladsl.Compression$

public class Compression$
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final Compression$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
Compression$()

Method Summary

Modifier and Type	Method	Description
Flow<ByteString,ByteString,NotUsed>	deflate()	Creates a flow that deflate-compresses a stream of ByteString.
Flow<ByteString,ByteString,NotUsed>	deflate(int level, boolean nowrap)	Same as deflate() with configurable level and nowrap
Flow<ByteString,ByteString,NotUsed>	deflate(int level, boolean nowrap, boolean autoFlush)	Same as deflate() with configurable level, nowrap and autoFlush.
Flow<ByteString,ByteString,NotUsed>	gzip()	Creates a flow that gzip-compresses a stream of ByteStrings.
Flow<ByteString,ByteString,NotUsed>	gzip(int level)	Same as gzip() with a custom level.
Flow<ByteString,ByteString,NotUsed>	gzip(int level, boolean autoFlush)	Same as gzip() with a custom level and configurable flush mode.
Flow<ByteString,ByteString,NotUsed>	gzipDecompress(int maxBytesPerChunk)	Creates a Flow that decompresses a gzip-compressed stream of data.
int	gzipDecompress$default$1()
Flow<ByteString,ByteString,NotUsed>	inflate(int maxBytesPerChunk)	Creates a Flow that decompresses a deflate-compressed stream of data.
Flow<ByteString,ByteString,NotUsed>	inflate(int maxBytesPerChunk, boolean nowrap)	Creates a Flow that decompresses a deflate-compressed stream of data.
int	inflate$default$1()
final int	MaxBytesPerChunkDefault()

Methods inherited from class java.lang.Object

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

Field Details

MODULE$

public static final Compression$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Details

Compression$

public Compression$()

Method Details

MaxBytesPerChunkDefault

public final int MaxBytesPerChunkDefault()

gzip

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

Creates a flow that gzip-compresses a stream of ByteStrings. Note that the compressor will flush after every single element in stream 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 Flow<ByteString,ByteString,NotUsed> gzip(int level)

Same as gzip() with a custom level.

Parameters:

level - Compression level (0-9)

gzip

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

Same as gzip() with a custom level and configurable flush mode.

Parameters:

level - Compression level (0-9)

autoFlush - If true will automatically flush after every single element in the stream.

Since:

1.3.0

gzipDecompress

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

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

Parameters:

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

Since:

1.3.0

gzipDecompress$default$1

public int gzipDecompress$default$1()

deflate

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

Creates a flow that deflate-compresses a stream of ByteString. Note that the compressor will flush after every single element in stream 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 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

deflate

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

Same as deflate() with configurable level, nowrap and autoFlush.

Parameters:

level - Compression level (0-9)

nowrap - if true then use GZIP compatible compression

autoFlush - If true will automatically flush after every single element in the stream.

Since:

1.3.0

inflate

public 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 pekko.util.ByteString chunk.

inflate

public 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 pekko.util.ByteString chunk.

nowrap - if true then use GZIP compatible decompression

inflate$default$1

public int inflate$default$1()