Click or drag to resize
Akka.NETResizableMultiReaderRingBufferT 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 Hierarchy
SystemObject
  Akka.Streams.ImplementationResizableMultiReaderRingBufferT

Namespace:  Akka.Streams.Implementation
Assembly:  Akka.Streams (in Akka.Streams.dll) Version: 1.2.3.129 (1.2.3.129)
Syntax
public class ResizableMultiReaderRingBuffer<T>

Type Parameters

T
TBD

The ResizableMultiReaderRingBufferT type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCapacityLeft
The maximum number of elements the buffer can still take.
Public propertyImmediatelyAvailable
The number of elements the buffer can still take without having to be resized.
Public propertyIsEmpty
TBD
Public propertyLength
The number of elements currently in the buffer.
Public propertyNonEmpty
TBD
Protected propertyUnderlyingArray
TBD
Top
Methods
  NameDescription
Public methodCount
Returns the number of elements that the buffer currently contains for the given cursor.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitCursor
Initializes the given Cursor to the oldest buffer entry that is still available.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOnCursorRemoved
TBD
Public methodRead
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!
Public methodToString
TBD
(Overrides ObjectToString.)
Public methodWrite
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.
Top
Fields
  NameDescription
Protected fieldCursors
TBD
Top
Extension Methods
See Also