 | ResizableMultiReaderRingBufferT Class |
INTERNAL API
A mutable RingBuffer that can grow in size and supports multiple readers.
Contrary to many other ring buffer implementations this one does not automatically overwrite the oldest
elements, rather, if full, the buffer tries to grow and rejects further writes if max capacity is reached.
Inheritance HierarchyNamespace: Akka.Streams.Implementation
Assembly: Akka.Streams (in Akka.Streams.dll) Version: 1.2.3.42 (1.2.3.42)
SyntaxThe ResizableMultiReaderRingBufferT type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ResizableMultiReaderRingBufferT |
TBD
|
Properties| Name | Description | |
|---|---|---|
 | CapacityLeft |
The maximum number of elements the buffer can still take.
|
| ImmediatelyAvailable |
The number of elements the buffer can still take without having to be resized.
|
| IsEmpty |
TBD
|
| Length |
The number of elements currently in the buffer.
|
| NonEmpty |
TBD
|
 | UnderlyingArray |
TBD
|
Methods| Name | Description | |
|---|---|---|
| Count |
Returns the number of elements that the buffer currently contains for the given cursor.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitCursor |
Initializes the given Cursor to the oldest buffer entry that is still available.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnCursorRemoved |
TBD
|
| Read |
Tries to read from the buffer using the given Cursor.
If there are no more data to be read (i.e. the cursor is already
at writeIx) the method throws NothingToReadException!
|
| ToString |
TBD
(Overrides ObjectToString.) |
| Write |
Tries to write the given value into the buffer thereby potentially growing the backing array.
Returns true if the write was successful and false if the buffer is full and cannot grow anymore.
|
Fields
Extension Methods| Name | Description | |
|---|---|---|
 | AsInstanceOfT |
TBD
(Defined by Extensions.) |
| Match | Overloaded.
Matches the specified target.
(Defined by PatternMatch.) |
| MatchT | Overloaded.
Matches the specified target and return a result of target processing.
(Defined by PatternMatch.) |
See Also