Package akka.stream.scaladsl
Class Compression$
- java.lang.Object
-
- akka.stream.scaladsl.Compression$
-
public class Compression$ extends java.lang.Object
Creates a flow that gzip-compresses a stream of ByteStrings. Note that the compressor will SYNC_FLUSH after everyByteString
so that it is guaranteed that everyByteString
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
-
-
Field Summary
Fields Modifier and Type Field Description static Compression$
MODULE$
Static reference to the singleton instance of this Scala object.
-
Constructor Summary
Constructors Constructor Description Compression$()
-
Method Summary
All Methods Instance Methods Concrete Methods 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 asdeflate()
with configurable level and nowrapFlow<ByteString,ByteString,NotUsed>
gunzip(int maxBytesPerChunk)
Creates a Flow that decompresses a gzip-compressed stream of data.int
gunzip$default$1()
Flow<ByteString,ByteString,NotUsed>
gzip()
Creates a flow that gzip-compresses a stream of ByteStrings.Flow<ByteString,ByteString,NotUsed>
gzip(int level)
Same asgzip()
with a custom level.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()
int
MaxBytesPerChunkDefault()
-
-
-
Field Detail
-
MODULE$
public static final Compression$ MODULE$
Static reference to the singleton instance of this Scala object.
-
-
Method Detail
-
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 SYNC_FLUSH after everyByteString
so that it is guaranteed that everyByteString
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
- Returns:
- (undocumented)
-
gzip
public Flow<ByteString,ByteString,NotUsed> gzip(int level)
Same asgzip()
with a custom level.- Parameters:
level
- Compression level (0-9)- Returns:
- (undocumented)
-
gunzip
public Flow<ByteString,ByteString,NotUsed> gunzip(int maxBytesPerChunk)
Creates a Flow that decompresses a gzip-compressed stream of data.- Parameters:
maxBytesPerChunk
- Maximum length of an outputByteString
chunk.- Returns:
- (undocumented)
-
gunzip$default$1
public int gunzip$default$1()
-
deflate
public Flow<ByteString,ByteString,NotUsed> deflate()
Creates a flow that deflate-compresses a stream of ByteString. Note that the compressor will SYNC_FLUSH after everyByteString
so that it is guaranteed that everyByteString
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
- Returns:
- (undocumented)
-
deflate
public Flow<ByteString,ByteString,NotUsed> deflate(int level, boolean nowrap)
Same asdeflate()
with configurable level and nowrap- Parameters:
level
- Compression level (0-9)nowrap
- if true then use GZIP compatible compression- Returns:
- (undocumented)
-
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 outputByteString
chunk.- Returns:
- (undocumented)
-
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 outputByteString
chunk.nowrap
- if true then use GZIP compatible decompression- Returns:
- (undocumented)
-
inflate$default$1
public int inflate$default$1()
-
-