VMware Tanzu GemFire .NET Client API Reference
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. More...
Public Member Functions | |
| void | Init (IRegion< TKey, TValue > region, IProperties< string, string > diskProperties) |
| Called after an implementation object is created. Initializes all the implementation specific environments needed. More... | |
| void | 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. More... | |
| bool | WriteAll () |
| Writes all the entries for a region. Refer persistance requirement doc for the use case. 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 | Destroy (TKey key) |
| Destroys the entry specified by the key in the argument. More... | |
| void | Close () |
| Closes the persistence manager instance. More... | |
Detailed Description
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()
| void IPersistenceManager< TKey, TValue >.Close | ( | ) |
Closes the persistence manager instance.
◆ Destroy()
| void 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()
| void IPersistenceManager< TKey, TValue >.Init | ( | IRegion< TKey, TValue > | region, |
| IProperties< 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()
| TValue 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()
| bool IPersistenceManager< TKey, TValue >.ReadAll | ( | ) |
Reads all the values from the region.
- Returns
- true if ReadAll is successful.
◆ Write()
| void 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()
| bool 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.
The documentation for this interface was generated from the following file:
- gemfire.client/Interfaces/IPersistenceManager.cs

