Subscription.h

Go to the documentation of this file.

/*****************************************************************************
 * vim:tw=78
 *
 * Copyright (C) 2021 Richard Hacker (lerichi at gmx dot net),
 *                    Florian Pose (fp at igh dot de),
 *                    Bjarne von Horn (vh at igh dot de).
 *
 * This file is part of the PdCom library.
 *
 * The PdCom library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * The PdCom library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the PdCom library. If not, see <http://www.gnu.org/licenses/>.
 *
 ****************************************************************************/

#ifndef PDCOM5_SUBSCRIPTION_H
#define PDCOM5_SUBSCRIPTION_H

#include "DataDeserializer.h"
#include "Exception.h"
#include "Selector.h"
#include "Variable.h"
#include "details.h"

#include <memory>
#include <pdcom5_export.h>
#include <string>
#include <vector>

namespace PdCom {

namespace impl {
class Subscription;
}  // namespace impl

class Process;
class Variable;
class Subscriber;

class PDCOM5_PUBLIC Subscription : public DataDeserializer<Subscription>
{
  public:
    enum class State {
        Invalid = 0,
        Pending,
        Active,
    };

    Subscription() = default;
    Subscription(Subscription &&) noexcept;
    Subscription &operator=(Subscription &&) noexcept;

    Subscription(
            Subscriber &subscriber,
            const Variable &variable,
            const Selector &selector = {});

    Subscription(
            Subscriber &subscriber,
            Process &process,
            const std::string &path,
            const Selector &selector = {});

    void poll();

    const void *getData() const;

    Variable getVariable() const;

    void print(std::ostream &os, char delimiter) const;

    bool empty() const noexcept { return !(pimpl); }

    State getState() const noexcept { return state_; }

    Process *getProcess() const;

    std::string getPath() const;

  private:
    friend impl::Subscription;

    std::shared_ptr<impl::Subscription> pimpl = {};

    State state_ = State::Invalid;
};

}  // namespace PdCom

#endif  // PDCOM5_SUBSCRIPTION_H