Class BaseDataConsumer<T>

Base class for data consumers to inherit from.

Inheritance
object
BaseDataConsumer<T>
SignedURLDataConsumer
Inherited Members
Namespace: Unity.Simulation
Assembly: Unity.Simulation.Core.dll
Syntax
public abstract class BaseDataConsumer<T>
Type Parameters
Name Description
T

Constructors

BaseDataConsumer()

Declaration
protected BaseDataConsumer()

Fields

_keysToRemove

Declaration
protected List<string> _keysToRemove
Field Value
Type Description
List<string>

_uploadIsArtifact

Declaration
protected Dictionary<string, bool> _uploadIsArtifact
Field Value
Type Description
Dictionary<string, bool>

_uploadQueue

Declaration
protected Queue<string> _uploadQueue
Field Value
Type Description
Queue<string>

_uploadsInFlight

Declaration
protected Dictionary<string, BaseDataConsumer<T>.Uploadable> _uploadsInFlight
Field Value
Type Description
Dictionary<string, BaseDataConsumer<T>.Uploadable>

kMaxSimultaneousUploads

Declaration
protected const int kMaxSimultaneousUploads = 50
Field Value
Type Description
int

kMaxUploadRetryAttempts

Declaration
protected const int kMaxUploadRetryAttempts = 5
Field Value
Type Description
int

kUseConsoleLog

Declaration
protected const bool kUseConsoleLog = true
Field Value
Type Description
bool

Methods

Consume(object, bool, bool)

Consumes the object data.

Declaration
public void Consume(object data, bool synchronous = false, bool isArtifact = true)
Parameters
Type Name Description
object data

data to be consumed. Generally a string representing a path.
bool synchronous

If true, consumption will complete before returning.
bool isArtifact

A flag indicating if object being consumed is artifact or not.

ConsumptionStillInProgress()

Returns true if there is any consumption in progress.

Declaration
public bool ConsumptionStillInProgress()
Returns
Type Description
bool

LocalPathToObjectPath(string)

Implementation for LocalPathToObjectPath must be implemented in derived class.

Declaration
public virtual string LocalPathToObjectPath(string localPath)
Parameters
Type Name Description
string localPath
Returns
Type Description
string

Upload(string, string, bool)

Implementation for Upload must be implemented in derived class.

Declaration
public virtual bool Upload(string localPath, string objectPath, bool isArtifact)
Parameters
Type Name Description
string localPath
string objectPath
bool isArtifact
Returns
Type Description
bool

UploadAsync(Stream, string, bool)

Implementation for UploadAsync must be implemented in derived class.

Declaration
public virtual Task<T> UploadAsync(Stream source, string objectPath, bool isArtifact)
Parameters
Type Name Description
Stream source
string objectPath
bool isArtifact
Returns
Type Description
Task<T>

_ServiceName()

Declaration
protected string _ServiceName()
Returns
Type Description
string