Apache::Geode::Client::IPersistenceManager< TKey, TValue > Interface Template Reference

IPersistenceManager interface for persistence and overflow. More...

#include <IPersistenceManager.hpp>

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

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

key	key 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

region	Region for which this PersistenceManager is initialized.
diskProperties	Configuration 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

key	key 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

key	the key to write.
value	the 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.