iclient_persistence.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2013-2016 Frank Pagliughi <fpagliughi@mindspring.com>
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v1.0 which accompany this distribution.
 *
 * The Eclipse Public License is available at
 *    http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 *   http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *    Frank Pagliughi - initial implementation and documentation
 *******************************************************************************/

#ifndef __mqtt_iclient_persistence_h
#define __mqtt_iclient_persistence_h

#include "MQTTAsync.h"
#include "mqtt/types.h"
#include "mqtt/buffer_view.h"
#include "mqtt/string_collection.h"
#include <vector>

namespace mqtt {


class iclient_persistence
{
    friend class async_client;
    friend class iclient_persistence_test;

    static int persistence_open(void** handle, const char* clientID, const char* serverURI, void* context);
    static int persistence_close(void* handle);
    static int persistence_put(void* handle, char* key, int bufcount, char* buffers[], int buflens[]);
    static int persistence_get(void* handle, char* key, char** buffer, int* buflen);
    static int persistence_remove(void* handle, char* key);
    static int persistence_keys(void* handle, char*** keys, int* nkeys);
    static int persistence_clear(void* handle);
    static int persistence_containskey(void* handle, char* key);

public:
    using ptr_t = std::shared_ptr<iclient_persistence>;
    using const_ptr_t = std::shared_ptr<const iclient_persistence>;

    virtual ~iclient_persistence() {}
    virtual void open(const string& clientId, const string& serverURI) =0;
    virtual void close() =0;
    virtual void clear() =0;
    virtual bool contains_key(const string& key) =0;
    virtual const string_collection& keys() const =0;
    virtual void put(const string& key, const std::vector<string_view>& bufs) =0;
    virtual string_view get(const string& key) const =0;
    virtual void remove(const string& key) =0;
};

using iclient_persistence_ptr = iclient_persistence::ptr_t;

using const_iclient_persistence_ptr = iclient_persistence::const_ptr_t;

// end namespace mqtt
}

#endif      // __mqtt_iclient_persistence_h