topic.h

Go to the documentation of this file.

 
/*******************************************************************************
 * Copyright (c) 2013-2024 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 v2.0
 * and Eclipse Distribution License v1.0 which accompany this distribution.
 *
 * The Eclipse Public License is available at
 *    http://www.eclipse.org/legal/epl-v20.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_topic_h
#define __mqtt_topic_h
 
#include <vector>
#include <variant>
 
#include "MQTTAsync.h"
#include "mqtt/delivery_token.h"
#include "mqtt/message.h"
#include "mqtt/subscribe_options.h"
#include "mqtt/types.h"
 
namespace mqtt {
 
class iasync_client;


class topic
{
    iasync_client& cli_;
    string name_;
    int qos_;
    bool retained_;
 
public:
    using ptr_t = std::shared_ptr<topic>;
    using const_ptr_t = std::shared_ptr<const topic>;

    topic(
        iasync_client& cli, const string& name, int qos = message::DFLT_QOS,
        bool retained = message::DFLT_RETAINED
    )
        : cli_(cli), name_(name), qos_(qos), retained_(retained) {}

    static ptr_t create(
        iasync_client& cli, const string& name, int qos = message::DFLT_QOS,
        bool retained = message::DFLT_RETAINED
    ) {
        return std::make_shared<topic>(cli, name, qos, retained);
    }

    iasync_client& get_client() { return cli_; }
    const string& get_name() const { return name_; }
    static std::vector<std::string> split(const std::string& topic);
    int get_qos() const { return qos_; }
    bool get_retained() const { return retained_; }
    void set_qos(int qos) {
        message::validate_qos(qos);
        qos_ = qos;
    }

    void set_retained(bool retained) { retained_ = retained; }
    delivery_token_ptr publish(const void* payload, size_t n);
    delivery_token_ptr publish(const void* payload, size_t n, int qos, bool retained);
    delivery_token_ptr publish(binary_ref payload);
    delivery_token_ptr publish(binary_ref payload, int qos, bool retained);
    token_ptr subscribe(const subscribe_options& opts = subscribe_options());
    string to_string() const { return name_; }
};

using topic_ptr = topic::ptr_t;

using const_topic_ptr = topic::const_ptr_t;

//                          Topic Filter

class topic_filter
{
    std::variant<string, std::vector<string>> filter_;
 
public:
    explicit topic_filter(const string& filter);
    static bool is_wildcard(char c) { return c == '+' || c == '#'; }
    static bool is_wildcard(const string& s) { return s.size() == 1 && is_wildcard(s[0]); }
    static bool has_wildcards(const string& filter);
    bool has_wildcards() const;
    bool matches(const string& topic) const;
    string to_string() const;
};

}  // namespace mqtt
 
#endif  // __mqtt_topic_h