graceful shutdown costumized target

Author: kamalnadjieb

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.1)
 ## PROJECT
 ## name and version
 ##
-project(nadjieb_mjpeg_streamer VERSION 1.0.0 LANGUAGES CXX)
+project(nadjieb_mjpeg_streamer VERSION 1.1.0 LANGUAGES CXX)
 
 ##
 ## DEPENDENCIES

README.md

@@ -5,7 +5,7 @@
 * Set different streams depending on HTTP GET path
 * Multi-threaded streaming
 * Single Header-only library
-* graceful shutdown
+* Graceful shutdown
 
 ## CMake Integration
 ### External
@@ -50,11 +50,18 @@ int main()
     std::vector<int> params = {cv::IMWRITE_JPEG_QUALITY, 90};
 
     MJPEGStreamer streamer(8080);
-    // By default 1 worker is used for streaming, if you want to use 4 workers
-    // MJPEGStreamer streamer(8080, 4);
+    // By default 1 worker is used for streaming
+    // if you want to use 4 workers:
+    //      MJPEGStreamer streamer(8080, 4);
+
+    // By default /shutdown is the target to graceful shutdown the streamer
+    // if you want to change target to graceful shutdown:
+    //      streamer.setShutdownTarget("/stop");
 
     streamer.start();
-    while (true)
+
+    // Visit /shutdown or another defined target to stop the loop and graceful shutdown
+    while (streamer.isAlive())
     {
         cv::Mat frame;
         cap >> frame;
@@ -76,13 +83,8 @@ int main()
         std::vector<uchar> buff_hsv;
         cv::imencode(".jpg", hsv, buff_hsv, params);
         streamer.publish("/hsv", std::string(buff_hsv.begin(), buff_hsv.end()));
-    
-        // Visit /shutdown to break from the loop and graceful shutdown
-        if (streamer.shutdownFromBrowser())
-        {
-            break;
-        }
     }
