C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
Interface for a class that consumes from a source asynchronously and produces a queue of some other resource to be consumed. More...
Public Member Functions | |
void | Cancel () |
Stop the producer from reading any more bytes. | |
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. | |
Properties | |
bool | CanTake [get] |
Indicates whether a call to Take will ever return another item. | |
bool | IsRunning [get] |
Indicates whether the producer is currently running. | |
Interface for a class that consumes from a source asynchronously and produces a queue of some other resource to be consumed.
Definition at line 8 of file IProducerConsumerBuffer.cs.
void AnalyzeRe.LargeDataUpload.IProducerConsumerBuffer< out TProduced >.Cancel | ( | ) |
Stop the producer from reading any more bytes.
void AnalyzeRe.LargeDataUpload.IProducerConsumerBuffer< out TProduced >.Start | ( | CancellationToken? | cancellationToken = null | ) |
Start the asynchronous producer.
cancellationToken | Cancellation token that will notify this producer if it is cancelled. |
TProduced AnalyzeRe.LargeDataUpload.IProducerConsumerBuffer< out 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.
success | Returns true if a valid item was returned. |
cancellation | A cancellation token to cancel. |
|
get |
Indicates whether a call to Take will ever return another item.
Definition at line 14 of file IProducerConsumerBuffer.cs.
|
get |
Indicates whether the producer is currently running.
Definition at line 11 of file IProducerConsumerBuffer.cs.