will_options.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2016 Guilherme M. Ferreira <guilherme.maciel.ferreira@gmail.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:
 *    Guilherme M. Ferreira - initial implementation and documentation
 *    Frank Pagliughi - added copy & move operations
 *******************************************************************************/

#ifndef __mqtt_will_options_h
#define __mqtt_will_options_h

#include "MQTTAsync.h"
#include "mqtt/types.h"
#include "mqtt/message.h"
#include "mqtt/topic.h"

namespace mqtt {

class connect_options;


class will_options
{
    static constexpr int DFLT_QOS = 0;
    static constexpr bool DFLT_RETAINED = false;
    static const MQTTAsync_willOptions DFLT_C_STRUCT;

    MQTTAsync_willOptions opts_;

    string_ref topic_;

    binary_ref payload_;

    friend class connect_options;
    friend class connect_options_test;
    friend class will_options_test;

    const char* c_str(const string_ref& sr) {
        return sr ? sr.to_string().c_str() : nullptr;
    }

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

    will_options();
    will_options(string_ref top, const void *payload, size_t payload_len,
                 int qos=DFLT_QOS, bool retained=DFLT_RETAINED);
    will_options(const topic& top, const void *payload, size_t payload_len,
                 int qos=DFLT_QOS, bool retained=DFLT_RETAINED);
    will_options(string_ref top, binary_ref payload,
                 int qos=DFLT_QOS, bool retained=DFLT_RETAINED);
    will_options(string_ref top, const string& payload,
                 int qos=DFLT_QOS, bool retained=DFLT_QOS);
    will_options(const message& msg);
    will_options(const will_options& opt);
    will_options(will_options&& opt);
    will_options& operator=(const will_options& opt);
    will_options& operator=(will_options&& opt);
    string get_topic() const { return topic_ ? topic_.to_string() : string(); }
    const binary_ref& get_payload() const { return payload_; }
    string get_payload_str() const { return payload_ ? payload_.to_string() : string(); }
    int get_qos() const { return opts_.qos; }
    bool is_retained() const { return opts_.retained != 0; }
    const_message_ptr get_message() const {
        return message::create(topic_, payload_, opts_.qos, to_bool(opts_.retained));
    }
    void set_topic(string_ref top);
    void set_payload(binary_ref msg);
    void set_payload(string msg) { set_payload(binary_ref(std::move(msg))); }
    void set_qos(const int qos) { opts_.qos = qos; }
    void set_retained(bool retained) { opts_.retained = to_int(retained); }
};

using will_options_ptr = will_options::ptr_t;

using const_will_options_ptr = will_options::const_ptr_t;

// end namespace mqtt
}

#endif      // __mqtt_will_options_h