+
     streamer.stop();
 }
 ```

examples/example.cpp

@@ -17,11 +17,18 @@ int main()
     std::vector<int> params = {cv::IMWRITE_JPEG_QUALITY, 90};
 
     MJPEGStreamer streamer(8080);
-    // By default 1 worker is used for streaming, if you want to use 4 workers
-    // MJPEGStreamer streamer(8080, 4);
+    // By default 1 worker is used for streaming
+    // if you want to use 4 workers:
+    //      MJPEGStreamer streamer(8080, 4);
+
+    // By default /shutdown is the target to graceful shutdown the streamer
+    // if you want to change target to graceful shutdown:
+    //      streamer.setShutdownTarget("/stop");
 
     streamer.start();
-    while (true)
+
+    // Visit /shutdown or another defined target to stop the loop and graceful shutdown
+    while (streamer.isAlive())
     {
         cv::Mat frame;
         cap >> frame;
@@ -43,12 +50,7 @@ int main()
         std::vector<uchar> buff_hsv;
         cv::imencode(".jpg", hsv, buff_hsv, params);
         streamer.publish("/hsv", std::string(buff_hsv.begin(), buff_hsv.end()));
-    
-        // Visit /shutdown to break from the loop and graceful shutdown
-        if (streamer.shutdownFromBrowser())
-        {
-            break;
-        }
     }
+
     streamer.stop();
 }

include/nadjieb/mjpeg_streamer.hpp

@@ -45,6 +45,23 @@ SOFTWARE.
 #include <utility>
 #include <vector>
 
+/// The major version number
+#define NADJIEB_MJPEG_STREAMER_VERSION_MAJOR 1
+
+/// The minor version number
+#define NADJIEB_MJPEG_STREAMER_VERSION_MINOR 1
+
+/// The patch number
+#define NADJIEB_MJPEG_STREAMER_VERSION_PATCH 0
+
+/// The complete version number
+#define NADJIEB_MJPEG_STREAMER_VERSION_CODE                                                                            \
+    (NADJIEB_MJPEG_STREAMER_VERSION_MAJOR * 10000 + NADJIEB_MJPEG_STREAMER_VERSION_MINOR * 100 +                       \
+     NADJIEB_MJPEG_STREAMER_VERSION_PATCH)
+
+/// Version number as string
+#define NADJIEB_MJPEG_STREAMER_VERSION_STRING "10100"
+
 namespace nadjieb
 {
 constexpr int NUM_SEND_MUTICES = 100;
@@ -57,7 +74,8 @@ class MJPEGStreamer
     void start();
     void stop();
     void publish(const std::string &path, const std::string &buffer);
-    bool shutdownFromBrowser();
+    void setShutdownTarget(const std::string &target);
+    bool isAlive();
 
   private:
     struct Payload
@@ -70,8 +88,8 @@ class MJPEGStreamer
     int port_;
     int master_socket_ = -1;
     int num_workers_;
-    bool shutdownFlag = false;
     struct sockaddr_in address_;
+    std::string shutdown_target_ = "/shutdown";
 
     std::thread thread_listener_;
     std::mutex clients_mutex_;
@@ -128,7 +146,7 @@ void MJPEGStreamer::start()
     for (auto i = 0; i < num_workers_; ++i)
     {
         workers_.emplace_back([this]() {
-            while (this->master_socket_ > 0)
+            while (this->isAlive())
             {
                 Payload payload;
 
@@ -190,7 +208,7 @@ void MJPEGStreamer::start()
         to.tv_sec = 1;
         to.tv_usec = 0;
 
-        while (this->master_socket_ > 0)
+        while (this->isAlive())
         {
             FD_SET(this->master_socket_, &fd);
 
@@ -207,19 +225,19 @@ void MJPEGStreamer::start()
                 std::string req(4096, 0);
                 ::read(new_socket, &req[0], req.size());
 
-                std::string path;
-                if (!req.empty())
+                if (req.empty())
                 {
-                    path = req.substr(req.find("GET") + 4, req.find("HTTP/") - req.find("GET") - 5);
-                
-                    if (path == "/shutdown")
-                    {
-                        shutdownFlag = true;
-                    }
+                    ::close(new_socket);
+                    continue;
                 }
-                else
+
+                auto path = req.substr(req.find("GET") + 4, req.find("HTTP/") - req.find("GET") - 5);
+                if (path == this->shutdown_target_)
                 {
                     ::close(new_socket);
+                    std::unique_lock<std::mutex> lock(this->payloads_mutex_);
+                    this->master_socket_ = -1;
+                    this->condition_.notify_all();
                     continue;
                 }
 
@@ -239,7 +257,7 @@ void MJPEGStreamer::start()
 
 void MJPEGStreamer::stop()
 {
-    if (master_socket_ > 0)
+    if (isAlive())
     {
         std::unique_lock<std::mutex> lock(payloads_mutex_);
         master_socket_ = -1;
@@ -288,18 +306,22 @@ void MJPEGStreamer::publish(const std::string &path, const std::string &buffer)
         clients = path2clients_[path];
     }
 
+    for (auto i : path2clients_[path])
     {
-        for (auto i : path2clients_[path])
-        {
-            std::unique_lock<std::mutex> lock(payloads_mutex_);
-            payloads_.emplace(Payload({buffer, path, i}));
-            condition_.notify_one();
-        }
+        std::unique_lock<std::mutex> lock(payloads_mutex_);
+        payloads_.emplace(Payload({buffer, path, i}));
+        condition_.notify_one();
     }
 }
 
-bool MJPEG_streamer_module::shutdownFromBrowser()
+void MJPEGStreamer::setShutdownTarget(const std::string &target)
+{
+    shutdown_target_ = target;
+}
+
+bool MJPEGStreamer::isAlive()
 {
-    return shutdownFlag;
+    std::unique_lock<std::mutex> lock(payloads_mutex_);
+    return master_socket_ > 0;
 }
 } // namespace nadjieb