Beamable.Api.Analytics.Batch.BatchContainer< T > Class Template Reference

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

Inheritance diagram for Beamable.Api.Analytics.Batch.BatchContainer< T >:

Collaboration diagram for Beamable.Api.Analytics.Batch.BatchContainer< T >:

Public Member Functions
	BatchContainer (int batchMaxSize, double batchTimeoutSeconds)
	Initializes a new instance of the BatchContainer<T> 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 Beamable.Api.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 Beamable.Api.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()

Beamable.Api.Analytics.Batch.BatchContainer< T >.BatchContainer ( int  batchMaxSize, double  batchTimeoutSeconds  )

inline

Initializes a new instance of the BatchContainer<T> class.

Parameters

batchMaxSize	Batch max capacity threshold before expiration.
batchTimeoutSeconds	Batch timeout seconds before expiration.

Member Function Documentation

Add()

virtual void Beamable.Api.Analytics.Batch.BatchContainer< T >.Add ( T  item )

inlinevirtual

Add the specified item to the batch.

Parameters

item

Item.

Implements Beamable.Api.Analytics.Batch.IBatchContainer< T >.

Expire()

virtual void Beamable.Api.Analytics.Batch.BatchContainer< T >.Expire ( )

inlinevirtual

Expire this batch.

Implements Beamable.Api.Analytics.Batch.IBatchContainer< T >.

Property Documentation

Capacity

int Beamable.Api.Analytics.Batch.BatchContainer< T >.Capacity

get

Gets the batch's max capacity before expiration.

The capacity.

Count

int Beamable.Api.Analytics.Batch.BatchContainer< T >.Count

get

Gets the count of elements in the batch.

The count.

ExpiresTimestamp

long Beamable.Api.Analytics.Batch.BatchContainer< T >.ExpiresTimestamp

getprotected set

Gets the expires (unix) timestamp.

The expires timestamp.

IsExpired

bool Beamable.Api.Analytics.Batch.BatchContainer< T >.IsExpired

getprotected set

Gets a value indicating whether this batch is expired.

true

false

Items

List<T> Beamable.Api.Analytics.Batch.BatchContainer< T >.Items

getprotected set

Gets or sets the items in this batch.

The items.

Event Documentation

OnExpired

Action<List<T> > Beamable.Api.Analytics.Batch.BatchContainer< T >.OnExpired

Occurs when the batch expires.

---

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

• client/Packages/com.beamable/Runtime/Core/Platform/SDK/Analytics/Batch/BatchContainer.cs