Merge branch 'feat/pgroen/pure_virtual_public_interface' into 'development'

Feat/pgroen/pure virtual public interface See merge request !2

Merge branch 'feat/pgroen/pure_virtual_public_interface' into 'development'
Feat/pgroen/pure virtual public interface See merge request !2
Peter M. Groen
2 parents 66e26bc1 c101a0ca
Showing 53 changed files with 286 additions and 71 deletions
README.md
examples/pub/CMakeLists.txt
examples/pub/main.cpp
examples/pub/publisher.cpp
examples/sub/CMakeLists.txt
examples/sub/main.cpp
examples/sub/subscriber.cpp
examples/sub/subscriber.h
src/bimap.h → include/bimap.h
src/clientpaho.h → include/clientpaho.h
src/commondefs.h → include/commondefs.h
src/compat-c++14.h → include/compat-c++14.h
src/compat-chrono.h → include/compat-chrono.h
src/compiletimedigits.h → include/compiletimedigits.h
src/compiletimestring.h → include/compiletimestring.h
src/connectionstatus.h → include/connectionstatus.h
src/credentials.h → include/credentials.h
src/date.h → include/date.h
src/errorcode.h → include/errorcode.h
src/histogram.h → include/histogram.h
@@ -41,4 +41,115 @@ later the &quot;pub&quot; part. If all went well, you should see two screens in sync runni
    Open terminal 2
    $ bin/test_mqtt_pub
    ```
-Screen 2 is sending, Screen 1 is receiving.
 \ No newline at end of file
+Screen 2 is sending, Screen 1 is receiving.
+
+# Using the library.
+Using mqtt-cpp is pretty straight forward. No real magic is happening. Beware of the fact that the library uses the namespace :
+```
+    osdev::components::mqtt
+```
+
+## Publishing..
+To create a publisher, a simple member needs to be created.
+Header :
+```
+    #pragma once
+
+    // std
+    #include <memory>
+    #include <string>
+
+    // osdev::components::mqtt
+    #include "mqttclient.h"
+    #include "compat-c++14.h"
+
+    class Publisher
+    {
+    public:
+        Publisher(const std::string &client_id);
+
+        virtual ~Publisher() {}
+
+        void    connect( const std::string &hostname, int portnumber = 1883, const std::string &username = std::string(), const std::string &password = std::string() );
+    
+        void    publish( const std::string &message_topic, const std::string &message_payload );
+
+    private:
+        osdev::components::mqtt::MqttClient m_mqtt_client;
+    };
+```
+
+Implementation
+```
+
+    // osdev::components::mqtt
+    // #include "token.h"
+
+    // mqtt_tests
+    #include "publisher.h"
+
+    Publisher::Publisher(const std::string &client_id)
+        : m_mqtt_client( client_id )
+    {
+
+    }
+
+    void Publisher::connect( const std::string &hostname, int portnumber, const std::string &username, const std::string &password )
+    {
+        m_mqtt_client.connect( hostname, portnumber, osdev::components::mqtt::Credentials( username, password ) );
+        std::cout << "Client state : " << m_mqtt_client.state() << std::endl;
+    }
+
+    void Publisher::publish( const std::string &message_topic, const std::string &message_payload )
+    {
+        osdev::components::mqtt::MqttMessage message( message_topic, true, false, message_payload );
+        std::cout << "[Publisher::publish] - Publising message : " << message_payload << " to topic : " << message_topic << std::endl;
+        osdev::components::mqtt::Token t_result = m_mqtt_client.publish( message, 0 );
+    }
+```
+
+## Subscribing
+TO create a subscriber, a bit more work is involved. A subscription is dependant on a callback in which the data is handled to your liking. It is necessary to inherit from MqttSubscriberBase and override the "receive_data" method.
+
+subscriber.h
+```
+#pragma once
+
+// std
+#include <string>
+
+// mqtt-cpp
+#include "mqttsubscriberbase.h"
+
+class Subscriber : public MqttSubscriberBase
+{
+public:
+    Subscriber( const std::string &client_id );
+
+    virtual ~Subscriber() {}
+
+protected:
+    void receive_data( const std::string &message_topic, const std::string &message_payload );
+
+};
+```
+
+In the receive_data, the logic will be implemented to handle, decode and store the payload.
+```
+#include "subscriber.h"
+
+#include <iostream>
+
+Subscriber::Subscriber( const std::string &client_id )
+    : MqttSubscriberBase( client_id )
+{
+
+}
+
+void Subscriber::receive_data( const std::string &message_topic, const std::string &message_payload )
+{
+    std::cout << "[Subscriber::receive_data] - Received message : " << message_payload << " from topic : " << message_topic << std::endl;
+}
+```
+
+Now it will be very easy to send and receive messages from a broker without the hassle of administration.
@@ -5,7 +5,7 @@ include(projectheader)
 project_header(test_mqtt_pub)
  
 include_directories( SYSTEM
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../src
+    ${CMAKE_CURRENT_SOURCE_DIR}/../../include
 )
  
 include(compiler)
@@ -21,7 +21,7 @@ add_executable( ${PROJECT_NAME}
  
 target_link_libraries(
     ${PROJECT_NAME}
-    mqtt
+    mqtt-cpp
 )
  
 set_target_properties( ${PROJECT_NAME} PROPERTIES
@@ -83,14 +83,18 @@ int main( int argc, char* argv[] )
         // Assume we are connected now, start publishing.
         while( 1 )
         {
-            std::string payload = "<Timestamp value=\"" + std::to_string( getEpochUSecs() ) + "\" /><MessageNumber value=\"" + std::to_string( messageNumber ) + "\" />" ;
-            pPublisher->publish( std::string( "test/publisher/TestPublisher" ), payload );
-
-            sleepcp( 1, T_SECONDS );
-            if( messageNumber > 2000000000 )
-                messageNumber = -1;
-
-            messageNumber++;
+            for( unsigned int nCount = 0; nCount < 10; nCount++ )
+            {
+                std::string payload = "<Timestamp value=\"" + std::to_string( getEpochUSecs() ) + "\" /><MessageNumber value=\"" + std::to_string( messageNumber ) + "\" />" ;
+                pPublisher->publish( std::string( "test/publisher/TestPublisher_" + std::to_string( nCount ) ), payload );
+
+                if( messageNumber > 2000000000 )
+                {
+                    messageNumber = -1;
+                }
+                messageNumber++;
+            }
+            sleepcp( 1, T_MICRO );
         }
     }
     else
@@ -20,9 +20,6 @@
  * DEALINGS IN THE SOFTWARE.                                                  *
  * ***************************************************************************/
  
-// osdev::components::mqtt
-#include "token.h"
-
 // mqtt_tests
 #include "publisher.h"
  
@@ -5,7 +5,7 @@ include(projectheader)
 project_header(test_mqtt_sub)
  
 include_directories( SYSTEM
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../src
+    ${CMAKE_CURRENT_SOURCE_DIR}/../../include
 )
  
 include(compiler)
@@ -21,7 +21,7 @@ add_executable( ${PROJECT_NAME}
  
 target_link_libraries(
     ${PROJECT_NAME}
-    mqtt
+    mqtt-cpp
 )
  
 set_target_properties( ${PROJECT_NAME} PROPERTIES
@@ -71,19 +71,19 @@ int main( int argc, char* argv[] )
  
     std::cout << "Creating the subscriber : ";
     // Create the subscriber
-    Subscriber *pSubscriber = new Subscriber();
+    Subscriber *pSubscriber = new Subscriber( "Test_Subscriber" );
     if( pSubscriber != nullptr )
     {
         std::cout << "[OK]" << std::endl;
         std::cout << "Connecting to the test-broker : " << std::endl;
         pSubscriber->connect( "localhost", 1883, "", "" );
         std::cout << "Subscribing to the test-topic....." << std::endl;
-        pSubscriber->subscribe( "test/publisher/TestPublisher" );
+        pSubscriber->subscribe( "test/publisher/#" );
  
         // Start a loop to give the subscriber the possibility to do its work.
         while( 1 )
         {
-            sleepcp( 1, T_SECONDS );   // Sleep 1 Sec to give the scheduler the change to interfene.
+            sleepcp( 1, T_MICRO );   // Sleep 1 Sec to give the scheduler the change to interfene.
         }
     }
     else
@@ -20,27 +20,13 @@
  * DEALINGS IN THE SOFTWARE.                                                  *
  * ***************************************************************************/
 #include "subscriber.h"
-#include "mqttmessage.h"
-#include "credentials.h"
  
-Subscriber::Subscriber()
-    : m_mqtt_client( "TestSubscriber" )
-{
-
-}
+#include <iostream>
  
-void Subscriber::connect( const std::string &hostname, int portnumber, const std::string &username, const std::string &password )
+Subscriber::Subscriber( const std::string &client_id )
+    : MqttSubscriberBase( client_id )
 {
-    m_mqtt_client.connect( hostname, portnumber, osdev::components::mqtt::Credentials( username, password ) );
-    std::cout << "Client state : " << m_mqtt_client.state() << std::endl;
-}
  
-void Subscriber::subscribe( const std::string &message_topic )
-{
-    m_mqtt_client.subscribe( message_topic, 1, [this](const osdev::components::mqtt::MqttMessage &message)
-    {
-        this->receive_data(message.topic(), message.payload() );
-    });
 }
  
 void Subscriber::receive_data( const std::string &message_topic, const std::string &message_payload )
@@ -22,27 +22,19 @@
 #pragma once
  
 // std
-#include <memory>
 #include <string>
  
-// osdev::components::mqtt
-#include "mqttclient.h"
-#include "compat-c++14.h"
+// mqtt-cpp
+#include "mqttsubscriberbase.h"
  
-class Subscriber
+class Subscriber : public MqttSubscriberBase
 {
 public:
-    Subscriber();
+    Subscriber( const std::string &client_id );
  
     virtual ~Subscriber() {}
  
-    void connect( const std::string &hostname, int portnumber, const std::string &username, const std::string &password );
-
-    void subscribe( const std::string &message_topic );
-
-private:
+protected:
     void receive_data( const std::string &message_topic, const std::string &message_payload );
  
-private:
-    osdev::components::mqtt::MqttClient m_mqtt_client;
 };
@@ -48,7 +48,11 @@ To ceil(const std::chrono::duration&lt;Rep, Period&gt;&amp; d)
 {
     To t = std::chrono::duration_cast<To>(d);
     if (t < d)
+    {
         return t + To{ 1 };
+    }
+
+    // or else...
     return t;
 }
  
+/* ****************************************************************************
+ * Copyright 2019 Open Systems Development BV                                 *
+ *                                                                            *
+ * Permission is hereby granted, free of charge, to any person obtaining a    *
+ * copy of this software and associated documentation files (the "Software"), *
+ * to deal in the Software without restriction, including without limitation  *
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
+ * and/or sell copies of the Software, and to permit persons to whom the      *
+ * Software is furnished to do so, subject to the following conditions:       *
+ *                                                                            *
+ * The above copyright notice and this permission notice shall be included in *
+ * all copies or substantial portions of the Software.                        *
+ *                                                                            *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    *
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        *
+ * DEALINGS IN THE SOFTWARE.                                                  *
+ * ***************************************************************************/
+#pragma once
+
+// std
+#include <memory>
+#include <string>
+
+// osdev::components::mqtt
+#include "mqttclient.h"
+
+
+class MqttSubscriberBase
+{
+public:
+    /*!
+     * \brief SubscriberBase
+     */
+    MqttSubscriberBase( const std::string &client_id );
+
+    /*!
+     * \brief ~SubscriberBase
+     */
+    virtual ~MqttSubscriberBase() {}
+
+    /*!
+     * \brief getClientId
+     * \return
+     */
+    std::string getClientId() const;
+
+    /*!
+     * \brief connect
+     * \param hostname
+     * \param portnumber
+     * \param username
+     * \param password
+     */
+    void connect( const std::string &hostname, int portnumber, const std::string &username, const std::string &password );
+
+    /*!
+     * \brief subscribe
+     * \param message_topic
+     */
+    void subscribe( const std::string &message_topic );
+
+    /*!
+     * \brief disconnect
+     */
+    void disconnect();
+
+protected:
+    /*!
+     * \brief receive_data
+     * \param message_topic
+     * \param message_payload
+     */
+    virtual void receive_data( const std::string &message_topic, const std::string &message_payload ) = 0;
+
+private:
+    osdev::components::mqtt::MqttClient     m_mqtt_client;
+
+};
@@ -23,22 +23,22 @@ endif()
 # ==============================================================================
 include(projectheader)
  
-project_header(mqtt)
+project_header(mqtt-cpp)
  
 find_package( Boost REQUIRED COMPONENTS regex )
  
 include(compiler)
  
 include_directories(
-    ${CMAKE_CURRENT_SOURCE_DIR}/../logutils
+    ${CMAKE_SOURCE_DIR}/include
 )
  
 set(SRC_LIST
+    ${CMAKE_CURRENT_SOURCE_DIR}/mqttpublisherbase.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/mqttsubscriberbase.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/clientpaho.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/commondefs.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/connectionstatus.cpp
-    ${CMAKE_CURRENT_SOURCE_DIR}/compiletimedigits.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/compiletimestring.h
     ${CMAKE_CURRENT_SOURCE_DIR}/credentials.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/errorcode.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/token.cpp
@@ -59,24 +59,6 @@ set(SRC_LIST
     ${CMAKE_CURRENT_SOURCE_DIR}/sharedreaderlock.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/stringutils.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/uriparser.cpp
-    # Helper files ( Utillities )
-    ${CMAKE_CURRENT_SOURCE_DIR}/bimap.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/compat-c++14.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/compat-chrono.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/histogram.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/histogramprovider.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/imqttclient.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/imqttclientimpl.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/lockguard.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/macrodefs.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/measure.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/metaprogrammingdefs.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/mqttstream.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/stringify.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/stringutils.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/synchronizedqueue.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/utils.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/uriutils.h
 )
  
 include(library)
+/* ****************************************************************************
+ * Copyright 2019 Open Systems Development BV                                 *
+ *                                                                            *
+ * Permission is hereby granted, free of charge, to any person obtaining a    *
+ * copy of this software and associated documentation files (the "Software"), *
+ * to deal in the Software without restriction, including without limitation  *
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
+ * and/or sell copies of the Software, and to permit persons to whom the      *
+ * Software is furnished to do so, subject to the following conditions:       *
+ *                                                                            *
+ * The above copyright notice and this permission notice shall be included in *
+ * all copies or substantial portions of the Software.                        *
+ *                                                                            *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    *
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        *
+ * DEALINGS IN THE SOFTWARE.                                                  *
+ * ***************************************************************************/
+
+// osdev::components::mqtt
+#include "mqttclient.h"
+#include "mqttsubscriberbase.h"
+#include "mqttmessage.h"
+#include "credentials.h"
+
+MqttSubscriberBase::MqttSubscriberBase( const std::string &client_id )
+    : m_mqtt_client( client_id )
+{
+
+}
+
+std::string MqttSubscriberBase::getClientId() const
+{
+    return m_mqtt_client.clientId();
+}
+
+void MqttSubscriberBase::connect(const std::string &hostname, int portnumber,
+                                 const std::string &username, const std::string &password)
+{
+    m_mqtt_client.connect( hostname, portnumber, osdev::components::mqtt::Credentials( username, password ) );
+}
+
+void MqttSubscriberBase::subscribe( const std::string &message_topic )
+{
+    m_mqtt_client.subscribe( message_topic, 1, [this]( const osdev::components::mqtt::MqttMessage &message )
+    {
+        this->receive_data( message.topic(), message.payload() );
+    });
+}
+
+void MqttSubscriberBase::disconnect()
+{
+    m_mqtt_client.disconnect();
+}