Skip to content

Commit 524dccb

Browse files
committed
First docs
1 parent 9933ae4 commit 524dccb

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

api/src/main/java/dev/freya02/discord/zstd/api/ZstdDecompressor.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
import org.jspecify.annotations.NullMarked;
44

5+
/**
6+
* A Zstandard streaming decompressor for Discord gateway messages.
7+
* <br>Each message needs to be passed in the same order they were received, none must be skipped.
8+
*
9+
* <p>Note: Instances are <b>not</b> thread safe, as there should be an instance per gateway connection, which uses 1 read thread.
10+
*/
511
@NullMarked
612
public interface ZstdDecompressor {
713
void reset();

0 commit comments

Comments
 (0)