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

Converts buffered bytes to strings. More...

Classes

struct  StringWithByteCount
 A tuple containing a string and its UTF8 bytes count. More...
 

Public Member Functions

 BufferedBytesToStringProducer (IProducerConsumerBuffer< BufferedBytes > source, Encoding encoding=null, int max_queue_size=3)
 Construct a producer of strings from buffered bytes.
 
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.
 

Static Public Attributes

static readonly Encoding DEFAULT_ENCODING = Encoding.UTF8
 The default encoding used if none is supplied at construction.
 

Protected Member Functions

virtual void Dispose (bool disposing)
 Cancel the producer thread and dispose of the queue.
 
override bool IsProducerFinished ()
 Indicates whether it can produce more items.
 
virtual void OnDispose ()
 Deriving classes' dispose actions.
 
override void OnStart ()
 Invoked before the producer thread is started.
 
override bool TryProduceNext (out StringWithByteCount next)
 Encode the next string.
 
bool TryProduceNext (out TProduced next)
 The method which asynchronously produces items.
 

Properties

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.
 
Encoding Encoding [get]
 The encoding to use when producing the strings.
 
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.
 
BlockingCollection< TProduced > Produced [get]
 The collection of objects produced.
 

Detailed Description

Converts buffered bytes to strings.

Definition at line 6 of file BufferedBytesToStringProducer.cs.

Inheritance diagram for AnalyzeRe.LargeDataUpload.BufferedBytesToStringProducer:
AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< BufferedBytesToStringProducer.StringWithByteCount >

Class Documentation

◆ AnalyzeRe::LargeDataUpload::BufferedBytesToStringProducer::StringWithByteCount

struct AnalyzeRe::LargeDataUpload::BufferedBytesToStringProducer::StringWithByteCount

A tuple containing a string and its UTF8 bytes count.

Definition at line 16 of file BufferedBytesToStringProducer.cs.

Class Members
int ByteLength The UTF8-Encoded byte length of the string.
string String The value of the string.

Constructor & Destructor Documentation

◆ BufferedBytesToStringProducer()

AnalyzeRe.LargeDataUpload.BufferedBytesToStringProducer.BufferedBytesToStringProducer ( IProducerConsumerBuffer< BufferedBytes source,
Encoding  encoding = null,
int  max_queue_size = 3 
)
inline

Construct a producer of strings from buffered bytes.

Parameters
sourceThe source collection from which buffered bytes can be retrieved.
encodingThe encoding to use when producing the strings.
max_queue_sizeThe maximum number of strings to prepare in advance.

Definition at line 33 of file BufferedBytesToStringProducer.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.BufferedBytesToStringProducer.IsProducerFinished ( )
protected

Indicates whether it can produce more items.

Returns
True if it is finished producing items.

◆ OnDispose()

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

Deriving classes' dispose actions.

Definition at line 102 of file ProducerConsumerBuffer.cs.

◆ OnStart()

override void AnalyzeRe.LargeDataUpload.BufferedBytesToStringProducer.OnStart ( )
inlineprotectedvirtual

Invoked before the producer thread is started.

Reimplemented from AnalyzeRe.LargeDataUpload.ProducerConsumerBuffer< BufferedBytesToStringProducer.StringWithByteCount >.

Definition at line 43 of file BufferedBytesToStringProducer.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/2]

override bool AnalyzeRe.LargeDataUpload.BufferedBytesToStringProducer.TryProduceNext ( out StringWithByteCount  next)
inlineprotected

Encode the next string.

Parameters
nextThe next string to add to the queue.
Returns
True if an item was successfully produced.

Definition at line 58 of file BufferedBytesToStringProducer.cs.

◆ TryProduceNext() [2/2]

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.

Member Data Documentation

◆ DEFAULT_ENCODING

readonly Encoding AnalyzeRe.LargeDataUpload.BufferedBytesToStringProducer.DEFAULT_ENCODING = Encoding.UTF8
static

The default encoding used if none is supplied at construction.

Definition at line 10 of file BufferedBytesToStringProducer.cs.

Property Documentation

◆ 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.

◆ Encoding

Encoding AnalyzeRe.LargeDataUpload.BufferedBytesToStringProducer.Encoding
get

The encoding to use when producing the strings.

Definition at line 13 of file BufferedBytesToStringProducer.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.

◆ Produced

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

The collection of objects produced.

Definition at line 19 of file ProducerConsumerBuffer.cs.


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