| <!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 C++ Reference: apache::geode::client::PersistenceManager Class 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 C++ 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('a00783.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> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> </div> |
| <div class="headertitle"> |
| <div class="title">apache::geode::client::PersistenceManager Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="a00783.html" title="PersistenceManager API for persistence and overflow.">PersistenceManager</a> API for persistence and overflow. |
| <a href="a00783.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:a8796c68a02ca2cb6d40167a4ccf4556c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00783.html#a8796c68a02ca2cb6d40167a4ccf4556c">close</a> ()=0</td></tr> |
| <tr class="memdesc:a8796c68a02ca2cb6d40167a4ccf4556c"><td class="mdescLeft"> </td><td class="mdescRight">Closes the persistence manager instance. <a href="#a8796c68a02ca2cb6d40167a4ccf4556c">More...</a><br /></td></tr> |
| <tr class="separator:a8796c68a02ca2cb6d40167a4ccf4556c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab52e1a2deab8c20db07a5007e3d91de3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00783.html#ab52e1a2deab8c20db07a5007e3d91de3">destroy</a> (const std::shared_ptr< <a class="el" href="a00339.html">CacheableKey</a> > &key, const std::shared_ptr< void > &PersistenceInfo)=0</td></tr> |
| <tr class="memdesc:ab52e1a2deab8c20db07a5007e3d91de3"><td class="mdescLeft"> </td><td class="mdescRight">destroys the entry specified by the key in the argument. <a href="#ab52e1a2deab8c20db07a5007e3d91de3">More...</a><br /></td></tr> |
| <tr class="separator:ab52e1a2deab8c20db07a5007e3d91de3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7c823ff84c48c598581bc1903bc9c6af"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00783.html#a7c823ff84c48c598581bc1903bc9c6af">init</a> (const std::shared_ptr< <a class="el" href="a00815.html">Region</a> > &region, const std::shared_ptr< <a class="el" href="a00799.html">Properties</a> > &diskProperties)=0</td></tr> |
| <tr class="memdesc:a7c823ff84c48c598581bc1903bc9c6af"><td class="mdescLeft"> </td><td class="mdescRight">This method gets called after an implementation object is created. <a href="#a7c823ff84c48c598581bc1903bc9c6af">More...</a><br /></td></tr> |
| <tr class="separator:a7c823ff84c48c598581bc1903bc9c6af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1ddf20039371c73ededad0160b0c516b"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="a00855.html">Cacheable</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00783.html#a1ddf20039371c73ededad0160b0c516b">read</a> (const std::shared_ptr< <a class="el" href="a00339.html">CacheableKey</a> > &key, const std::shared_ptr< void > &PersistenceInfo)=0</td></tr> |
| <tr class="memdesc:a1ddf20039371c73ededad0160b0c516b"><td class="mdescLeft"> </td><td class="mdescRight">Reads the value for the key from the disk. <a href="#a1ddf20039371c73ededad0160b0c516b">More...</a><br /></td></tr> |
| <tr class="separator:a1ddf20039371c73ededad0160b0c516b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a031c8fa4eec38e3f7ee3cfbe78ecb930"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00783.html#a031c8fa4eec38e3f7ee3cfbe78ecb930">readAll</a> ()=0</td></tr> |
| <tr class="memdesc:a031c8fa4eec38e3f7ee3cfbe78ecb930"><td class="mdescLeft"> </td><td class="mdescRight">Reads all the values from the region. <a href="#a031c8fa4eec38e3f7ee3cfbe78ecb930">More...</a><br /></td></tr> |
| <tr class="separator:a031c8fa4eec38e3f7ee3cfbe78ecb930"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8390100e20d88ad6527ff8391a037408"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00783.html#a8390100e20d88ad6527ff8391a037408">write</a> (const std::shared_ptr< <a class="el" href="a00339.html">CacheableKey</a> > &key, const std::shared_ptr< <a class="el" href="a00855.html">Cacheable</a> > &value, std::shared_ptr< void > &persistenceInfo)=0</td></tr> |
| <tr class="memdesc:a8390100e20d88ad6527ff8391a037408"><td class="mdescLeft"> </td><td class="mdescRight">Writes a key, value pair of region to the disk. <a href="#a8390100e20d88ad6527ff8391a037408">More...</a><br /></td></tr> |
| <tr class="separator:a8390100e20d88ad6527ff8391a037408"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aef9468921fff75768ba6809224b1ae3b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00783.html#aef9468921fff75768ba6809224b1ae3b">writeAll</a> ()=0</td></tr> |
| <tr class="memdesc:aef9468921fff75768ba6809224b1ae3b"><td class="mdescLeft"> </td><td class="mdescRight">Writes all the entries for a region. <a href="#aef9468921fff75768ba6809224b1ae3b">More...</a><br /></td></tr> |
| <tr class="separator:aef9468921fff75768ba6809224b1ae3b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a82f75be89ddf35f0a625b0e2c793f4e2"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="a00783.html">PersistenceManager</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00783.html#a82f75be89ddf35f0a625b0e2c793f4e2">getPersistenceManager</a> ()</td></tr> |
| <tr class="memdesc:a82f75be89ddf35f0a625b0e2c793f4e2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current persistence manager. <a href="#a82f75be89ddf35f0a625b0e2c793f4e2">More...</a><br /></td></tr> |
| <tr class="separator:a82f75be89ddf35f0a625b0e2c793f4e2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:a57726d90c0ff1b61ce8cf1bd58a82e65"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="a00815.html">Region</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00783.html#a57726d90c0ff1b61ce8cf1bd58a82e65">m_regionPtr</a></td></tr> |
| <tr class="memdesc:a57726d90c0ff1b61ce8cf1bd58a82e65"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00815.html" title="This class manages subregions and cached data.">Region</a> for this persistence manager. <a href="#a57726d90c0ff1b61ce8cf1bd58a82e65">More...</a><br /></td></tr> |
| <tr class="separator:a57726d90c0ff1b61ce8cf1bd58a82e65"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="a00783.html" title="PersistenceManager API for persistence and overflow.">PersistenceManager</a> API for persistence and overflow. </p> |
| <p>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="a8796c68a02ca2cb6d40167a4ccf4556c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8796c68a02ca2cb6d40167a4ccf4556c">◆ </a></span>close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void apache::geode::client::PersistenceManager::close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Closes the persistence manager instance. </p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00619.html" title="Thrown when persistence manager fails to close properly.">ShutdownFailedException</a></td><td>if close is not successful. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ab52e1a2deab8c20db07a5007e3d91de3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab52e1a2deab8c20db07a5007e3d91de3">◆ </a></span>destroy()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void apache::geode::client::PersistenceManager::destroy </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00339.html">CacheableKey</a> > & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::shared_ptr< void > & </td> |
| <td class="paramname"><em>PersistenceInfo</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </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>is the key of the entry which is being destroyed. </td></tr> |
| <tr><td class="paramname">PersistenceInfo</td><td>related persistence information. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00511.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>is the region is already destroyed. </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00555.html" title="Thrown when an operation is attempted on a non-existent entry.">EntryNotFoundException</a></td><td>if the entry is not found on the disk. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a82f75be89ddf35f0a625b0e2c793f4e2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a82f75be89ddf35f0a625b0e2c793f4e2">◆ </a></span>getPersistenceManager()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static std::shared_ptr<<a class="el" href="a00783.html">PersistenceManager</a>> apache::geode::client::PersistenceManager::getPersistenceManager </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the current persistence manager. </p> |
| <dl class="section return"><dt>Returns</dt><dd>persistence manager </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7c823ff84c48c598581bc1903bc9c6af"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7c823ff84c48c598581bc1903bc9c6af">◆ </a></span>init()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void apache::geode::client::PersistenceManager::init </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00815.html">Region</a> > & </td> |
| <td class="paramname"><em>region</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00799.html">Properties</a> > & </td> |
| <td class="paramname"><em>diskProperties</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method gets called after an implementation object is created. </p> |
| <p>Initializes all the implementation specific environments needed. </p><dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">InitfailedException</td><td>if the persistence manager cannot be initialized. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a1ddf20039371c73ededad0160b0c516b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1ddf20039371c73ededad0160b0c516b">◆ </a></span>read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::shared_ptr<<a class="el" href="a00855.html">Cacheable</a>> apache::geode::client::PersistenceManager::read </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00339.html">CacheableKey</a> > & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::shared_ptr< void > & </td> |
| <td class="paramname"><em>PersistenceInfo</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </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>is the key for which the value has to be read. </td></tr> |
| <tr><td class="paramname">PersistenceInfo</td><td>related persistence information. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>value of type std::shared_ptr<Cacheable>. </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00611.html" title="Thrown by the persistence manager when the data.">DiskCorruptException</a></td><td>if the data to be read is corrupt. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a031c8fa4eec38e3f7ee3cfbe78ecb930"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a031c8fa4eec38e3f7ee3cfbe78ecb930">◆ </a></span>readAll()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool apache::geode::client::PersistenceManager::readAll </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </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 </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8390100e20d88ad6527ff8391a037408"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8390100e20d88ad6527ff8391a037408">◆ </a></span>write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void apache::geode::client::PersistenceManager::write </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00339.html">CacheableKey</a> > & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00855.html">Cacheable</a> > & </td> |
| <td class="paramname"><em>value</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::shared_ptr< void > & </td> |
| <td class="paramname"><em>persistenceInfo</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </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> |
| <tr><td class="paramname">PersistenceInfo</td><td>related persistence information. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00511.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>is the region is already destroyed. </td></tr> |
| <tr><td class="paramname">OutofMemoryException</td><td>if the disk is full </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00607.html" title="Thrown by the persistence manager when a write fails due to disk failure.">DiskFailureException</a></td><td>if the write fails due to disk fail. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aef9468921fff75768ba6809224b1ae3b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aef9468921fff75768ba6809224b1ae3b">◆ </a></span>writeAll()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool apache::geode::client::PersistenceManager::writeAll </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </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="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00607.html" title="Thrown by the persistence manager when a write fails due to disk failure.">DiskFailureException</a></td><td>if the write fails due to disk fail. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Field Documentation</h2> |
| <a id="a57726d90c0ff1b61ce8cf1bd58a82e65"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a57726d90c0ff1b61ce8cf1bd58a82e65">◆ </a></span>m_regionPtr</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="a00815.html">Region</a>> apache::geode::client::PersistenceManager::m_regionPtr</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><a class="el" href="a00815.html" title="This class manages subregions and cached data.">Region</a> for this persistence manager. </p> |
| |
| </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 API Documentation</small></address> |
