Keypop Calypso Crypto Legacy SAM C++ API 0.6.0
Reference Calypso Crypto Legacy SAM API for C++
Public Member Functions | List of all members
keypop::calypso::crypto::legacysam::transaction::WriteTransactionManager< T > Class Template Referenceabstract

#include <WriteTransactionManager.hpp>

Public Member Functions

virtual T & prepareWriteCounterCeiling (const int counterNumber, const int ceilingValue)=0
 
virtual T & prepareWriteCounterConfiguration (const int counterNumber, const int ceilingValue, const CounterIncrementAccess counterIncrementAccess)=0
 

Detailed Description

template<typename T>
class keypop::calypso::crypto::legacysam::transaction::WriteTransactionManager< T >

Transaction manager dedicated to "WRITE" operations.

Parameters
<T>The type of the lowest level child object.
Since
0.2.0

Definition at line 28 of file WriteTransactionManager.hpp.

Member Function Documentation

◆ prepareWriteCounterCeiling()

template<typename T >
virtual T & keypop::calypso::crypto::legacysam::transaction::WriteTransactionManager< T >::prepareWriteCounterCeiling ( const int  counterNumber,
const int  ceilingValue 
)
pure virtual

Schedules the execution of a "Write Ceilings" command to write a single counter ceiling.

Warning: in the case of an asynchronous transaction the content of the LegacySam object will not be updated.

Parameters
counterNumberThe number of the counter whose ceiling is to be written (in range [0..26]).
ceilingValueThe desired value for the ceiling. The ceiling value is defined as a positive integer less than or equal to 16777210 (in hexadecimal: FFFFFAh).
Returns
The current instance.
Exceptions
IllegalArgumentExceptionIf one of the provided argument is out of range.
Since
0.2.0

◆ prepareWriteCounterConfiguration()

template<typename T >
virtual T & keypop::calypso::crypto::legacysam::transaction::WriteTransactionManager< T >::prepareWriteCounterConfiguration ( const int  counterNumber,
const int  ceilingValue,
const CounterIncrementAccess  counterIncrementAccess 
)
pure virtual

Schedules the execution of a "Write Ceilings" command to write a counter ceiling and its free incrementation configuration.

Note: as this command generates the writing of a full record corresponding to 9 counters, it is necessary either to have read the status of the counters beforehand, or to have called this method for each of the 8 other counters of the same record. Otherwise, an exception will be raised when processing the command.

Warning: in the case of an asynchronous transaction the content of the LegacySam object will not be updated.

Parameters
counterNumberThe number of the counter whose ceiling is to be written (in range [0..26]).
ceilingValueThe desired value for the ceiling. The ceiling value is defined as a positive integer less than or equal to 16777210 (in hexadecimal: FFFFFAh).
counterIncrementAccessThe counter increment access mode.
Returns
The current instance.
Exceptions
IllegalArgumentExceptionIf one of the provided argument is out of range.
Since
0.2.0

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