Lines Matching refs:API
1 # LZ4 Streaming API Basics
3 ## LZ4 API sets
5 LZ4 has the following API sets :
7 - "Auto Framing" API (lz4frame.h) :
8 This is most recommended API for usual application.
11 - "Block" API : This is recommended for simple purpose.
13 - "Streaming" API : This is designed for complex things.
16 Basically, you should use "Auto Framing" API.
20 ## What is difference between Block and Streaming API ?
22 Block API (de)compresses a single contiguous memory block.
24 Streaming API does same thing but (de)compresses multiple adjacent contiguous memory blocks.
25 So LZ4 library could find more redundancy than Block API.
27 The following figure shows difference between API and block sizes.
36 Example (1) : Block API, 4KiB Block
46 Example (2) : Block API, 8KiB Block
58 Example (3) : Streaming API, 4KiB Block
82 ## Restriction of Streaming API
84 For efficiency, Streaming API doesn't keep a mirror copy of dependent (de)compressed memory.