Produces BufferedByte objects of a variable size depending on whether the consumer of this buffer is blocked waiting on it for more data.
More...
|
| virtual void | Cancel () |
| | Stop the producer from reading any more bytes. Warning: This will leave the stream in its current position and any bytes that haven't been inserted into the buffer are lost.
|
| |
| void | Dispose () |
| | Cancel the producer thread and dispose of the queue.
|
| |
| void | Start (CancellationToken? cancellationToken=null) |
| | Start the asynchronous producer.
|
| |
| TProduced | TryTake (out bool success, CancellationToken? cancellation) |
| | Attempts to remove an item from the produced list. May block if there is not yet an item ready, or return success:false.
|
| |
|
| | AdaptiveBufferedBytesProducer (int? min_buffer_length=null, int? max_buffer_length=null) |
| | Construct a new AdaptiveBufferedBytesProducer which will prepare increasingly large buffers of bytes (up to a maximum) so long as the consumer of this producer is not blocked waiting for more bytes.
|
| |
| virtual void | Dispose (bool disposing) |
| | Cancel the producer thread and dispose of the queue.
|
| |
| bool | IsProducerFinished () |
| | Implementer indicates whether it can produce more items.
|
| |
| virtual void | OnDispose () |
| | Deriving classes' dispose actions.
|
| |
| override void | OnStart () |
| | Ensure the FirstBufferLength doesn't exceed the set buffer length.
|
| |
| override bool | TryProduceNext (out BufferedBytes buffer) |
| | Attempts to read from the stream.
|
| |
| bool | TryProduceNext (out BufferedBytes next, int buffer_size) |
| | The method which asynchronously produces items.
|
| |
| bool | TryProduceNext (out TProduced next) |
| | The method which asynchronously produces items.
|
| |
|
| CancellationTokenSource | Cancellation [get] |
| | Can be used to cancel the buffering process.
|
| |
| bool | CanTake [get] |
| | Indicates whether a call to Take will ever return another item.
|
| |
| bool | IsConsumerWaiting [get] |
| | Determines whether the consumer of this buffer is currently waiting for it to produce some data.
|
| |
| bool | IsRunning [get] |
| | Indicates whether the producer is currently running.
|
| |
| int | MaximumBufferLength = 33554432 [get, set] |
| | The max length of the each byte array to generate. (Default 32 MiB)
|
| |
| int | MinimumBufferLength = 16384 [get, set] |
| | The minimum length of the byte array to generate when the consumer of this buffer is currently waiting for more data. (Default 16 KiB) Set this lower if the consumer frequently spends too much time waiting for the producer to send the prepare the next byte array. As soon as the consumer requests more data, we will return the current buffer, if we've filled more than this many bytes. Note that smaller buffers may be returned if the end of the source stream is reached.
|
| |
| BlockingCollection< TProduced > | Produced [get] |
| | The collection of objects produced.
|
| |
| long | TotalBytesRead [get] |
| | The total number of bytes that have been buffered since start.
|
| |
Produces BufferedByte objects of a variable size depending on whether the consumer of this buffer is blocked waiting on it for more data.
Definition at line 7 of file AdaptiveBufferedBytesProducer.cs.
◆ AdaptiveBufferedBytesProducer()
| AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.AdaptiveBufferedBytesProducer |
( |
int? |
min_buffer_length = null, |
|
|
int? |
max_buffer_length = null |
|
) |
| |
|
inlineprotected |
Construct a new AdaptiveBufferedBytesProducer which will prepare increasingly large buffers of bytes (up to a maximum) so long as the consumer of this producer is not blocked waiting for more bytes.
- Parameters
-
| min_buffer_length | (optional) The minimum size a buffered byte array will have. The first object returned will have this length to ensure the consumer becomes unblocked as soon as possible. See MinimumBufferLength for details and defaults. |
| max_buffer_length | (optional) The maximum size the buffered byte arrays can reach. See MaximumBufferLength for details and defaults. |
Definition at line 51 of file AdaptiveBufferedBytesProducer.cs.
◆ Cancel()
Stop the producer from reading any more bytes. Warning: This will leave the stream in its current position and any bytes that haven't been inserted into the buffer are lost.
Definition at line 172 of file ProducerConsumerBuffer.cs.
◆ Dispose() [1/2]
◆ Dispose() [2/2]
|
|
inlineprotectedvirtualinherited |
Cancel the producer thread and dispose of the queue.
- Parameters
-
| disposing | Whether dispose is being called by the dispose method or the finalizer |
Definition at line 91 of file ProducerConsumerBuffer.cs.
◆ IsProducerFinished()
|
|
abstractprotectedinherited |
Implementer indicates whether it can produce more items.
- Returns
- True if it is finished producing items.
◆ OnDispose()
|
|
inlineprotectedvirtualinherited |
◆ OnStart()
| override void AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.OnStart |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ Start()
Start the asynchronous producer.
- Parameters
-
| cancellationToken | Cancellation token that will notify this producer if it is cancelled and halt the producer thread. |
- Exceptions
-
| InvalidOperationException | Producer is already running. |
Definition at line 110 of file ProducerConsumerBuffer.cs.
◆ TryProduceNext() [1/3]
| override bool AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.TryProduceNext |
( |
out BufferedBytes |
buffer | ) |
|
|
inlinesealedprotected |
Attempts to read from the stream.
- Parameters
-
| buffer | The next buffer to add to the queue. |
- Returns
- True if some bytes were successfully buffered.
Definition at line 78 of file AdaptiveBufferedBytesProducer.cs.
◆ TryProduceNext() [2/3]
| bool AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.TryProduceNext |
( |
out BufferedBytes |
next, |
|
|
int |
buffer_size |
|
) |
| |
|
abstractprotected |
The method which asynchronously produces items.
- Parameters
-
| next | The next item to add to the blocking collection. |
| buffer_size | The size of BufferedBytes to create. |
- Returns
- True if an item was successfully produced.
◆ TryProduceNext() [3/3]
|
|
abstractprotectedinherited |
The method which asynchronously produces items.
- Parameters
-
| next | The next item to add to the blocking collection. |
- Returns
- True if an item was successfully produced.
◆ TryTake()
Attempts to remove an item from the produced list. May block if there is not yet an item ready, or return success:false.
- Parameters
-
| success | Returns true if a valid item was returned. |
| cancellation | A cancellation token which can be used to cancel this Take operation. |
- Returns
- The item removed from the list.
- Exceptions
-
| BufferProducerException | If the producer thread raised an exception. |
| InvalidOperationException | The producer thread is not currently running, either because the Start method has not been called, or because the Cancel method has been called. |
Definition at line 138 of file ProducerConsumerBuffer.cs.
◆ Cancellation
◆ CanTake
Indicates whether a call to Take will ever return another item.
- Exceptions
-
| BufferProducerException | If the producer thread raised an exception. |
HACK: Need some way of surfacing asynchronous errors without consumers assuming we're done, so raise any asynchronous exception here. TODO: Revisit Implementation such that BufferProducerException is discovered elsewhere CanTake can simply be made to return false if an exception occurred.
Definition at line 36 of file ProducerConsumerBuffer.cs.
◆ IsConsumerWaiting
Determines whether the consumer of this buffer is currently waiting for it to produce some data.
Definition at line 23 of file ProducerConsumerBuffer.cs.
◆ IsRunning
◆ MaximumBufferLength
| int AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.MaximumBufferLength = 33554432 |
|
getset |
◆ MinimumBufferLength
| int AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.MinimumBufferLength = 16384 |
|
getset |
The minimum length of the byte array to generate when the consumer of this buffer is currently waiting for more data. (Default 16 KiB) Set this lower if the consumer frequently spends too much time waiting for the producer to send the prepare the next byte array. As soon as the consumer requests more data, we will return the current buffer, if we've filled more than this many bytes. Note that smaller buffers may be returned if the end of the source stream is reached.
Definition at line 30 of file AdaptiveBufferedBytesProducer.cs.
◆ Produced
◆ TotalBytesRead
| long AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.TotalBytesRead |
|
get |
The documentation for this class was generated from the following file:
1.9.8