| <!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"/> |
| <title>mqttpp: mqtt/iclient_persistence.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <!-- Generated by Doxygen 1.6.1 --> |
| <div class="navigation" id="top"> |
| <div class="tabs"> |
| <ul> |
| <li><a href="main.html"><span>Main Page</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| </ul> |
| </div> |
| <div class="tabs"> |
| <ul> |
| <li><a href="files.html"><span>File List</span></a></li> |
| </ul> |
| </div> |
| <h1>mqtt/iclient_persistence.h</h1><a href="iclient__persistence_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 |
| <a name="l00002"></a>00002 |
| <a name="l00003"></a>00003 |
| <a name="l00004"></a>00004 |
| <a name="l00005"></a>00005 |
| <a name="l00006"></a>00006 |
| <a name="l00007"></a>00007 |
| <a name="l00008"></a>00008 <span class="comment">/*******************************************************************************</span> |
| <a name="l00009"></a>00009 <span class="comment"> * Copyright (c) 2013 Frank Pagliughi <fpagliughi@mindspring.com></span> |
| <a name="l00010"></a>00010 <span class="comment"> *</span> |
| <a name="l00011"></a>00011 <span class="comment"> * All rights reserved. This program and the accompanying materials</span> |
| <a name="l00012"></a>00012 <span class="comment"> * are made available under the terms of the Eclipse Public License v1.0</span> |
| <a name="l00013"></a>00013 <span class="comment"> * and Eclipse Distribution License v1.0 which accompany this distribution. </span> |
| <a name="l00014"></a>00014 <span class="comment"> *</span> |
| <a name="l00015"></a>00015 <span class="comment"> * The Eclipse Public License is available at </span> |
| <a name="l00016"></a>00016 <span class="comment"> * http://www.eclipse.org/legal/epl-v10.html</span> |
| <a name="l00017"></a>00017 <span class="comment"> * and the Eclipse Distribution License is available at </span> |
| <a name="l00018"></a>00018 <span class="comment"> * http://www.eclipse.org/org/documents/edl-v10.php.</span> |
| <a name="l00019"></a>00019 <span class="comment"> *</span> |
| <a name="l00020"></a>00020 <span class="comment"> * Contributors:</span> |
| <a name="l00021"></a>00021 <span class="comment"> * Frank Pagliughi - initial implementation and documentation</span> |
| <a name="l00022"></a>00022 <span class="comment"> *******************************************************************************/</span> |
| <a name="l00023"></a>00023 |
| <a name="l00024"></a>00024 <span class="preprocessor">#ifndef __mqtt_iclient_persistence_h</span> |
| <a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define __mqtt_iclient_persistence_h</span> |
| <a name="l00026"></a>00026 <span class="preprocessor"></span> |
| <a name="l00027"></a>00027 <span class="keyword">extern</span> <span class="stringliteral">"C"</span> { |
| <a name="l00028"></a>00028 <span class="preprocessor"> #include "MQTTAsync.h"</span> |
| <a name="l00029"></a>00029 } |
| <a name="l00030"></a>00030 |
| <a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="ipersistable_8h.html" title="Declaration of MQTT ipersistable interface.">mqtt/ipersistable.h</a>"</span> |
| <a name="l00032"></a>00032 <span class="preprocessor">#include <string></span> |
| <a name="l00033"></a>00033 <span class="preprocessor">#include <memory></span> |
| <a name="l00034"></a>00034 <span class="preprocessor">#include <vector></span> |
| <a name="l00035"></a>00035 |
| <a name="l00036"></a>00036 <span class="keyword">namespace </span>mqtt { |
| <a name="l00037"></a>00037 |
| <a name="l00039"></a>00039 |
| <a name="l00057"></a><a class="code" href="classmqtt_1_1iclient__persistence.html">00057</a> <span class="keyword">class </span><a class="code" href="classmqtt_1_1iclient__persistence.html" title="Represents a persistent data store, used to store outbound and inbound messages while...">iclient_persistence</a> |
| <a name="l00058"></a>00058 { |
| <a name="l00059"></a>00059 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classmqtt_1_1iasync__client.html" title="Enables an application to communicate with an MQTT server using non-blocking methods...">iasync_client</a>; |
| <a name="l00060"></a>00060 |
| <a name="l00061"></a>00061 <span class="keyword">public</span>: |
| <a name="l00062"></a>00062 |
| <a name="l00064"></a>00064 <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classmqtt_1_1iclient__persistence.html#a1885f1b75bed2561dcd4874f27c5d329" title="C-callbacks.">persistence_open</a>(<span class="keywordtype">void</span>** handle, <span class="keywordtype">char</span>* clientID, <span class="keywordtype">char</span>* serverURI, <span class="keywordtype">void</span>* context); |
| <a name="l00065"></a>00065 <span class="keyword">static</span> <span class="keywordtype">int</span> persistence_close(<span class="keywordtype">void</span>* handle); |
| <a name="l00066"></a>00066 <span class="keyword">static</span> <span class="keywordtype">int</span> persistence_put(<span class="keywordtype">void</span>* handle, <span class="keywordtype">char</span>* key, <span class="keywordtype">int</span> bufcount, <span class="keywordtype">char</span>* buffers[], <span class="keywordtype">int</span> buflens[]); |
| <a name="l00067"></a>00067 <span class="keyword">static</span> <span class="keywordtype">int</span> persistence_get(<span class="keywordtype">void</span>* handle, <span class="keywordtype">char</span>* key, <span class="keywordtype">char</span>** buffer, <span class="keywordtype">int</span>* buflen); |
| <a name="l00068"></a>00068 <span class="keyword">static</span> <span class="keywordtype">int</span> persistence_remove(<span class="keywordtype">void</span>* handle, <span class="keywordtype">char</span>* key); |
| <a name="l00069"></a>00069 <span class="keyword">static</span> <span class="keywordtype">int</span> persistence_keys(<span class="keywordtype">void</span>* handle, <span class="keywordtype">char</span>*** <a class="code" href="classmqtt_1_1iclient__persistence.html#a6e1abf103bec79b291d2057b56fe9fe1" title="Returns an Enumeration over the keys in this persistent data store.">keys</a>, <span class="keywordtype">int</span>* nkeys); |
| <a name="l00070"></a>00070 <span class="keyword">static</span> <span class="keywordtype">int</span> persistence_clear(<span class="keywordtype">void</span>* handle); |
| <a name="l00071"></a>00071 <span class="keyword">static</span> <span class="keywordtype">int</span> persistence_containskey(<span class="keywordtype">void</span>* handle, <span class="keywordtype">char</span>* key); |
| <a name="l00072"></a>00072 |
| <a name="l00073"></a>00073 <span class="keyword">public</span>: |
| <a name="l00077"></a><a class="code" href="classmqtt_1_1iclient__persistence.html#a9cd7ac5f4878f0f35f4e34f6a5f4eeb9">00077</a> <span class="keyword">typedef</span> std::shared_ptr<iclient_persistence> <a class="code" href="classmqtt_1_1iclient__persistence.html#a9cd7ac5f4878f0f35f4e34f6a5f4eeb9" title="Smart/shared pointer to this class.">ptr_t</a>; |
| <a name="l00081"></a><a class="code" href="classmqtt_1_1iclient__persistence.html#aaf9a10b4dc43863f8d62f708e3f8571b">00081</a> <span class="keyword">virtual</span> <a class="code" href="classmqtt_1_1iclient__persistence.html#aaf9a10b4dc43863f8d62f708e3f8571b" title="Virtual destructor.">~iclient_persistence</a>() {} |
| <a name="l00085"></a>00085 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1iclient__persistence.html#aa784f608f08b7c94416d05b58d585e7f" title="Initialise the persistent store.">open</a>(<span class="keyword">const</span> std::string& clientId, <span class="keyword">const</span> std::string& serverURI) =0; |
| <a name="l00089"></a>00089 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1iclient__persistence.html#a4777bfc318f827d2535ae5e47b1909a5" title="Close the persistent store that was previously opened.">close</a>() =0; |
| <a name="l00093"></a>00093 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1iclient__persistence.html#adb6ad819aea04897b69e411dd1cb5fc7" title="Clears persistence, so that it no longer contains any persisted data.">clear</a>() =0; |
| <a name="l00099"></a>00099 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classmqtt_1_1iclient__persistence.html#ac417f896f753ae8e9b7a8aba44cec14c" title="Returns whether or not data is persisted using the specified key.">contains_key</a>(<span class="keyword">const</span> std::string& key) =0; |
| <a name="l00105"></a>00105 <span class="keyword">virtual</span> ipersistable_ptr <span class="keyword">get</span>(<span class="keyword">const</span> std::string& key) <span class="keyword">const</span> =0; |
| <a name="l00109"></a>00109 <span class="keyword">virtual</span> std::vector<std::string> <a class="code" href="classmqtt_1_1iclient__persistence.html#a6e1abf103bec79b291d2057b56fe9fe1" title="Returns an Enumeration over the keys in this persistent data store.">keys</a>() <span class="keyword">const</span> =0; |
| <a name="l00115"></a>00115 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1iclient__persistence.html#a5d8ad6890091067bea50e005dabbe456" title="Puts the specified data into the persistent store.">put</a>(<span class="keyword">const</span> std::string& key, ipersistable_ptr persistable) =0; |
| <a name="l00120"></a>00120 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <span class="keyword">remove</span>(<span class="keyword">const</span> std::string& key) =0; |
| <a name="l00121"></a>00121 }; |
| <a name="l00122"></a>00122 |
| <a name="l00126"></a>00126 <span class="keyword">typedef</span> std::shared_ptr<iclient_persistence> iclient_persistence_ptr; |
| <a name="l00127"></a>00127 |
| <a name="l00129"></a>00129 <span class="comment">// end namespace mqtt</span> |
| <a name="l00130"></a>00130 } |
| <a name="l00131"></a>00131 |
| <a name="l00132"></a>00132 <span class="preprocessor">#endif // __mqtt_iclient_persistence_h</span> |
| <a name="l00133"></a>00133 <span class="preprocessor"></span> |
| </pre></div></div> |
| <hr size="1"/><address style="text-align: right;"><small>Generated on 30 Apr 2014 for mqttpp by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
| </body> |
| </html> |
