sander/exceptional
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc update

Browse source
This commit is contained in:
Shautvast 2024-07-03 13:36:57 +02:00
parent a7bfe88d1c
commit 819be40927
1 changed files with 3 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
lib/src/main/java/com/github/shautvast/exceptional/CircularByteBuffer.java
View file

@ -8,18 +8,15 @@ import java.util.stream.IntStream;
/** /**
* Circular buffer for variable sized byte arrays. The indices for read and write * Circular buffer for variable sized byte arrays. The indices for read and write
* are also stored in the bytebuffer, making changes visible to any non-java process that is reading. * are also stored in the bytebuffer, making changes visible to any non-java process that is reading.
* <p> *
*
* Written for a scenario with multiple concurrent writers, and a single reader in a non-java process * Written for a scenario with multiple concurrent writers, and a single reader in a non-java process
* This class itself is Not Threadsafe! It relies on MPSCBufferWriter for multithreaded writes. This queues * This class itself is Not Threadsafe! It relies on MPSCBufferWriter for multithreaded writes. This queues
* byte arrays waiting to be stored in the circular buffer. MPSCBufferWriter starts the only * byte arrays waiting to be stored in the circular buffer. MPSCBufferWriter starts the only
* thread that is allowed to interact with the CircularByteBuffer. * thread that is allowed to interact with the CircularByteBuffer.
* .. * ..
* *Implementation note:* * *Implementation note:*
* The first 8 bytes are reserved for the reader and writer index. START constant indicates the actual startindex * The last 8 bytes are reserved for the reader and writer index. The actual capacity is always `bytebuffer.capacity -8`
* of the payload data. The index stored is the actual index (ie starting at 8). The reads and write methods
* for reader/writer index deal with the offset value, so that the index (as method local variable) does not
* include it (ie starting at 0). This simplifies the calculations that include these indices. Same goes for the
* capacity.
*/ */
@SuppressWarnings("StringTemplateMigration") @SuppressWarnings("StringTemplateMigration")
public class CircularByteBuffer { public class CircularByteBuffer {