Implement timeout tool argument (#254)

* Implement timeout

Signed-off-by: jparisu <javierparis@eprosima.com>

* Add RTD documentation

Signed-off-by: jparisu <javierparis@eprosima.com>

* uncrustify

Signed-off-by: jparisu <javierparis@eprosima.com>

Author: jparisu

docs/rst/notes/forthcoming_version.rst

@@ -2,8 +2,13 @@
 .. todo:
     remove orphan tag when new info added to this file
 
-:orphan:
+    :orphan:
 
 ###################
 Forthcoming Version
 ###################
+
+Next version will add the following **features**:
+
+    - Timeout argument ``--timeout`` to close the application after the time set has passed.
+      Check section :ref:`user_manual_user_interface_timeout_argument` for more information.

docs/rst/notes/notes.rst

@@ -6,6 +6,8 @@
     uncomment the include of forthcoming when new info is added
     .. include:: forthcoming_version.rst
 
+.. include:: forthcoming_version.rst
+
 ##############
 Version v0.4.0
 ##############

docs/rst/user_manual/user_interface.rst

@@ -90,7 +90,7 @@ It shows the usage information of the application.
                         Value 0 does not reload file. [Default: 0].
       -d --debug        Activate debug Logs (be aware that some logs may require specific CMAKE compilation options).
       -v --version      Print version, branch and commit hash.
-
+      -t --timeout      Set a maximum time in seconds for the Router to run. Value 0 does not set maximum. [Default: 0].
 
 .. _user_manual_user_interface_configuration_file_argument:
 
@@ -134,6 +134,17 @@ Version Argument
 It shows the current version of the DDS Router and the hash of the last commit of the compiled code.
 
 
+.. _user_manual_user_interface_timeout_argument:
+
+Timeout Argument
+^^^^^^^^^^^^^^^^
+
+This argument allow to set a maximum time while the application will be running.
+Setting this argument will set the number of seconds the application will run until it is killed.
+While the application is waiting for timeout, it is still possible to kill it via signal.
+Default value ``0`` means that the application will run forever (until kill via signal).
+
+
 .. _user_manual_user_interface_configuration_file:
 
 Configuration File
@@ -208,3 +219,9 @@ SIGTERM
 Send an interruption ``SIGTERM`` signal *(signal value 15)* to the process.
 Write command ``kill <pid>`` in a different terminal, where ``<pid>`` is the id of the process running the |ddsrouter|.
 Use ``ps`` or ``top`` programs to check the process ids.
+
+TIMEOUT
+^^^^^^^
+
+Setting a maximum amount of seconds that the application will work using argument ``--timeout`` will close the
+application once the time has expired.

tools/ddsrouter_tool/src/cpp/main.cpp

@@ -47,12 +47,15 @@ int main(
     // Reload time
     utils::Duration_ms reload_time = 0;
 
+    // Maximum timeout
+    utils::Duration_ms timeout = 0;
+
     // Debug option active
     bool activate_debug = false;
 
     // Parse arguments
     ui::ProcessReturnCode arg_parse_result =
-            ui::parse_arguments(argc, argv, file_path, reload_time, activate_debug);
+            ui::parse_arguments(argc, argv, file_path, reload_time, activate_debug, timeout);
 
     if (arg_parse_result == ui::ProcessReturnCode::help_argument)
     {
@@ -105,14 +108,26 @@ int main(
     // Encapsulating execution in block to erase all memory correctly before closing process
     try
     {
-        // First of all, create signal handler so SIGINT and SIGTERM do not break the program while initializing
-        event::MultipleEventHandler signal_handlers;
+        // Create a multiple event handler that handles all events that make the router stop
+        event::MultipleEventHandler close_handler;
 
-        signal_handlers.register_event_handler<event::EventHandler<event::Signal>, event::Signal>(
+        // First of all, create signal handler so SIGINT and SIGTERM do not break the program while initializing
+        close_handler.register_event_handler<event::EventHandler<event::Signal>, event::Signal>(
             std::make_unique<event::SignalEventHandler<event::Signal::sigint>>());     // Add SIGINT
-        signal_handlers.register_event_handler<event::EventHandler<event::Signal>, event::Signal>(
+        close_handler.register_event_handler<event::EventHandler<event::Signal>, event::Signal>(
             std::make_unique<event::SignalEventHandler<event::Signal::sigterm>>());    // Add SIGTERM
 
+        // If it must be a maximum time, register a periodic handler to finish handlers
+        if (timeout > 0)
+        {
+            close_handler.register_event_handler<event::PeriodicEventHandler>(
+                std::make_unique<event::PeriodicEventHandler>(
+                    []()
+                    {
+                        /* Do nothing */ },
+                    timeout));
+        }
+
         /////
         // DDS Router Initialization
 
@@ -193,9 +208,9 @@ int main(
         logUser(DDSROUTER_EXECUTION, "DDS Router running.");
 
         // Wait until signal arrives
-        signal_handlers.wait_for_event();
+        close_handler.wait_for_event();
 
-        logUser(DDSROUTER_EXECUTION, "Signal received, stopping DDS Router.");
+        logUser(DDSROUTER_EXECUTION, "Stopping DDS Router.");
 
         // Before stopping the Router erase event handlers that reload configuration
         if (periodic_handler)

tools/ddsrouter_tool/src/cpp/user_interface/arguments_configuration.cpp

@@ -96,6 +96,16 @@ const option::Descriptor usage[] = {
         "  -v \t--version\t  \t" \
         "Print version, branch and commit hash." \
     },
+    {
+        optionIndex::TIMEOUT,
+        0,
+        "t",
+        "timeout",
+        Arg::Numeric,
+        "  -t \t--timeout\t  \t" \
+        "Set a maximum time in seconds for the Router to run. " \
+        "Value 0 does not set maximum. [Default: 0]."
+    },
 
     { 0, 0, 0, 0, 0, 0 }
 };
@@ -111,7 +121,8 @@ ProcessReturnCode parse_arguments(
         char** argv,
         std::string& file_path,
         utils::Duration_ms& reload_time,
-        bool& activate_debug)
+        bool& activate_debug,
+        utils::Duration_ms& timeout)
 {
     // Variable to pretty print usage help
     int columns;
@@ -188,6 +199,10 @@ ProcessReturnCode parse_arguments(
                     activate_debug = true;
                     break;
 
+                case optionIndex::TIMEOUT:
+                    timeout = std::stol(opt.arg) * 1000; // pass to milliseconds
+                    break;
+
                 case optionIndex::UNKNOWN_OPT:
                     logError(DDSROUTER_ARGS, opt << " is not a valid argument.");
                     option::printUsage(fwrite, stdout, usage, columns);

tools/ddsrouter_tool/src/cpp/user_interface/arguments_configuration.hpp

@@ -85,6 +85,7 @@ enum  optionIndex
     RELOAD_TIME,
     ACTIVATE_DEBUG,
     VERSION,
+    TIMEOUT,
 };
 
 /**
@@ -102,8 +103,9 @@ extern const option::Descriptor usage[];
  * @param [in] argc number of process arguments
  * @param [in] argv process arguments array (with size \c argc )
  * @param [out] file_path path to the configuration file
- * @param [out] reload_time time in seconds to reload the configuration file
+ * @param [out] reload_time time in milliseconds to reload the configuration file
  * @param [out] activate_debug activate log info
+ * @param [out] timeout time in milliseconds to maximum router execution time
  *
  * @return \c SUCCESS if everything OK
  * @return \c INCORRECT_ARGUMENT if arguments were incorrect (unknown or incorrect value)
@@ -115,7 +117,8 @@ ProcessReturnCode parse_arguments(
         char** argv,
         std::string& file_path,
         utils::Duration_ms& reload_time,
-        bool& activate_debug);
+        bool& activate_debug,
+        utils::Duration_ms& timeout);
 
 //! \c Option to stream serializator
 std::ostream& operator <<(