<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.5"/>
<title>xmltooling: xmltooling::StorageService 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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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 style="padding-left: 0.5em;">
<div id="projectname">xmltooling
 <span id="projectnumber">1.5.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</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">
$(document).ready(function(){initNavTree('a00082.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00302.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xmltooling::StorageService Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Generic data storage facility for use by services that require some degree of persistence.
<a href="a00082.html#details">More...</a></p>
<p><code>#include <xmltooling/util/StorageService.h></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html">Capabilities</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a298e3c2c8f9937176dab820d5ba3fe72"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="a00015.html">Capabilities</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a298e3c2c8f9937176dab820d5ba3fe72">getCapabilities</a> () const </td></tr>
<tr class="memdesc:a298e3c2c8f9937176dab820d5ba3fe72"><td class="mdescLeft"> </td><td class="mdescRight">Returns the capabilities of the underlying service. <a href="#a298e3c2c8f9937176dab820d5ba3fe72">More...</a><br/></td></tr>
<tr class="separator:a298e3c2c8f9937176dab820d5ba3fe72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a314bdf9c6ac51c4edcd0f3ca79d11355"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a314bdf9c6ac51c4edcd0f3ca79d11355">createString</a> (const char *context, const char *key, const char *value, time_t expiration)=0</td></tr>
<tr class="memdesc:a314bdf9c6ac51c4edcd0f3ca79d11355"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new "short" record in the storage service. <a href="#a314bdf9c6ac51c4edcd0f3ca79d11355">More...</a><br/></td></tr>
<tr class="separator:a314bdf9c6ac51c4edcd0f3ca79d11355"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e0a950ce38e9fa5966bb3eb2bbe665e"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a8e0a950ce38e9fa5966bb3eb2bbe665e">readString</a> (const char *context, const char *key, std::string *pvalue=0, time_t *pexpiration=0, int version=0)=0</td></tr>
<tr class="memdesc:a8e0a950ce38e9fa5966bb3eb2bbe665e"><td class="mdescLeft"> </td><td class="mdescRight">Returns an existing "short" record from the storage service. <a href="#a8e0a950ce38e9fa5966bb3eb2bbe665e">More...</a><br/></td></tr>
<tr class="separator:a8e0a950ce38e9fa5966bb3eb2bbe665e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9907a7a38c8defaed039c591828ac2de"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a9907a7a38c8defaed039c591828ac2de">updateString</a> (const char *context, const char *key, const char *value=0, time_t expiration=0, int version=0)=0</td></tr>
<tr class="memdesc:a9907a7a38c8defaed039c591828ac2de"><td class="mdescLeft"> </td><td class="mdescRight">Updates an existing "short" record in the storage service. <a href="#a9907a7a38c8defaed039c591828ac2de">More...</a><br/></td></tr>
<tr class="separator:a9907a7a38c8defaed039c591828ac2de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af697222ceb16740a6539daea28fc90da"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#af697222ceb16740a6539daea28fc90da">deleteString</a> (const char *context, const char *key)=0</td></tr>
<tr class="memdesc:af697222ceb16740a6539daea28fc90da"><td class="mdescLeft"> </td><td class="mdescRight">Deletes an existing "short" record from the storage service. <a href="#af697222ceb16740a6539daea28fc90da">More...</a><br/></td></tr>
<tr class="separator:af697222ceb16740a6539daea28fc90da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf888184e3c2b4831f47f71fe069ef6a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#acf888184e3c2b4831f47f71fe069ef6a">createText</a> (const char *context, const char *key, const char *value, time_t expiration)=0</td></tr>
<tr class="memdesc:acf888184e3c2b4831f47f71fe069ef6a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new "long" record in the storage service. <a href="#acf888184e3c2b4831f47f71fe069ef6a">More...</a><br/></td></tr>
<tr class="separator:acf888184e3c2b4831f47f71fe069ef6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ac023976d0686a3631fb8db898cd8f2"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a4ac023976d0686a3631fb8db898cd8f2">readText</a> (const char *context, const char *key, std::string *pvalue=0, time_t *pexpiration=0, int version=0)=0</td></tr>
<tr class="memdesc:a4ac023976d0686a3631fb8db898cd8f2"><td class="mdescLeft"> </td><td class="mdescRight">Returns an existing "long" record from the storage service. <a href="#a4ac023976d0686a3631fb8db898cd8f2">More...</a><br/></td></tr>
<tr class="separator:a4ac023976d0686a3631fb8db898cd8f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ba3e3de28e1605cb9a2f82c7e366417"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a0ba3e3de28e1605cb9a2f82c7e366417">updateText</a> (const char *context, const char *key, const char *value=0, time_t expiration=0, int version=0)=0</td></tr>
<tr class="memdesc:a0ba3e3de28e1605cb9a2f82c7e366417"><td class="mdescLeft"> </td><td class="mdescRight">Updates an existing "long" record in the storage service. <a href="#a0ba3e3de28e1605cb9a2f82c7e366417">More...</a><br/></td></tr>
<tr class="separator:a0ba3e3de28e1605cb9a2f82c7e366417"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad33e93bc48d35eaac2e8cece9cd7330b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#ad33e93bc48d35eaac2e8cece9cd7330b">deleteText</a> (const char *context, const char *key)=0</td></tr>
<tr class="memdesc:ad33e93bc48d35eaac2e8cece9cd7330b"><td class="mdescLeft"> </td><td class="mdescRight">Deletes an existing "long" record from the storage service. <a href="#ad33e93bc48d35eaac2e8cece9cd7330b">More...</a><br/></td></tr>
<tr class="separator:ad33e93bc48d35eaac2e8cece9cd7330b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0c45b1e7e1ea0f81e998fd1985194f6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#ae0c45b1e7e1ea0f81e998fd1985194f6">reap</a> (const char *context)=0</td></tr>
<tr class="memdesc:ae0c45b1e7e1ea0f81e998fd1985194f6"><td class="mdescLeft"> </td><td class="mdescRight">Manually trigger a cleanup of expired records. <a href="#ae0c45b1e7e1ea0f81e998fd1985194f6">More...</a><br/></td></tr>
<tr class="separator:ae0c45b1e7e1ea0f81e998fd1985194f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a761fc446e8288a8f76144697d3b96b19"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a761fc446e8288a8f76144697d3b96b19">updateContext</a> (const char *context, time_t expiration)=0</td></tr>
<tr class="memdesc:a761fc446e8288a8f76144697d3b96b19"><td class="mdescLeft"> </td><td class="mdescRight">Updates the expiration time of all records in the context. <a href="#a761fc446e8288a8f76144697d3b96b19">More...</a><br/></td></tr>
<tr class="separator:a761fc446e8288a8f76144697d3b96b19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb8b202ffd9b9a93edcd033b6776858f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#aeb8b202ffd9b9a93edcd033b6776858f">deleteContext</a> (const char *context)=0</td></tr>
<tr class="memdesc:aeb8b202ffd9b9a93edcd033b6776858f"><td class="mdescLeft"> </td><td class="mdescRight">Forcibly removes all records in a given context along with any associated resources devoted to maintaining the context. <a href="#aeb8b202ffd9b9a93edcd033b6776858f">More...</a><br/></td></tr>
<tr class="separator:aeb8b202ffd9b9a93edcd033b6776858f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Generic data storage facility for use by services that require some degree of persistence. </p>
<p>Implementations will vary in how much persistence they can supply.</p>
<p>Storage is divided into "contexts" identified by a string label. Keys need to be unique only within a given context, so multiple components can share a single storage service safely as long as they use different labels.</p>
<p>The allowable sizes for contexts, keys, and short values can vary and be reported by the implementation to callers, but MUST be at least 255 bytes. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a314bdf9c6ac51c4edcd0f3ca79d11355"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool xmltooling::StorageService::createString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">time_t </td>
<td class="paramname"><em>expiration</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>Creates a new "short" record in the storage service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
<tr><td class="paramname">key</td><td>null-terminated unique key </td></tr>
<tr><td class="paramname">value</td><td>null-terminated value </td></tr>
<tr><td class="paramname">expiration</td><td>an expiration timestamp, after which the record can be purged </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff record was inserted, false iff a duplicate was found</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00044.html" title="Exceptions related to physical input/output errors. ">IOException</a></td><td>raised if fatal errors occur in the insertion process </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acf888184e3c2b4831f47f71fe069ef6a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool xmltooling::StorageService::createText </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">time_t </td>
<td class="paramname"><em>expiration</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>Creates a new "long" record in the storage service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
<tr><td class="paramname">key</td><td>null-terminated unique key </td></tr>
<tr><td class="paramname">value</td><td>null-terminated value of arbitrary length </td></tr>
<tr><td class="paramname">expiration</td><td>an expiration timestamp, after which the record can be purged </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff record was inserted, false iff a duplicate was found</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00044.html" title="Exceptions related to physical input/output errors. ">IOException</a></td><td>raised if errors occur in the insertion process </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aeb8b202ffd9b9a93edcd033b6776858f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void xmltooling::StorageService::deleteContext </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em></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>Forcibly removes all records in a given context along with any associated resources devoted to maintaining the context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af697222ceb16740a6539daea28fc90da"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool xmltooling::StorageService::deleteString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</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>Deletes an existing "short" record from the storage service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
<tr><td class="paramname">key</td><td>null-terminated unique key </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the record existed and was deleted</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00044.html" title="Exceptions related to physical input/output errors. ">IOException</a></td><td>raised if errors occur in the deletion process </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad33e93bc48d35eaac2e8cece9cd7330b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool xmltooling::StorageService::deleteText </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</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>Deletes an existing "long" record from the storage service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
<tr><td class="paramname">key</td><td>null-terminated unique key </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the record existed and was deleted</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00044.html" title="Exceptions related to physical input/output errors. ">IOException</a></td><td>raised if errors occur in the deletion process </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a298e3c2c8f9937176dab820d5ba3fe72"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="a00015.html">Capabilities</a>& xmltooling::StorageService::getCapabilities </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the capabilities of the underlying service. </p>
<p>If implementations support only the 255 character minimum, the default implementation of this method will suffice.</p>
<dl class="section return"><dt>Returns</dt><dd>a reference to an interface to access the service's capabilities </dd></dl>
</div>
</div>
<a class="anchor" id="a8e0a950ce38e9fa5966bb3eb2bbe665e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int xmltooling::StorageService::readString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string * </td>
<td class="paramname"><em>pvalue</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">time_t * </td>
<td class="paramname"><em>pexpiration</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>version</em> = <code>0</code> </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>Returns an existing "short" record from the storage service. </p>
<p>The version parameter can be set for "If-Modified-Since" semantics.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
<tr><td class="paramname">key</td><td>null-terminated unique key </td></tr>
<tr><td class="paramname">pvalue</td><td>location in which to return the record value </td></tr>
<tr><td class="paramname">pexpiration</td><td>location in which to return the expiration timestamp </td></tr>
<tr><td class="paramname">version</td><td>if > 0, only copy back data if newer than supplied version </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the version of the record read back, or 0 if no record exists</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00044.html" title="Exceptions related to physical input/output errors. ">IOException</a></td><td>raised if errors occur in the read process </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4ac023976d0686a3631fb8db898cd8f2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int xmltooling::StorageService::readText </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string * </td>
<td class="paramname"><em>pvalue</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">time_t * </td>
<td class="paramname"><em>pexpiration</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>version</em> = <code>0</code> </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>Returns an existing "long" record from the storage service. </p>
<p>The version parameter can be set for "If-Modified-Since" semantics.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
<tr><td class="paramname">key</td><td>null-terminated unique key </td></tr>
<tr><td class="paramname">pvalue</td><td>location in which to return the record value </td></tr>
<tr><td class="paramname">pexpiration</td><td>location in which to return the expiration timestamp </td></tr>
<tr><td class="paramname">version</td><td>if > 0, only copy back data if newer than supplied version </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the version of the record read back, or 0 if no record exists</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00044.html" title="Exceptions related to physical input/output errors. ">IOException</a></td><td>raised if errors occur in the read process </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae0c45b1e7e1ea0f81e998fd1985194f6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void xmltooling::StorageService::reap </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em></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>Manually trigger a cleanup of expired records. </p>
<p>The method <b>MAY</b> return without guaranteeing that cleanup has already occurred.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a761fc446e8288a8f76144697d3b96b19"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void xmltooling::StorageService::updateContext </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">time_t </td>
<td class="paramname"><em>expiration</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>Updates the expiration time of all records in the context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
<tr><td class="paramname">expiration</td><td>a new expiration timestamp </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9907a7a38c8defaed039c591828ac2de"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int xmltooling::StorageService::updateString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">time_t </td>
<td class="paramname"><em>expiration</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>version</em> = <code>0</code> </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>Updates an existing "short" record in the storage service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
<tr><td class="paramname">key</td><td>null-terminated unique key </td></tr>
<tr><td class="paramname">value</td><td>null-terminated value to store, or nullptr to leave alone </td></tr>
<tr><td class="paramname">expiration</td><td>a new expiration timestamp, or 0 to leave alone </td></tr>
<tr><td class="paramname">version</td><td>if > 0, only update if the current version matches this value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the version of the record after update, 0 if no record exists, or -1 if the version parameter is non-zero and does not match the current version before update (so the caller is out of sync)</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00044.html" title="Exceptions related to physical input/output errors. ">IOException</a></td><td>raised if errors occur in the update process </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0ba3e3de28e1605cb9a2f82c7e366417"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int xmltooling::StorageService::updateText </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">time_t </td>
<td class="paramname"><em>expiration</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>version</em> = <code>0</code> </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>Updates an existing "long" record in the storage service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a storage context label </td></tr>
<tr><td class="paramname">key</td><td>null-terminated unique key </td></tr>
<tr><td class="paramname">value</td><td>null-terminated value of arbitrary length to store, or nullptr to leave alone </td></tr>
<tr><td class="paramname">expiration</td><td>a new expiration timestamp, or 0 to leave alone </td></tr>
<tr><td class="paramname">version</td><td>if > 0, only update if the current version matches this value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the version of the record after update, 0 if no record exists, or -1 if the version parameter is non-zero and does not match the current version before update (so the caller is out of sync)</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00044.html" title="Exceptions related to physical input/output errors. ">IOException</a></td><td>raised if errors occur in the update process </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xmltooling/util/<a class="el" href="a00188.html">StorageService.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00082.html">StorageService</a></li>
<li class="footer">Generated on Wed Sep 2 2015 18:20:35 for xmltooling by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
</html>
