Beamable SDK
Public Member Functions | Protected Attributes | Properties | Events | List of all members
Core.Platform.SDK.Analytics.Batch.BatchContainer< T > Class Template Reference

Batch container. This is a basic batch container. More...

Inheritance diagram for Core.Platform.SDK.Analytics.Batch.BatchContainer< T >:
Inheritance graph
[legend]
Collaboration diagram for Core.Platform.SDK.Analytics.Batch.BatchContainer< T >:
Collaboration graph
[legend]

Public Member Functions

 BatchContainer (int batchMaxSize, double batchTimeoutSeconds)
 Initializes a new instance of the Core.Platform.SDK.Analytics.Batch.BatchContainer`1 class. More...
 
virtual void Add (T item)
 Add the specified item to the batch. More...
 
virtual void Expire ()
 Expire this batch. More...
 

Protected Attributes

long _expiresTimestamp
 
int _capacity
 
List< T > _items
 

Properties

bool IsExpired [get, protected set]
 Gets a value indicating whether this batch is expired. More...
 
long ExpiresTimestamp [get, protected set]
 Gets the expires (unix) timestamp. More...
 
int Capacity [get]
 Gets the batch's max capacity before expiration. More...
 
List< T > Items [get, protected set]
 Gets or sets the items in this batch. More...
 
int Count [get]
 Gets the count of elements in the batch. More...
 
- Properties inherited from Core.Platform.SDK.Analytics.Batch.IBatchContainer< T >
bool IsExpired [get]
 Gets a value indicating whether this batch is expired. More...
 
long ExpiresTimestamp [get]
 Gets the expires (unix) timestamp. More...
 
int Capacity [get]
 Gets the batch's max capacity before expiration. More...
 
int Count [get]
 Gets the count of elements in the batch. More...
 

Events

Action< List< T > > OnExpired
 Occurs when the batch expires. More...
 
- Events inherited from Core.Platform.SDK.Analytics.Batch.IBatchContainer< T >
Action< List< T > > OnExpired
 Occurs when the batch expires. More...
 

Detailed Description

Batch container. This is a basic batch container.

Constructor & Destructor Documentation

◆ BatchContainer()

Core.Platform.SDK.Analytics.Batch.BatchContainer< T >.BatchContainer ( int  batchMaxSize,
double  batchTimeoutSeconds 
)
inline

Initializes a new instance of the Core.Platform.SDK.Analytics.Batch.BatchContainer`1 class.

Parameters
batchMaxSizeBatch max capacity threshold before expiration.
batchTimeoutSecondsBatch timeout seconds before expiration.

Member Function Documentation

◆ Add()

virtual void Core.Platform.SDK.Analytics.Batch.BatchContainer< T >.Add ( item)
inlinevirtual

Add the specified item to the batch.

Parameters
itemItem.

Implements Core.Platform.SDK.Analytics.Batch.IBatchContainer< T >.

◆ Expire()

virtual void Core.Platform.SDK.Analytics.Batch.BatchContainer< T >.Expire ( )
inlinevirtual

Property Documentation

◆ Capacity

Gets the batch's max capacity before expiration.

The capacity.

◆ Count

Gets the count of elements in the batch.

The count.

◆ ExpiresTimestamp

long Core.Platform.SDK.Analytics.Batch.BatchContainer< T >.ExpiresTimestamp
getprotected set

Gets the expires (unix) timestamp.

The expires timestamp.

◆ IsExpired

bool Core.Platform.SDK.Analytics.Batch.BatchContainer< T >.IsExpired
getprotected set

Gets a value indicating whether this batch is expired.

true

false

◆ Items

List<T> Core.Platform.SDK.Analytics.Batch.BatchContainer< T >.Items
getprotected set

Gets or sets the items in this batch.

The items.

Event Documentation

◆ OnExpired

Action<List<T> > Core.Platform.SDK.Analytics.Batch.BatchContainer< T >.OnExpired

Occurs when the batch expires.


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