Rename "subscriber" to "subscription" (#204)

Signed-off-by: Christophe Bedard <[email protected]>

Author: christophebedard

email/CMakeLists.txt

@@ -56,7 +56,7 @@ set(SOURCES
   src/service_handler.cpp
   src/service_info.cpp
   src/service_server.cpp
-  src/subscriber.cpp
+  src/subscription.cpp
   src/subscription_handler.cpp
   src/timestamp.cpp
   src/utils.cpp

email/include/email/subscriber.hpp renamed to email/include/email/subscription.hpp

@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef EMAIL__SUBSCRIBER_HPP_
-#define EMAIL__SUBSCRIBER_HPP_
+#ifndef EMAIL__SUBSCRIPTION_HPP_
+#define EMAIL__SUBSCRIPTION_HPP_
 
 #include <chrono>
 #include <memory>
@@ -33,25 +33,25 @@
 namespace email
 {
 
-/// Message subscriber.
+/// Message subscription.
 /**
  * Uses emails, with the topic name as the email subject and the data as the email body.
  * TODO(christophebedard) add take to get a vector of all available messages?
  */
-class Subscriber : public PubSubObject
+class Subscription : public PubSubObject
 {
 public:
   /// Constructor.
   /**
    * \param topic_name the topic name to subscribe to
    */
   EMAIL_PUBLIC
-  explicit Subscriber(const std::string & topic_name);
+  explicit Subscription(const std::string & topic_name);
 
   EMAIL_PUBLIC
-  virtual ~Subscriber();
+  virtual ~Subscription();
 
-  /// Check if the subscriber has a message.
+  /// Check if the subscription has a message.
   /**
    * \return true if there is a message, false otherwise
    */
@@ -80,12 +80,12 @@ class Subscriber : public PubSubObject
   get_message_with_info();
 
 private:
-  EMAIL_DISABLE_COPY(Subscriber)
+  EMAIL_DISABLE_COPY(Subscription)
 
   std::shared_ptr<Logger> logger_;
-  SubscriptionHandler::SubscriberQueue::SharedPtr messages_;
+  SubscriptionHandler::SubscriptionQueue::SharedPtr messages_;
 };
 
 }  // namespace email
 
-#endif  // EMAIL__SUBSCRIBER_HPP_
+#endif  // EMAIL__SUBSCRIPTION_HPP_

email/include/email/subscription_handler.hpp

@@ -33,35 +33,35 @@ namespace email
 
 /// Email handler for subscriptions.
 /**
- * Distributes new messages to the right subscriber(s).
+ * Distributes new messages to the right subscription(s).
  */
 class SubscriptionHandler
 {
 public:
-  using SubscriberQueue = SafeQueue<std::pair<std::string, MessageInfo>>;
+  using SubscriptionQueue = SafeQueue<std::pair<std::string, MessageInfo>>;
 
   /// Constructor.
   SubscriptionHandler();
 
   ~SubscriptionHandler();
 
-  /// Register a subscriber with the handler.
+  /// Register a subscription with the handler.
   /**
-   * New messages will be added to the subscriber's queue if the topic name matches.
+   * New messages will be added to the subscription's queue if the topic name matches.
    *
    * \param topic_name the topic name
-   * \param message_queue the subscriber's message queue to push the new message to
+   * \param message_queue the subscription's message queue to push the new message to
    */
   void
-  register_subscriber(
+  register_subscription(
     const std::string & topic_name,
-    SubscriberQueue::SharedPtr message_queue);
+    SubscriptionQueue::SharedPtr message_queue);
 
   /// Handle new email.
   /**
    * To be called by the `PollingManager`.
    *
-   * Adds the message to the queues of subscribers with topic names that match the new message.
+   * Adds the message to the queues of subscriptions with topic names that match the new message.
    *
    * \param data the new email data
    */
@@ -72,8 +72,8 @@ class SubscriptionHandler
   EMAIL_DISABLE_COPY(SubscriptionHandler)
 
   std::shared_ptr<Logger> logger_;
-  std::mutex subscribers_mutex_;
-  std::multimap<std::string, SubscriberQueue::SharedPtr> subscribers_;
+  std::mutex subscriptions_mutex_;
+  std::multimap<std::string, SubscriptionQueue::SharedPtr> subscriptions_;
 };
 
 }  // namespace email

email/include/email/wait.hpp

@@ -24,7 +24,7 @@
 #include "email/service_client.hpp"
 #include "email/service_request.hpp"
 #include "email/service_server.hpp"
-#include "email/subscriber.hpp"
+#include "email/subscription.hpp"
 #include "email/visibility_control.hpp"
 
 namespace email
@@ -42,17 +42,17 @@ namespace email
 EMAIL_PUBLIC
 std::pair<std::string, MessageInfo>
 wait_for_message_with_info(
-  Subscriber * subscription,
+  Subscription * subscription,
   const std::chrono::milliseconds timeout = std::chrono::milliseconds(-1));
 
 /// Get a message with info from a subscription, waiting until one is available.
 /**
- * \see wait_for_message(std::shared_ptr<Subscriber>, const std::chrono::milliseconds)
+ * \see wait_for_message(std::shared_ptr<Subscription>, const std::chrono::milliseconds)
  */
 EMAIL_PUBLIC
 std::pair<std::string, MessageInfo>
 wait_for_message_with_info(
-  std::shared_ptr<Subscriber> subscription,
+  std::shared_ptr<Subscription> subscription,
   const std::chrono::milliseconds timeout = std::chrono::milliseconds(-1));
 
 /// Get a message from a subscription, waiting until one is available.
@@ -67,17 +67,17 @@ wait_for_message_with_info(
 EMAIL_PUBLIC
 std::string
 wait_for_message(
-  Subscriber * subscription,
+  Subscription * subscription,
   const std::chrono::milliseconds timeout = std::chrono::milliseconds(-1));
 
 /// Get a message from a subscription, waiting until one is available.
 /**
- * \see wait_for_message(std::shared_ptr<Subscriber>, const std::chrono::milliseconds)
+ * \see wait_for_message(std::shared_ptr<Subscription>, const std::chrono::milliseconds)
  */
 EMAIL_PUBLIC
 std::string
 wait_for_message(
-  std::shared_ptr<Subscriber> subscription,
+  std::shared_ptr<Subscription> subscription,
   const std::chrono::milliseconds timeout = std::chrono::milliseconds(-1));
 
 /// Get a service reponse with info, waiting until it is available.

email/include/email/wait_set.hpp

@@ -23,7 +23,7 @@
 #include "email/guard_condition.hpp"
 #include "email/service_client.hpp"
 #include "email/service_server.hpp"
-#include "email/subscriber.hpp"
+#include "email/subscription.hpp"
 #include "email/macros.hpp"
 #include "email/visibility_control.hpp"
 
@@ -41,14 +41,14 @@ class WaitSet
   /// Constructor.
   EMAIL_PUBLIC
   WaitSet(
-    std::vector<Subscriber *> subscriptions = {},
+    std::vector<Subscription *> subscriptions = {},
     std::vector<ServiceClient *> clients = {},
     std::vector<ServiceServer *> servers = {},
     std::vector<GuardCondition *> guard_conditions = {});
 
   /// Constructor.
   EMAIL_PUBLIC
-  explicit WaitSet(Subscriber * subscription);
+  explicit WaitSet(Subscription * subscription);
 
   EMAIL_PUBLIC
   ~WaitSet();
@@ -78,7 +78,7 @@ class WaitSet
   /// Add a subscription.
   EMAIL_PUBLIC
   void
-  add_subscription(Subscriber * subscription);
+  add_subscription(Subscription * subscription);
 
   /// Add a client.
   EMAIL_PUBLIC
@@ -97,7 +97,7 @@ class WaitSet
 
   /// Get the subscriptions.
   EMAIL_PUBLIC
-  const std::vector<Subscriber *> &
+  const std::vector<Subscription *> &
   get_subscriptions() const;
 
   /// Get the clients.
@@ -156,7 +156,7 @@ class WaitSet
     std::chrono::steady_clock::time_point start);
 
   std::shared_ptr<Logger> logger_;
-  std::vector<Subscriber *> subscriptions_;
+  std::vector<Subscription *> subscriptions_;
   std::vector<ServiceClient *> clients_;
   std::vector<ServiceServer *> servers_;
   std::vector<GuardCondition *> guard_conditions_;

email/src/subscriber.cpp renamed to email/src/subscription.cpp

@@ -24,37 +24,37 @@
 #include "email/message_info.hpp"
 #include "email/pub_sub.hpp"
 #include "email/safe_queue.hpp"
-#include "email/subscriber.hpp"
+#include "email/subscription.hpp"
 #include "email/subscription_handler.hpp"
 
 namespace email
 {
 
-Subscriber::Subscriber(const std::string & topic_name)
+Subscription::Subscription(const std::string & topic_name)
 : PubSubObject(topic_name),
-  logger_(log::get_or_create("Subscriber::" + topic_name)),
-  messages_(std::make_shared<SubscriptionHandler::SubscriberQueue>())
+  logger_(log::get_or_create("Subscription::" + topic_name)),
+  messages_(std::make_shared<SubscriptionHandler::SubscriptionQueue>())
 {
   logger_->debug("created with GID: {}", get_gid());
   // Register with handler
-  get_global_context()->get_subscription_handler()->register_subscriber(
+  get_global_context()->get_subscription_handler()->register_subscription(
     get_topic_name(),
     messages_);
 }
 
-Subscriber::~Subscriber()
+Subscription::~Subscription()
 {
   logger_->debug("destroying");
 }
 
 bool
-Subscriber::has_message() const
+Subscription::has_message() const
 {
   return !messages_->empty();
 }
 
 std::optional<std::string>
-Subscriber::get_message()
+Subscription::get_message()
 {
   if (!has_message()) {
     return std::nullopt;
@@ -63,7 +63,7 @@ Subscriber::get_message()
 }
 
 std::optional<std::pair<std::string, MessageInfo>>
-Subscriber::get_message_with_info()
+Subscription::get_message_with_info()
 {
   if (!has_message()) {
     return std::nullopt;

email/src/subscription_handler.cpp

@@ -31,8 +31,8 @@ namespace email
 
 SubscriptionHandler::SubscriptionHandler()
 : logger_(log::create("SubscriptionHandler")),
-  subscribers_mutex_(),
-  subscribers_()
+  subscriptions_mutex_(),
+  subscriptions_()
 {
   // Register handler with the polling manager
   get_global_context()->get_polling_manager()->register_handler(
@@ -49,13 +49,13 @@ SubscriptionHandler::~SubscriptionHandler()
 }
 
 void
-SubscriptionHandler::register_subscriber(
+SubscriptionHandler::register_subscription(
   const std::string & topic_name,
-  SubscriberQueue::SharedPtr message_queue)
+  SubscriptionQueue::SharedPtr message_queue)
 {
   {
-    std::scoped_lock<std::mutex> lock(subscribers_mutex_);
-    subscribers_.insert({topic_name, message_queue});
+    std::scoped_lock<std::mutex> lock(subscriptions_mutex_);
+    subscriptions_.insert({topic_name, message_queue});
   }
   logger_->debug("subscription registered with topic name: {}", topic_name);
 }
@@ -75,8 +75,8 @@ SubscriptionHandler::handle(const struct EmailData & data)
 
   // Push it to the right queue
   {
-    std::scoped_lock<std::mutex> lock(subscribers_mutex_);
-    auto range = subscribers_.equal_range(topic);
+    std::scoped_lock<std::mutex> lock(subscriptions_mutex_);
+    auto range = subscriptions_.equal_range(topic);
     for (auto it = range.first; it != range.second; ++it) {
       // Push message content to the queue
       logger_->debug("adding message to subscription queue with topic: {}", topic);

email/src/wait.cpp

@@ -23,15 +23,15 @@
 #include "email/service_info.hpp"
 #include "email/service_request.hpp"
 #include "email/service_server.hpp"
-#include "email/subscriber.hpp"
+#include "email/subscription.hpp"
 #include "email/wait_set.hpp"
 
 namespace email
 {
 
 std::pair<std::string, MessageInfo>
 wait_for_message_with_info(
-  Subscriber * subscription,
+  Subscription * subscription,
   const std::chrono::milliseconds timeout)
 {
   email::WaitSet waitset({subscription});
@@ -43,23 +43,23 @@ wait_for_message_with_info(
 
 std::pair<std::string, MessageInfo>
 wait_for_message_with_info(
-  std::shared_ptr<Subscriber> subscription,
+  std::shared_ptr<Subscription> subscription,
   const std::chrono::milliseconds timeout)
 {
   return wait_for_message_with_info(subscription.get(), timeout);
 }
 
 std::string
 wait_for_message(
-  Subscriber * subscription,
+  Subscription * subscription,
   const std::chrono::milliseconds timeout)
 {
   return wait_for_message_with_info(subscription, timeout).first;
 }
 
 std::string
 wait_for_message(
-  std::shared_ptr<Subscriber> subscription,
+  std::shared_ptr<Subscription> subscription,
   const std::chrono::milliseconds timeout)
 {
   return wait_for_message(subscription.get(), timeout);