subscription.hpp

Go to the documentation of this file.

/*------------------------------------------------------------------------------
    Copyright Butterfly Energy Systems 2014-2015, 2022.
    Distributed under the Boost Software License, Version 1.0.
    http://www.boost.org/LICENSE_1_0.txt
------------------------------------------------------------------------------*/
 
#ifndef CPPWAMP_SUBSCRIPTION_HPP
#define CPPWAMP_SUBSCRIPTION_HPP
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
#include <memory>
#include <string>
#include "api.hpp"
#include "erroror.hpp"
#include "wampdefs.hpp"
#include "./internal/passkey.hpp"
 
namespace wamp
{
 
// Forward declaration
namespace internal { class Subscriber; }
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
class CPPWAMP_API Subscription
{
public:
    Subscription();
 
    Subscription(const Subscription& other);
 
    Subscription(Subscription&& other) noexcept;
 
    explicit operator bool() const;
 
    SubscriptionId id() const;
 
    Subscription& operator=(const Subscription& other);
 
    Subscription& operator=(Subscription&& other) noexcept;
 
    void unsubscribe() const;
 
private:
    using SubscriberPtr = std::weak_ptr<internal::Subscriber>;
    using SlotId = uint64_t;
 
    static constexpr SubscriptionId invalidId_ = -1;
 
    SubscriberPtr subscriber_;
    SubscriptionId subId_ = invalidId_;
    SlotId slotId_ = invalidId_;
 
public:
    // Internal use only
    Subscription(SubscriberPtr subscriber, SubscriptionId subId, SlotId slotId,
                 internal::PassKey);
    SlotId slotId(internal::PassKey) const;
};
 
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
class CPPWAMP_API ScopedSubscription : public Subscription
{
// This class is modeled after boost::signals2::scoped_connection.
public:
    ScopedSubscription();
 
    ScopedSubscription(ScopedSubscription&& other) noexcept;
 
    ScopedSubscription(Subscription subscription);
 
    ~ScopedSubscription();
 
    ScopedSubscription& operator=(ScopedSubscription&& other) noexcept;
 
    ScopedSubscription& operator=(Subscription subscription);
 
    void release();
 
    ScopedSubscription(const ScopedSubscription&) = delete;
 
    ScopedSubscription& operator=(const ScopedSubscription&) = delete;
 
private:
    using Base = Subscription;
};
 
 
} // namespace wamp
 
#ifndef CPPWAMP_COMPILED_LIB
#include "internal/subscription.ipp"
#endif
 
#endif // CPPWAMP_SUBSCRIPTION_HPP