Fix documentation and deprecation warnings (#265)

The poll() API with integer timeout is deprecated. Use std::chrono::duration instead. Signed-off-by: Alejandro Hernández <[email protected]> Signed-off-by: Steve Peters <[email protected]> Signed-off-by: Louise Poubel <[email protected]> Co-authored-by: Steve Peters <[email protected]> Co-authored-by: Louise Poubel <[email protected]>
gazebosim · Sep 28, 2021 · 0a813ec · 0a813ec
1 parent 73bfba7
commit 0a813ec
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -86,12 +86,12 @@ Visit the [documentation page](https://ignitionrobotics.org/api/transport/11.0/i
 ```
 ign-transport
 ├── conf        Configuration file for the integration with the `ign` CLI tool.
+├── docker      Dockerfile with ign-transport installed and scripts to build and run the code.
 ├── example     Example programs that use most of the Ignition Transport API.
 ├── include     Header files that get installed.
 ├── log         All the code related with Ignition Transport logging.
 ├── src         Source code of the core library.
 ├── test        A directory of integration, performance and regression tests.
-├── tools       Scripts for continuous integration testing.
 └── tutorials   A set of tutorials about Ignition Transport features.
 ```
 

diff --git a/example/bench.cc b/example/bench.cc
@@ -43,6 +43,7 @@
 #include <chrono>
 #include <condition_variable>
 #include <csignal>
+#include <exception>
 #include <iostream>
 #include <string>
 #include <thread>
@@ -233,7 +234,7 @@ class ReplyTester
         std::cerr << "Received[" << _msg.header().stamp().sec()
           << "] Expected[" << this->prevStamp+1 << "]\n";
 
-        throw std::unexpected;
+        std::terminate();
       }
     }
 
@@ -548,7 +549,7 @@ class PubTester
     {
       std::cerr << "Received[" << _msg.header().stamp().sec()
         << "] Expected[" << this->expectedStamp << "]\n";
-      throw std::unexpected;
+      std::terminate();
     }
     this->expectedStamp++;
 

diff --git a/src/Discovery.cc b/src/Discovery.cc
@@ -51,7 +51,8 @@ inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE
 
     try
     {
-      zmq::poll(&items[0], sizeof(items) / sizeof(items[0]), _timeout);
+      zmq::poll(&items[0], sizeof(items) / sizeof(items[0]),
+                std::chrono::milliseconds(_timeout));
     }
     catch(...)
     {

diff --git a/src/NodeShared.cc b/src/NodeShared.cc
@@ -352,7 +352,7 @@ void NodeShared::RunReceptionTask()
     try
     {
       zmq::poll(&items[0], sizeof(items) / sizeof(items[0]),
-                NodeSharedPrivate::Timeout);
+                std::chrono::milliseconds(NodeSharedPrivate::Timeout));
     }
     catch(...)
     {
@@ -1677,7 +1677,7 @@ void NodeSharedPrivate::AccessControlHandler()
       try
       {
         zmq::poll(&items[0], sizeof(items) / sizeof(items[0]),
-            NodeSharedPrivate::Timeout);
+            std::chrono::milliseconds(NodeSharedPrivate::Timeout));
       }
       catch(...)
       {

diff --git a/src/NodeSharedPrivate.hh b/src/NodeSharedPrivate.hh
@@ -137,7 +137,7 @@ namespace ignition
       public: std::atomic<bool> exit = false;
 
       /// \brief Timeout used for receiving messages (ms.).
-      public: static const int Timeout = 250;
+      public: inline static const int Timeout = 250;
 
       ////////////////////////////////////////////////////////////////
       /////// The following is for asynchronous publication of ///////

diff --git a/tutorials/02_installation.md b/tutorials/02_installation.md
@@ -170,6 +170,36 @@ cd /tmp/ign-transport/build
 sudo make uninstall
 ```
 
+### macOS
+
+1. Clone the repository
+  ```
+  git clone https://github.com/ignitionrobotics/ign-transport -b ign-transport<#>
+  ```
+  Be sure to replace `<#>` with a number value, such as 10 or 11, depending on
+  which version you need.
+
+2. Install dependencies
+  ```
+  brew install --only-dependencies ignition-transport<#>
+  ```
+  Be sure to replace `<#>` with a number value, such as 10 or 11, depending on
+  which version you need.
+
+3. Configure and build
+  ```
+  cd ign-transport
+  mkdir build
+  cd build
+  cmake ..
+  make
+  ```
+
+4. Optionally, install
+  ```
+  sudo make install
+  ```
+
 ## Windows
 
 ### Prerequisites
@@ -273,4 +303,3 @@ can run:
 ```
 make test
 ```
-