| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native .NET Reference: Apache::Geode::Client::IPersistenceManager< TKey, TValue > Interface Template Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Geode Native .NET Reference |
|  <span id="projectnumber">1.13.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00998.html','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::IPersistenceManager< TKey, TValue > Interface Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p> |
| <a href="a00998.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:ae74167c2008408d1594c091abc1576c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00998.html#ae74167c2008408d1594c091abc1576c6">Close</a> ()</td></tr> |
| <tr class="memdesc:ae74167c2008408d1594c091abc1576c6"><td class="mdescLeft"> </td><td class="mdescRight">Closes the persistence manager instance. <a href="#ae74167c2008408d1594c091abc1576c6">More...</a><br /></td></tr> |
| <tr class="separator:ae74167c2008408d1594c091abc1576c6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a280670ba915fb53bba8ad3672453210a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00998.html#a280670ba915fb53bba8ad3672453210a">Destroy</a> (TKey key)</td></tr> |
| <tr class="memdesc:a280670ba915fb53bba8ad3672453210a"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the entry specified by the key in the argument. <a href="#a280670ba915fb53bba8ad3672453210a">More...</a><br /></td></tr> |
| <tr class="separator:a280670ba915fb53bba8ad3672453210a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae6dffbf19d398e283cc04cc12844c8fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00998.html#ae6dffbf19d398e283cc04cc12844c8fe">Init</a> (<a class="el" href="a01014.html">IRegion</a>< TKey, TValue >^ region, <a class="el" href="a00406.html">Properties</a>< String^, String^>^ diskProperties)</td></tr> |
| <tr class="memdesc:ae6dffbf19d398e283cc04cc12844c8fe"><td class="mdescLeft"> </td><td class="mdescRight">Called after an implementation object is created. <a href="#ae6dffbf19d398e283cc04cc12844c8fe">More...</a><br /></td></tr> |
| <tr class="separator:ae6dffbf19d398e283cc04cc12844c8fe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7fd27c843b25bf450e8b926529b3ac83"><td class="memItemLeft" align="right" valign="top">TValue </td><td class="memItemRight" valign="bottom"><a class="el" href="a00998.html#a7fd27c843b25bf450e8b926529b3ac83">Read</a> (TKey key)</td></tr> |
| <tr class="memdesc:a7fd27c843b25bf450e8b926529b3ac83"><td class="mdescLeft"> </td><td class="mdescRight">Reads the value for the key from the disk. <a href="#a7fd27c843b25bf450e8b926529b3ac83">More...</a><br /></td></tr> |
| <tr class="separator:a7fd27c843b25bf450e8b926529b3ac83"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a769d34862687a66a7d76a91749c2076a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00998.html#a769d34862687a66a7d76a91749c2076a">ReadAll</a> ()</td></tr> |
| <tr class="memdesc:a769d34862687a66a7d76a91749c2076a"><td class="mdescLeft"> </td><td class="mdescRight">Reads all the values from the region. <a href="#a769d34862687a66a7d76a91749c2076a">More...</a><br /></td></tr> |
| <tr class="separator:a769d34862687a66a7d76a91749c2076a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a913c09d6a7746b9223276bb979d7afa9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00998.html#a913c09d6a7746b9223276bb979d7afa9">Write</a> (TKey key, TValue value)</td></tr> |
| <tr class="memdesc:a913c09d6a7746b9223276bb979d7afa9"><td class="mdescLeft"> </td><td class="mdescRight">Writes a key, value pair of region to the disk. <a href="#a913c09d6a7746b9223276bb979d7afa9">More...</a><br /></td></tr> |
| <tr class="separator:a913c09d6a7746b9223276bb979d7afa9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd2054f933926c80de9c5cd149caa6b8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00998.html#acd2054f933926c80de9c5cd149caa6b8">WriteAll</a> ()</td></tr> |
| <tr class="memdesc:acd2054f933926c80de9c5cd149caa6b8"><td class="mdescLeft"> </td><td class="mdescRight">Writes all the entries for a region. <a href="#acd2054f933926c80de9c5cd149caa6b8">More...</a><br /></td></tr> |
| <tr class="separator:acd2054f933926c80de9c5cd149caa6b8"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<class TKey, class TValue><br /> |
| interface Apache::Geode::Client::IPersistenceManager< TKey, TValue ></h3> |
| |
| <p><a class="el" href="a00998.html">IPersistenceManager</a> 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. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae74167c2008408d1594c091abc1576c6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae74167c2008408d1594c091abc1576c6">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="a00998.html">Apache::Geode::Client::IPersistenceManager</a>< TKey, TValue >::Close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Closes the persistence manager instance. </p> |
| |
| </div> |
| </div> |
| <a id="a280670ba915fb53bba8ad3672453210a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a280670ba915fb53bba8ad3672453210a">◆ </a></span>Destroy()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="a00998.html">Apache::Geode::Client::IPersistenceManager</a>< TKey, TValue >::Destroy </td> |
| <td>(</td> |
| <td class="paramtype">TKey </td> |
| <td class="paramname"><em>key</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Destroys the entry specified by the key in the argument. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>key of the entry which is being destroyed. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ae6dffbf19d398e283cc04cc12844c8fe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae6dffbf19d398e283cc04cc12844c8fe">◆ </a></span>Init()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="a00998.html">Apache::Geode::Client::IPersistenceManager</a>< TKey, TValue >::Init </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a01014.html">IRegion</a>< TKey, TValue >^ </td> |
| <td class="paramname"><em>region</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="a00406.html">Properties</a>< String^, String^>^ </td> |
| <td class="paramname"><em>diskProperties</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Called after an implementation object is created. </p> |
| <p>Initializes all the implementation specific environments needed. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">region</td><td>Region for which this PersistenceManager is initialized. </td></tr> |
| <tr><td class="paramname">diskProperties</td><td>Configuration <a class="el" href="a00406.html" title="Provides a collection of properties, each of which is a key/value pair.">Properties</a> used by PersistenceManager implementation. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a7fd27c843b25bf450e8b926529b3ac83"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7fd27c843b25bf450e8b926529b3ac83">◆ </a></span>Read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">TValue <a class="el" href="a00998.html">Apache::Geode::Client::IPersistenceManager</a>< TKey, TValue >::Read </td> |
| <td>(</td> |
| <td class="paramtype">TKey </td> |
| <td class="paramname"><em>key</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads the value for the key from the disk. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>key for which the value has to be read. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a769d34862687a66a7d76a91749c2076a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a769d34862687a66a7d76a91749c2076a">◆ </a></span>ReadAll()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="a00998.html">Apache::Geode::Client::IPersistenceManager</a>< TKey, TValue >::ReadAll </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads all the values from the region. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if ReadAll is successful. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a913c09d6a7746b9223276bb979d7afa9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a913c09d6a7746b9223276bb979d7afa9">◆ </a></span>Write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="a00998.html">Apache::Geode::Client::IPersistenceManager</a>< TKey, TValue >::Write </td> |
| <td>(</td> |
| <td class="paramtype">TKey </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">TValue </td> |
| <td class="paramname"><em>value</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Writes a key, value pair of region to the disk. </p> |
| <p>The actual file or database related write operations should be implemented in this method by the class implementing this method. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>the key to write. </td></tr> |
| <tr><td class="paramname">value</td><td>the value to write. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="acd2054f933926c80de9c5cd149caa6b8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acd2054f933926c80de9c5cd149caa6b8">◆ </a></span>WriteAll()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="a00998.html">Apache::Geode::Client::IPersistenceManager</a>< TKey, TValue >::WriteAll </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Writes all the entries for a region. </p> |
| <p>Refer persistance requirement doc for the use case. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if WriteAll is successful. </dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache .NET API Documentation</small></address> |
