blob: 151c5597f89b7a0c5c56d21dc1ff2ed74b4a018d [file] [log] [blame]
.TH "MQTTClient_persistence" 3 "Thu Sep 13 2018" "Paho MQTT C Client Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
MQTTClient_persistence \- A structure containing the function pointers to a persistence implementation and the context or state that will be shared across all the persistence functions\&.
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <MQTTClientPersistence\&.h>\fP
.SS "Data Fields"
.in +1c
.ti -1c
.RI "void * \fBcontext\fP"
.br
.ti -1c
.RI "\fBPersistence_open\fP \fBpopen\fP"
.br
.ti -1c
.RI "\fBPersistence_close\fP \fBpclose\fP"
.br
.ti -1c
.RI "\fBPersistence_put\fP \fBpput\fP"
.br
.ti -1c
.RI "\fBPersistence_get\fP \fBpget\fP"
.br
.ti -1c
.RI "\fBPersistence_remove\fP \fBpremove\fP"
.br
.ti -1c
.RI "\fBPersistence_keys\fP \fBpkeys\fP"
.br
.ti -1c
.RI "\fBPersistence_clear\fP \fBpclear\fP"
.br
.ti -1c
.RI "\fBPersistence_containskey\fP \fBpcontainskey\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
A structure containing the function pointers to a persistence implementation and the context or state that will be shared across all the persistence functions\&.
.SH "Field Documentation"
.PP
.SS "void* context"
A pointer to any data required to initialize the persistent store\&.
.SS "\fBPersistence_open\fP popen"
A function pointer to an implementation of \fBPersistence_open()\fP\&.
.SS "\fBPersistence_close\fP pclose"
A function pointer to an implementation of \fBPersistence_close()\fP\&.
.SS "\fBPersistence_put\fP pput"
A function pointer to an implementation of \fBPersistence_put()\fP\&.
.SS "\fBPersistence_get\fP pget"
A function pointer to an implementation of \fBPersistence_get()\fP\&.
.SS "\fBPersistence_remove\fP premove"
A function pointer to an implementation of \fBPersistence_remove()\fP\&.
.SS "\fBPersistence_keys\fP pkeys"
A function pointer to an implementation of \fBPersistence_keys()\fP\&.
.SS "\fBPersistence_clear\fP pclear"
A function pointer to an implementation of \fBPersistence_clear()\fP\&.
.SS "\fBPersistence_containskey\fP pcontainskey"
A function pointer to an implementation of \fBPersistence_containskey()\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Paho MQTT C Client Library from the source code\&.