| <!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::CacheFactory 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 .NET Reference |
|  <span id="projectnumber">1.13.0</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('a00538.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="#properties">Properties</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::CacheFactory Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A factory class that must be used to obtain instance of <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a>. |
| <a href="a00538.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:a740164932a73191630744d1f4e626683"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00538.html#a740164932a73191630744d1f4e626683">CacheFactory</a> (<a class="el" href="a00406.html">Properties</a>< String^, String^>^ dsProps)</td></tr> |
| <tr class="memdesc:a740164932a73191630744d1f4e626683"><td class="mdescLeft"> </td><td class="mdescRight">A factory class that must be used to obtain instance of <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a>. <a href="#a740164932a73191630744d1f4e626683">More...</a><br /></td></tr> |
| <tr class="separator:a740164932a73191630744d1f4e626683"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6446fda1a238334375bc09de47623bb2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00538.html#a6446fda1a238334375bc09de47623bb2">CacheFactory</a> ()</td></tr> |
| <tr class="memdesc:a6446fda1a238334375bc09de47623bb2"><td class="mdescLeft"> </td><td class="mdescRight">A factory class that must be used to obtain instance of <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a>. <a href="#a6446fda1a238334375bc09de47623bb2">More...</a><br /></td></tr> |
| <tr class="separator:a6446fda1a238334375bc09de47623bb2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a74aa12fb6f866cbd28c09aaac49924b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00410.html">Cache</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00538.html#a74aa12fb6f866cbd28c09aaac49924b1">Create</a> ()</td></tr> |
| <tr class="memdesc:a74aa12fb6f866cbd28c09aaac49924b1"><td class="mdescLeft"> </td><td class="mdescRight">To create the instance of <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a>. <a href="#a74aa12fb6f866cbd28c09aaac49924b1">More...</a><br /></td></tr> |
| <tr class="separator:a74aa12fb6f866cbd28c09aaac49924b1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9e381edf09fb22615ad52ebf290cbbeb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00538.html">CacheFactory</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00538.html#a9e381edf09fb22615ad52ebf290cbbeb">Set</a> (String^ name, String^ value)</td></tr> |
| <tr class="memdesc:a9e381edf09fb22615ad52ebf290cbbeb"><td class="mdescLeft"> </td><td class="mdescRight">Sets a geode property that will be used when creating the ClientCache. <a href="#a9e381edf09fb22615ad52ebf290cbbeb">More...</a><br /></td></tr> |
| <tr class="separator:a9e381edf09fb22615ad52ebf290cbbeb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8287921c08bba8b3125a785cf6fe080f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00538.html">CacheFactory</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00538.html#a8287921c08bba8b3125a785cf6fe080f">SetAuthInitialize</a> (<a class="el" href="a00898.html">IAuthInitialize</a>^ authInitialize)</td></tr> |
| <tr class="memdesc:a8287921c08bba8b3125a785cf6fe080f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the AuthInitializer defined by the user. <a href="#a8287921c08bba8b3125a785cf6fe080f">More...</a><br /></td></tr> |
| <tr class="separator:a8287921c08bba8b3125a785cf6fe080f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a11bdcf671f40d9eb487721bf37edf6e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00538.html">CacheFactory</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00538.html#a11bdcf671f40d9eb487721bf37edf6e7">SetPdxIgnoreUnreadFields</a> (bool ignore)</td></tr> |
| <tr class="memdesc:a11bdcf671f40d9eb487721bf37edf6e7"><td class="mdescLeft"> </td><td class="mdescRight">summary> Sets the object preference to PdxInstance type. <a href="#a11bdcf671f40d9eb487721bf37edf6e7">More...</a><br /></td></tr> |
| <tr class="separator:a11bdcf671f40d9eb487721bf37edf6e7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a06b9d04793e9fcf7e27adf5aa429429f"><td class="memItemLeft" align="right" valign="top">static String^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00538.html#a06b9d04793e9fcf7e27adf5aa429429f">ProductDescription</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a06b9d04793e9fcf7e27adf5aa429429f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the product description string including product name and version. <a href="#a06b9d04793e9fcf7e27adf5aa429429f">More...</a><br /></td></tr> |
| <tr class="separator:a06b9d04793e9fcf7e27adf5aa429429f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a10361c46dc6dd7a9a521ec617133b017"><td class="memItemLeft" align="right" valign="top">static String^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00538.html#a10361c46dc6dd7a9a521ec617133b017">Version</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a10361c46dc6dd7a9a521ec617133b017"><td class="mdescLeft"> </td><td class="mdescRight">Returns the version of the cache implementation. <a href="#a10361c46dc6dd7a9a521ec617133b017">More...</a><br /></td></tr> |
| <tr class="separator:a10361c46dc6dd7a9a521ec617133b017"><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 factory class that must be used to obtain instance of <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a>. </p> |
| <p>To create a new cache instance, use <a class="el" href="a00538.html#a74aa12fb6f866cbd28c09aaac49924b1" title="To create the instance of Cache.">CacheFactory.Create</a>. </p> |
| <p>To get an existing unclosed cache instance, use Cache.GetInstance. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a740164932a73191630744d1f4e626683"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a740164932a73191630744d1f4e626683">◆ </a></span>CacheFactory() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Apache::Geode::Client::CacheFactory::CacheFactory </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00406.html">Properties</a>< String^, String^>^ </td> |
| <td class="paramname"><em>dsProps</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A factory class that must be used to obtain instance of <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">dsProps</td><td><a class="el" href="a00406.html" title="Provides a collection of properties, each of which is a key/value pair.">Properties</a> which are applicable at client level.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6446fda1a238334375bc09de47623bb2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6446fda1a238334375bc09de47623bb2">◆ </a></span>CacheFactory() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Apache::Geode::Client::CacheFactory::CacheFactory </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A factory class that must be used to obtain instance of <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a>. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a74aa12fb6f866cbd28c09aaac49924b1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a74aa12fb6f866cbd28c09aaac49924b1">◆ </a></span>Create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00410.html">Cache</a> ^ Apache::Geode::Client::CacheFactory::Create </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>To create the instance of <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a>. </p> |
| |
| </div> |
| </div> |
| <a id="a9e381edf09fb22615ad52ebf290cbbeb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9e381edf09fb22615ad52ebf290cbbeb">◆ </a></span>Set()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00538.html">CacheFactory</a> ^ Apache::Geode::Client::CacheFactory::Set </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String^ </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>Sets a geode property that will be used when creating the ClientCache. </p> |
| <p>name the name of the geode property </p> |
| <p>value the value of the geode property </p> |
| <dl class="section return"><dt>Returns</dt><dd>a instance of <code><a class="el" href="a00538.html" title="A factory class that must be used to obtain instance of Cache.">CacheFactory</a></code> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8287921c08bba8b3125a785cf6fe080f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8287921c08bba8b3125a785cf6fe080f">◆ </a></span>SetAuthInitialize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00538.html">CacheFactory</a> ^ Apache::Geode::Client::CacheFactory::SetAuthInitialize </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00898.html">IAuthInitialize</a>^ </td> |
| <td class="paramname"><em>authInitialize</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the AuthInitializer defined by the user. </p> |
| <p>The AuthInitializer will be used to obtain credentials for a client. </p> |
| <p>authInitialize </p> |
| <dl class="section return"><dt>Returns</dt><dd>a instance of <code><a class="el" href="a00538.html" title="A factory class that must be used to obtain instance of Cache.">CacheFactory</a></code> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a11bdcf671f40d9eb487721bf37edf6e7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a11bdcf671f40d9eb487721bf37edf6e7">◆ </a></span>SetPdxIgnoreUnreadFields()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00538.html">CacheFactory</a> ^ Apache::Geode::Client::CacheFactory::SetPdxIgnoreUnreadFields </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>ignore</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>summary> Sets the object preference to PdxInstance type. </p> |
| <p>When a cached object that was serialized as a PDX is read from the cache a <a class="el" href="">PdxInstance</a> will be returned instead of the actual domain class. The PdxInstance is an interface that provides run time access to the fields of a PDX without deserializing the entire PDX. The PdxInstance implementation is a light weight wrapper that simply refers to the raw bytes of the PDX that are kept in the cache. Using this method applications can choose to access PdxInstance instead of Java object. Note that a PdxInstance is only returned if a serialized PDX is found in the cache. If the cache contains a deserialized PDX, then a domain class instance is returned instead of a PdxInstance. /summary> pdxReadSerialized </p><div class="fragment"><div class="line"><span class="keyword">true</span></div></div><!-- fragment --><p> to prefer PdxInstance </p><div class="fragment"><div class="line"><span class="keyword">false</span></div></div><!-- fragment --><p>, the default, if they should be preserved. </p> |
| <dl class="section return"><dt>Returns</dt><dd>a instance of <code><a class="el" href="a00538.html" title="A factory class that must be used to obtain instance of Cache.">CacheFactory</a></code> </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a06b9d04793e9fcf7e27adf5aa429429f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a06b9d04793e9fcf7e27adf5aa429429f">◆ </a></span>ProductDescription</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String^ Apache::Geode::Client::CacheFactory::ProductDescription</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the product description string including product name and version. </p> |
| <p>summary> Control whether pdx ignores fields that were unread during deserialization. The default is to preserve unread fields be including their data during serialization. But if you configure the cache to ignore unread fields then their data will be lost during serialization. </p> |
| <p>You should only set this attribute to <code>true</code> if you know this member will only be reading cache data. In this use case you do not need to pay the cost of preserving the unread fields since you will never be reserializing pdx data. summary> ignore </p><div class="fragment"><div class="line"><span class="keyword">true</span></div></div><!-- fragment --><p> if fields not read during pdx deserialization should be ignored; </p><div class="fragment"><div class="line"><span class="keyword">false</span></div></div><!-- fragment --><p>, the default, if they should be preserved. </p> |
| <dl class="section return"><dt>Returns</dt><dd>a instance of <code><a class="el" href="a00538.html" title="A factory class that must be used to obtain instance of Cache.">CacheFactory</a></code> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a10361c46dc6dd7a9a521ec617133b017"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a10361c46dc6dd7a9a521ec617133b017">◆ </a></span>Version</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String^ Apache::Geode::Client::CacheFactory::Version</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the version of the cache implementation. </p> |
| <p>For the 1.0 release of <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a>, the string returned is <code>1.0</code>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the version of the cache implementation as a <code>String</code></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> |
