Class ReadWriteRingBuffer
A fixed size buffer of bytes. Both reading and writing are supported.
Reading from an empty buffer will wait until data is written. Writing to a full buffer
will wait until data is read.
Inheritance
ReadWriteRingBuffer
Syntax
public class ReadWriteRingBuffer : object
Constructors
ReadWriteRingBuffer(Int32, Nullable<CancellationToken>)
Create a new RingBuffer with a specified size.
Declaration
public ReadWriteRingBuffer(int size, CancellationToken? token = null)
Parameters
| Type |
Name |
Description |
| Int32 |
size |
The size of the ring buffer to create.
|
| Nullable<CancellationToken> |
token |
|
Properties
BytesRead
Declaration
public long BytesRead { get; }
Property Value
BytesWritten
Declaration
public long BytesWritten { get; }
Property Value
Count
Gets the number of elements in the buffer.
Declaration
public int Count { get; }
Property Value
IsClosed
Declaration
public bool IsClosed { get; }
Property Value
IsEmpty
Gets a value indicating wether the buffer is empty or not.
Declaration
public bool IsEmpty { get; }
Property Value
IsFull
Declaration
public bool IsFull { get; }
Property Value
Item[Int32]
Indexer - Get an element from the tail of the RingBuffer.
Declaration
public byte this[int index] { get; }
Parameters
| Type |
Name |
Description |
| Int32 |
index |
|
Property Value
Length
Declaration
public int Length { get; }
Property Value
Methods
Clear()
Clear the buffer contents.
Declaration
Close()
Close the buffer for writing.
Declaration
Read(Byte[], Int32, Int32)
Declaration
public int Read(byte[] buffer, int index, int count)
Parameters
Returns
ReadByte()
Read a byte from the buffer.
Declaration
Returns
Write(Byte[], Int32, Int32)
Declaration
public void Write(byte[] buffer, int index, int count)
Parameters
WriteByte(Byte)
Write adds a byte to the head of the RingBuffer.
Declaration
public void WriteByte(byte value)
Parameters
| Type |
Name |
Description |
| Byte |
value |
The value to add.
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.