AMPS C# Client  5.3.3.4
AMPS C# Client for .NET
AMPS.Client.ConflatingRecoveryPointAdapter Class Reference
+ Inheritance diagram for AMPS.Client.ConflatingRecoveryPointAdapter:

Public Member Functions

delegate void ExceptionListener (Exception e)
 
 ConflatingRecoveryPointAdapter (RecoveryPointAdapter adapter_)
 Creates a new ConflatingRecoveryPointAdapter. More...
 
 ConflatingRecoveryPointAdapter (RecoveryPointAdapter adapter_, int updateThreshold_, long timeoutMillis_, int updateIntervalMillis_)
 Creates a new ConflatingRecoveryPointAdapter. More...
 
void setExceptionListener (ExceptionListener exceptionListener)
 Sets the ExceptionListener instance used for communicating absorbed exceptions. More...
 
void update (RecoveryPoint recoveryPoint_)
 
void purge ()
 
void purge (Field subId_)
 
void close ()
 
IEnumerator< RecoveryPointGetEnumerator ()
 
bool MoveNext ()
 
void Reset ()
 
void updateAll ()
 

Protected Attributes

RecoveryPointAdapter _adapter = null
 
int _updateThreshold = 10
 
long _timeoutMillis = 2000
 
int _updateIntervalMillis = 2000
 

Properties

RecoveryPoint Current [get]
 

Constructor & Destructor Documentation

◆ ConflatingRecoveryPointAdapter() [1/2]

AMPS.Client.ConflatingRecoveryPointAdapter.ConflatingRecoveryPointAdapter ( RecoveryPointAdapter  adapter_)
inline

Creates a new ConflatingRecoveryPointAdapter.

Parameters
adapter_The RecoveryPointAdapter doing the actual updates and recovery.

◆ ConflatingRecoveryPointAdapter() [2/2]

AMPS.Client.ConflatingRecoveryPointAdapter.ConflatingRecoveryPointAdapter ( RecoveryPointAdapter  adapter_,
int  updateThreshold_,
long  timeoutMillis_,
int  updateIntervalMillis_ 
)
inline

Creates a new ConflatingRecoveryPointAdapter.

Parameters
adapter_The RecoveryPointAdapter doing the actual updates and recovery.
Parameters
updateThreshold_The maximum number of updates to a single subId before a conflated update is delivered.
Parameters
timeoutMillis_The maximum amount of time in ms between conflated updates for each subId.
Parameters
updateIntervalMillis_The maximum amount of time in ms the update thread can sit idle before checking for timeouts.

Member Function Documentation

◆ close()

void AMPS.Client.ConflatingRecoveryPointAdapter.close ( )
inline

Take any necessary actions to close the underlying storage.

Implements AMPS.Client.RecoveryPointAdapter.

◆ GetEnumerator()

IEnumerator<RecoveryPoint> AMPS.Client.ConflatingRecoveryPointAdapter.GetEnumerator ( )
inline

Return an enumerator over recovered RecoveryPoints.

◆ MoveNext()

bool AMPS.Client.ConflatingRecoveryPointAdapter.MoveNext ( )
inline

IEnumerator move to next item.

◆ purge() [1/2]

void AMPS.Client.ConflatingRecoveryPointAdapter.purge ( )
inline

Remove all recovery point information.

Implements AMPS.Client.RecoveryPointAdapter.

◆ purge() [2/2]

void AMPS.Client.ConflatingRecoveryPointAdapter.purge ( Field  subId_)
inline

Remove all recovery point information for a given sub id.

Implements AMPS.Client.RecoveryPointAdapter.

◆ Reset()

void AMPS.Client.ConflatingRecoveryPointAdapter.Reset ( )
inline

IEnumerator reset - not implemented.

◆ setExceptionListener()

void AMPS.Client.ConflatingRecoveryPointAdapter.setExceptionListener ( ExceptionListener  exceptionListener)
inline

Sets the ExceptionListener instance used for communicating absorbed exceptions.

Parameters
exceptionListenerThe exception listener instance to invoke for exceptions.

◆ update()

void AMPS.Client.ConflatingRecoveryPointAdapter.update ( RecoveryPoint  recoveryPoint_)
inline

Process an update to the newest recovery point.

Implements AMPS.Client.RecoveryPointAdapter.

Property Documentation

◆ Current

RecoveryPoint AMPS.Client.ConflatingRecoveryPointAdapter.Current
get

The current RecoveryPoint from the underlying Adapter.


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