C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.LargeDataUpload.BufferedBytesFromStreamProducer Class Reference

Produces a BlockingCollection of buffered bytes asynchronously which can be consumed on some other thread. More...

Public Member Functions

 BufferedBytesFromStreamProducer (Stream data_source, long? bytes_to_read=null, int? min_buffer_length=null, int? max_buffer_length=null)
 Construct a new BufferProducer that will read bytes from the specified stream and produce a Queue of buffered byte arrays to be consumed.
 
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.
 

Protected Member Functions

virtual void Dispose (bool disposing)
 Cancel the producer thread and dispose of the queue.
 
override bool IsProducerFinished ()
 Indicates whether we're done reading from the stream.
 
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.
 
override bool TryProduceNext (out BufferedBytes next, int buffer_size)
 Attempts to read from the stream.
 
bool TryProduceNext (out TProduced next)
 The method which asynchronously produces items.
 

Properties

long? BytesToRead [get]
 The total number of bytes that will be read from the stream.
 
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 EndOfStreamDetected [get]
 Is set to true if the input source has closed and/or stopped returning bytes.
 
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.
 

Detailed Description

Produces a BlockingCollection of buffered bytes asynchronously which can be consumed on some other thread.

Definition at line 8 of file BufferedBytesFromStreamProducer.cs.

Inheritance diagram for AnalyzeRe.LargeDataUpload.BufferedBytesFromStreamProducer:
AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< BufferedBytes >

Constructor & Destructor Documentation

◆ BufferedBytesFromStreamProducer()

AnalyzeRe.LargeDataUpload.BufferedBytesFromStreamProducer.BufferedBytesFromStreamProducer ( Stream  data_source,
long?  bytes_to_read = null,
int?  min_buffer_length = null,
int?  max_buffer_length = null 
)
inline

Construct a new BufferProducer that will read bytes from the specified stream and produce a Queue of buffered byte arrays to be consumed.

Parameters
data_sourceThe source from which bytes will be read.
bytes_to_readThe number of bytes to read from the stream. If supplied, the reader will read from the stream until that many bytes have been retrieved. If left blank, the reader will read until the end of the stream is detected. If the stream does not reveal it's length, the reader will read until the first time the stream returns 0 bytes, which isn't guaranteed to be the end of the stream.
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 AdaptiveBufferedBytesProducer.MinimumBufferLength for details and defaults.
max_buffer_length(optional) The maximum size the buffered byte arrays can reach. See AdaptiveBufferedBytesProducer.MaximumBufferLength for details and defaults.

Definition at line 46 of file BufferedBytesFromStreamProducer.cs.

Member Function Documentation

◆ Cancel()

virtual void AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.Cancel ( )
inlinevirtualinherited

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]

void AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.Dispose ( )
inlineinherited

Cancel the producer thread and dispose of the queue.

Definition at line 76 of file ProducerConsumerBuffer.cs.

◆ Dispose() [2/2]

virtual void AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.Dispose ( bool  disposing)
inlineprotectedvirtualinherited

Cancel the producer thread and dispose of the queue.

Parameters
disposingWhether dispose is being called by the dispose method or the finalizer

Definition at line 91 of file ProducerConsumerBuffer.cs.

◆ IsProducerFinished()

override bool AnalyzeRe.LargeDataUpload.BufferedBytesFromStreamProducer.IsProducerFinished ( )
inlineprotected

Indicates whether we're done reading from the stream.

Returns
True if the end of stream is reached of we've read the number of bytes requested at construction time.

Definition at line 62 of file BufferedBytesFromStreamProducer.cs.

◆ OnDispose()

virtual void AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.OnDispose ( )
inlineprotectedvirtualinherited

Deriving classes' dispose actions.

Reimplemented in AnalyzeRe.LargeDataUpload.GZipBufferedBytesProducer.

Definition at line 102 of file ProducerConsumerBuffer.cs.

◆ OnStart()

override void AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.OnStart ( )
inlineprotectedvirtualinherited

Ensure the FirstBufferLength doesn't exceed the set buffer length.

