flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

Added a little documentation on ChunkSender.

Browse Source 
git-svn-id: http://mc-server.googlecode.com/svn/trunk@378 0a769ca7-a7f5-676a-18bf-c427514a06d6
This commit is contained in:
madmaxoft@gmail.com 2012-03-06 21:58:32 +00:00
parent 944dec3a4e
commit b20fa171a4
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
source/ChunkSender.h
View File

@ -3,7 +3,19 @@
// Interfaces to the cChunkSender class representing the thread that waits for chunks becoming ready (loaded / generated) and sends them to clients // Interfaces to the cChunkSender class representing the thread that waits for chunks becoming ready (loaded / generated) and sends them to clients
/*
The whole thing is a thread that runs in a loop, waiting for either:
"finished chunks" (ChunkReady()), or
"chunks to send" (QueueSendChunkTo() )
to come to a queue.
And once they do, it requests the chunk data and sends it all away, either
broadcasting (ChunkReady), or
sends to a specific client (QueueSendChunkTo)
Chunk data is queried using the cChunkDataCallback interface.
It is cached inside the ChunkSender object during the query and then processed after the query ends.
Note that the data needs to be compressed only *after* the query finishes,
because the query callbacks run with ChunkMap's CS locked.
*/
@ -79,6 +91,7 @@ protected:
virtual void Execute(void) override; virtual void Execute(void) override;
// cChunkDataCallback overrides: // cChunkDataCallback overrides:
// (Note that they are called while the ChunkMap's CS is locked - don't do heavy calculations here!)
virtual void BlockData(const char * a_Data) override; virtual void BlockData(const char * a_Data) override;
virtual void Entity(cEntity * a_Entity) override; virtual void Entity(cEntity * a_Entity) override;
virtual void BlockEntity(cBlockEntity * a_Entity) override; virtual void BlockEntity(cBlockEntity * a_Entity) override;