WIP: ideas for refactoring repository and subscriptions

Author: thg2k

src/Contracts/Repository.php

@@ -34,37 +34,29 @@ interface Repository
      */
     public function newMessageId(): int;
 
-    /**
-     * Releases the given message id, allowing it to be reused in the future.
-     *
-     * @param int $messageId
-     * @return void
-     */
-    public function releaseMessageId(int $messageId): void;
-
     /**
      * Returns the number of registered topic subscriptions. The method does
      * not differentiate between pending and acknowledged subscriptions.
      *
      * @return int
      */
-    public function countTopicSubscriptions(): int;
+    public function countSubscriptions(): int;
 
     /**
      * Adds a topic subscription to the repository.
      *
      * @param TopicSubscription $subscription
      * @return void
      */
-    public function addTopicSubscription(TopicSubscription $subscription): void;
+    public function addSubscription(TopicSubscription $subscription): void;
 
     /**
      * Get all topic subscriptions with the given message identifier.
      *
      * @param int $messageId
      * @return TopicSubscription[]
      */
-    public function getTopicSubscriptionsWithMessageId(int $messageId): array;
+    public function getSubscriptionsWithMessageId(int $messageId): array;
 
     /**
      * Find a topic subscription with the given topic.
@@ -90,7 +82,7 @@ public function getTopicSubscriptionsMatchingTopic(string $topic): array;
      * @param string $topic
      * @return bool
      */
-    public function removeTopicSubscription(string $topic): bool;
+    public function removeSubscription(string $topic): bool;
 
     /**
      * Returns the number of pending publish messages.
@@ -115,40 +107,55 @@ public function addPendingPublishedMessage(PublishedMessage $message): void;
      */
     public function getPendingPublishedMessageWithMessageId(int $messageId): ?PublishedMessage;
 
+
+
+
+
+
+
+
+
+
     /**
-     * Gets a list of pending published messages last sent before the given date time.
+     * Returns the number of pending unsubscribe requests.
      *
-     * @param DateTime $dateTime
-     * @return PublishedMessage[]
+     * @return int
      */
-    public function getPendingPublishedMessagesLastSentBefore(DateTime $dateTime): array;
+    public function countPendingOutgoingMessages(): int;
 
     /**
-     * Marks the pending published message with the given message identifier as received.
-     * If the message has no QoS level of 2, is not found or has already been received,
-     * false is returned. Otherwise the result will be true.
+     * Gets a list of pending outgoing messages last sent before the given date time.
      *
-     * @param int $messageId
-     * @return bool
+     * @param DateTime $dateTime
+     * @return PublishedMessage[]
      */
-    public function markPendingPublishedMessageAsReceived(int $messageId): bool;
+    public function getPendingOutgoingMessagesLastSentBefore(DateTime $dateTime): array;
+
 
     /**
-     * Removes a pending published message from the repository. If a pending message
-     * with the given identifier is found and successfully removed from the repository,
-     * `true` is returned. Otherwise `false` will be returned.
+     * Returns the number of pending publish confirmations.
      *
-     * @param int $messageId
-     * @return bool
+     * @return int
      */
-    public function removePendingPublishedMessage(int $messageId): bool;
+    public function countPendingPublishConfirmations(): int;
+
+
+
+
+
+
+
+
 
     /**
-     * Returns the number of pending unsubscribe requests.
+     * Marks the pending published message with the given message identifier as received.
+     * If the message has no QoS level of 2, is not found or has already been received,
+     * false is returned. Otherwise the result will be true.
      *
-     * @return int
+     * @param int $messageId
+     * @return bool
      */
-    public function countPendingUnsubscribeRequests(): int;
+    public function markPendingPublishedMessageAsReceived(int $messageId): bool;
 
     /**
      * Adds a pending unsubscribe request to the repository.
@@ -166,13 +173,28 @@ public function addPendingUnsubscribeRequest(UnsubscribeRequest $request): void;
      */
     public function getPendingUnsubscribeRequestWithMessageId(int $messageId): ?UnsubscribeRequest;
 
+
     /**
-     * Gets a list of pending unsubscribe requests last sent before the given date time.
+     * Adds a pending publish confirmation to the repository.
      *
-     * @param DateTime $dateTime
-     * @return UnsubscribeRequest[]
+     * @param PublishedMessage $message
+     * @return void
+     * @throws PendingPublishConfirmationAlreadyExistsException
+     */
+    public function addPendingPublishConfirmation(PublishedMessage $message): void;
+
+    /**
+     * Gets a pending publish confirmation with the given message identifier, if found.
+     *
+     * @param int $messageId
+     * @return PublishedMessage|null
      */
-    public function getPendingUnsubscribeRequestsLastSentBefore(DateTime $dateTime): array;
+    public function getPendingPublishConfirmationWithMessageId(int $messageId): ?PublishedMessage;
+
+
+
+
+
 
     /**
      * Removes a pending unsubscribe requests from the repository. If a pending request
@@ -184,29 +206,16 @@ public function getPendingUnsubscribeRequestsLastSentBefore(DateTime $dateTime):
      */
     public function removePendingUnsubscribeRequest(int $messageId): bool;
 
-    /**
-     * Returns the number of pending publish confirmations.
-     *
-     * @return int
-     */
-    public function countPendingPublishConfirmations(): int;
-
-    /**
-     * Adds a pending publish confirmation to the repository.
-     *
-     * @param PublishedMessage $message
-     * @return void
-     * @throws PendingPublishConfirmationAlreadyExistsException
-     */
-    public function addPendingPublishConfirmation(PublishedMessage $message): void;
 
     /**
-     * Gets a pending publish confirmation with the given message identifier, if found.
+     * Removes a pending published message from the repository. If a pending message
+     * with the given identifier is found and successfully removed from the repository,
+     * `true` is returned. Otherwise `false` will be returned.
      *
      * @param int $messageId
-     * @return PublishedMessage|null
+     * @return bool
      */
-    public function getPendingPublishConfirmationWithMessageId(int $messageId): ?PublishedMessage;
+    public function removePendingPublishedMessage(int $messageId): bool;
 
     /**
      * Removes the pending publish confirmation with the given message identifier

src/Exceptions/PendingMessageAlreadyExistsException.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMqtt\Client\Exceptions;
+
+/**
+ * Exception to be thrown if a pending message with the same packet identifier is still pending.
+ *
+ * @package PhpMqtt\Client\Exceptions
+ */
+class PendingMessageAlreadyExistsException extends MqttClientException
+{
+    /**
+     * PendingMessageAlreadyExistsException constructor.
+     *
+     * @param int $messageId
+     */
+    public function __construct(int $messageId)
+    {
+        parent::__construct(sprintf('A pending message with the message identifier [%s] exists already.', $messageId));
+    }
+}