Reimplemented from AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< BufferedBytes >.

Reimplemented in AnalyzeRe.LargeDataUpload.BufferedBytesResizer, and AnalyzeRe.LargeDataUpload.GZipBufferedBytesProducer.

Definition at line 62 of file AdaptiveBufferedBytesProducer.cs.

◆ Start()

void AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.Start ( CancellationToken?  cancellationToken = null)
inlineinherited

Start the asynchronous producer.

Parameters
cancellationTokenCancellation token that will notify this producer if it is cancelled and halt the producer thread.
Exceptions
InvalidOperationExceptionProducer is already running.

Definition at line 110 of file ProducerConsumerBuffer.cs.

◆ TryProduceNext() [1/3]

override bool AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.TryProduceNext ( out BufferedBytes  buffer)
inlinesealedprotectedinherited

Attempts to read from the stream.

Parameters
bufferThe 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]

override bool AnalyzeRe.LargeDataUpload.BufferedBytesFromStreamProducer.TryProduceNext ( out BufferedBytes  next,
int  buffer_size 
)
inlineprotected

Attempts to read from the stream.

Parameters
nextThe next buffer to add to the queue.
buffer_sizeThe size of BufferedBytes to create.
Returns
True if some bytes were successfully buffered.

Definition at line 71 of file BufferedBytesFromStreamProducer.cs.

◆ TryProduceNext() [3/3]

bool AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.TryProduceNext ( out TProduced  next)
abstractprotectedinherited

The method which asynchronously produces items.

Parameters
nextThe next item to add to the blocking collection.
Returns
True if an item was successfully produced.

◆ TryTake()

TProduced AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.TryTake ( out bool  success,
CancellationToken?  cancellation 
)
inlineinherited

Attempts to remove an item from the produced list. May block if there is not yet an item ready, or return success:false.

Parameters
successReturns true if a valid item was returned.
cancellationA cancellation token which can be used to cancel this Take operation.
Returns
The item removed from the list.
Exceptions
BufferProducerExceptionIf the producer thread raised an exception.
InvalidOperationExceptionThe 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.

Property Documentation

◆ BytesToRead

long? AnalyzeRe.LargeDataUpload.BufferedBytesFromStreamProducer.BytesToRead
get

The total number of bytes that will be read from the stream.

Definition at line 21 of file BufferedBytesFromStreamProducer.cs.

◆ Cancellation

CancellationTokenSource AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.Cancellation
getprotectedinherited

Can be used to cancel the buffering process.

Definition at line 53 of file ProducerConsumerBuffer.cs.

◆ CanTake

bool AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.CanTake
getinherited

Indicates whether a call to Take will ever return another item.

Exceptions
BufferProducerExceptionIf 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.

◆ EndOfStreamDetected

bool AnalyzeRe.LargeDataUpload.BufferedBytesFromStreamProducer.EndOfStreamDetected
get

Is set to true if the input source has closed and/or stopped returning bytes.

Definition at line 18 of file BufferedBytesFromStreamProducer.cs.

◆ IsConsumerWaiting

bool AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.IsConsumerWaiting
getprotectedinherited

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

bool AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.IsRunning
getinherited

Indicates whether the producer is currently running.

Definition at line 26 of file ProducerConsumerBuffer.cs.

◆ MaximumBufferLength

int AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.MaximumBufferLength = 33554432
getsetinherited

The max length of the each byte array to generate. (Default 32 MiB)

Definition at line 21 of file AdaptiveBufferedBytesProducer.cs.

◆ MinimumBufferLength

int AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.MinimumBufferLength = 16384
getsetinherited

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

BlockingCollection<TProduced> AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< TProduced >.Produced
getprotectedinherited

The collection of objects produced.

Definition at line 19 of file ProducerConsumerBuffer.cs.

◆ TotalBytesRead

long AnalyzeRe.LargeDataUpload.AdaptiveBufferedBytesProducer.TotalBytesRead
getinherited

The total number of bytes that have been buffered since start.

Definition at line 33 of file AdaptiveBufferedBytesProducer.cs.


The documentation for this class was generated from the following file: