Apache Geode Native .NET Reference  1.14.0
Apache::Geode::Client::IPersistenceManager< TKey, TValue > Interface Template Reference

More...

Public Member Functions

void Close ()
 Closes the persistence manager instance. More...
 
void Destroy (TKey key)
 Destroys the entry specified by the key in the argument. More...
 
void Init (IRegion< TKey, TValue >^ region, Properties< String^, String^>^ diskProperties)
 Called after an implementation object is created. More...
 
TValue Read (TKey key)
 Reads the value for the key from the disk. More...
 
bool ReadAll ()
 Reads all the values from the region. More...
 
void Write (TKey key, TValue value)
 Writes a key, value pair of region to the disk. More...
 
bool WriteAll ()
 Writes all the entries for a region. More...
 

Detailed Description

template<class TKey, class TValue>
interface Apache::Geode::Client::IPersistenceManager< TKey, TValue >

IPersistenceManager interface for persistence and overflow. This class abstracts the disk-related operations in case of persistence or overflow to disk. A specific disk storage implementation will implement all the methods described here.

Member Function Documentation

◆ Close()

template<class TKey , class TValue >
void Apache::Geode::Client::IPersistenceManager< TKey, TValue >::Close ( )

Closes the persistence manager instance.

◆ Destroy()

template<class TKey , class TValue >
void Apache::Geode::Client::IPersistenceManager< TKey, TValue >::Destroy ( TKey  key)

Destroys the entry specified by the key in the argument.

Parameters
keykey of the entry which is being destroyed.

◆ Init()

template<class TKey , class TValue >
void Apache::Geode::Client::IPersistenceManager< TKey, TValue >::Init ( IRegion< TKey, TValue >^  region,
Properties< String^, String^>^  diskProperties 
)

Called after an implementation object is created.

Initializes all the implementation specific environments needed.

Parameters
regionRegion for which this PersistenceManager is initialized.
diskPropertiesConfiguration Properties used by PersistenceManager implementation.

◆ Read()

template<class TKey , class TValue >
TValue Apache::Geode::Client::IPersistenceManager< TKey, TValue >::Read ( TKey  key)

Reads the value for the key from the disk.

Parameters
keykey for which the value has to be read.

◆ ReadAll()

template<class TKey , class TValue >
bool Apache::Geode::Client::IPersistenceManager< TKey, TValue >::ReadAll ( )

Reads all the values from the region.

Returns
true if ReadAll is successful.

◆ Write()

template<class TKey , class TValue >
void Apache::Geode::Client::IPersistenceManager< TKey, TValue >::Write ( TKey  key,
TValue  value 
)

Writes a key, value pair of region to the disk.

The actual file or database related write operations should be implemented in this method by the class implementing this method.

Parameters
keythe key to write.
valuethe value to write.

◆ WriteAll()

template<class TKey , class TValue >
bool Apache::Geode::Client::IPersistenceManager< TKey, TValue >::WriteAll ( )

Writes all the entries for a region.

Refer persistance requirement doc for the use case.

Returns
true if WriteAll is successful.

Apache Geode C++ Cache .NET API Documentation