AuroraMiddleware/lz4
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update API doc regarding double-buffer strategy

Browse Source 
answering question #473
This commit is contained in:
Yann Collet 2018-02-18 11:00:33 -08:00
parent 9f338ae204
commit d74f079748
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/lz4_manual.html
View File

@ -178,7 +178,9 @@ int LZ4_freeStream (LZ4_stream_t* streamPtr);
Important : The previous 64KB of compressed data is assumed to remain preset and unmodified in memory!
If less than 64KB has been compressed all the data must be present.
Special 1 : If input buffer is a double-buffer, it can have any size, including < 64 KB.
Special 1 : When input is a double-buffer, they can have any size, including < 64 KB.
Make sure that buffers are separated by at least one byte.
This way, rule becomes simple : each block depends on previous block only.
Special 2 : If input buffer is a ring-buffer, it can have any size, including < 64 KB.
@return : size of compressed block

4
lib/lz4.h
View File

@ -266,7 +266,9 @@ LZ4LIB_API int LZ4_loadDict (LZ4_stream_t* streamPtr, const char* dictionary, in
*
* Important : The previous 64KB of compressed data is assumed to remain preset and unmodified in memory!
* If less than 64KB has been compressed all the data must be present.
* Special 1 : If input buffer is a double-buffer, it can have any size, including < 64 KB.
* Special 1 : When input is a double-buffer, they can have any size, including < 64 KB.
* Make sure that buffers are separated by at least one byte.
* This way, rule becomes simple : each block depends on previous block only.
* Special 2 : If input buffer is a ring-buffer, it can have any size, including < 64 KB.
*
* @return : size of compressed block