mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-06-30 23:29:54 +00:00
Code Issues Projects Releases Wiki Activity

Server: updated documentation for prepareBatch()

Browse Source
This commit is contained in:
Dylan K. Taylor 2023-11-17 12:01:19 +00:00
parent 89fbb3fd0d
commit a25597ca30
No known key found for this signature in database
GPG Key ID: 8927471A91CAFD3D
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/Server.php
View File

@ -1357,7 +1357,14 @@ class Server{
/** /**
* @internal * @internal
* Broadcasts a list of packets in a batch to a list of players * Promises to compress the given batch buffer using the selected compressor, optionally on a separate thread.
*
* If the buffer is smaller than the batch-threshold (usually 256), the buffer will be compressed at level 0 if supported
* by the compressor. This means that the payload will be wrapped with the appropriate header and footer, but not
* actually compressed.
*
* If the buffer is larger than the async-compression-threshold (usually 10,000), the buffer may be compressed in
* a separate thread (if available).
* *
* @param bool|null $sync Compression on the main thread (true) or workers (false). Default is automatic (null). * @param bool|null $sync Compression on the main thread (true) or workers (false). Default is automatic (null).
*/ */