Added documentation to the producer api

CMakeLists.txt

@@ -20,7 +20,7 @@ include(astyle)
 include(testing_cpp)
 
 add_subdirectory(common/cpp)
-add_subdirectory(producer/api)
+add_subdirectory(producer)
 add_subdirectory(worker/api/cpp)
 add_subdirectory(receiver)
 

producer/CMakeLists.txt

-#add_subdirectory(inotify-event-detector-cpp)
+add_subdirectory(api)

producer/api/include/producer/producer.h

@@ -27,15 +27,28 @@ enum class ProducerStatus {
 
 class Producer {
   public:
+    //! Creates a new producer
     static std::unique_ptr<Producer> create();
 
-    //virtual ~Producer() = 0;
+    virtual ~Producer() = default;
 
     virtual uint64_t GetVersion() const = 0;
     virtual ProducerStatus GetStatus() const = 0;
 
+    //! Connects to a receiver
+    /*!
+      \param receiver_address - The address of the receiver. E.g. 127.0.0.1:4200
+      \return ProducerError - Will be ProducerError::kNoError on success
+    */
     virtual ProducerError ConnectToReceiver(const std::string& receiver_address) = 0;
-    virtual ProducerError Send(uint64_t file_id, void* data, size_t file_size) = 0;
+    //! Sends data to the receiver
+    /*!
+      \param file_id - The id of the file. An error will be returned if this file id already exists on the receiver.
+      \param data - A pointer to the data to send
+      \param file_size - The size of the data.
+      \return ProducerError - Will be ProducerError::kNoError on success
+    */
+    virtual ProducerError Send(uint64_t file_id, const void* data, size_t file_size) = 0;
 };
 }
 

producer/api/src/producer_impl.cpp

@@ -65,7 +65,7 @@ hidra2::ProducerError hidra2::ProducerImpl::ConnectToReceiver(const std::string&
     return ProducerError::kNoError;
 }
 
-hidra2::ProducerError hidra2::ProducerImpl::Send(uint64_t file_id, void* data, size_t file_size) {
+hidra2::ProducerError hidra2::ProducerImpl::Send(uint64_t file_id, const void* data, size_t file_size) {
     if(status_ != ProducerStatus::kConnected) {
         return ProducerError::kConnectionNotReady;
     }

producer/api/src/producer_impl.h

@@ -29,7 +29,7 @@ class ProducerImpl : public Producer, public HasIO {
     uint64_t GetVersion() const override;
     ProducerStatus GetStatus() const override;
     ProducerError ConnectToReceiver(const std::string& receiver_address) override;
-    ProducerError Send(uint64_t file_id, void* data, size_t file_size) override;
+    ProducerError Send(uint64_t file_id, const void* data, size_t file_size) override;
 
 };
 }