ign -> gz Namespace Migration : gz-transport

Migration.md

@@ -13,6 +13,10 @@ release will remove the deprecated code.
 1. Dependency on `cli` component of `ignition-utils`.
     * [GitHub pull request 229](https://github.com/ignitionrobotics/ign-transport/pull/229)
 
+### Deprecated
+
+1. The `ignition` namespace is deprecated and will be removed in future versions.  Use `gz` instead.
+
 ## Ignition Transport 8.X to 9.X
 
 ### Removed
@@ -27,7 +31,7 @@ release will remove the deprecated code.
 1. NodeShared::TriggerSubscriberCallbacks
     * [BitBucket pull request 404](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-transport/pull-requests/404)
 
-1. The discovery wire protocol changed to use ignition::msgs::Discovery
+1. The discovery wire protocol changed to use gz::msgs::Discovery
    instead of C-structs. The Packet.hh header file is deprecated, which
    contained the Header, SubscriptionMsg, and AdvertiseMessage classes. The
    version of the wire protocal has bumped from 9 to 10. This means Ignition

example/bench.cc

@@ -87,12 +87,12 @@ class FloodSub
 
   /// \brief Dummy callback.
   /// \param[in] _msg The message.
-  public: void OnMsg(const ignition::msgs::Bytes & /*_msg*/)
+  public: void OnMsg(const gz::msgs::Bytes & /*_msg*/)
   {
   }
 
   /// \brief Communication node.
-  private: ignition::transport::Node node;
+  private: gz::transport::Node node;
 };
 
 /// \brief A class that publishes on a number of `/benchmark/flood/*`
@@ -112,7 +112,7 @@ class FloodPub
       std::ostringstream stream;
       stream << "/benchmark/flood/"  << i;
       this->floodPubs.push_back(
-          this->node.Advertise<ignition::msgs::Bytes>(stream.str()));
+          this->node.Advertise<gz::msgs::Bytes>(stream.str()));
     }
     if (!this->floodPubs.empty())
       this->runThread = std::thread(&FloodPub::RunLoop, this);
@@ -135,7 +135,7 @@ class FloodPub
   /// \brief Run the publishers.
   private: void RunLoop()
   {
-    ignition::msgs::Bytes msg;
+    gz::msgs::Bytes msg;
     int size = 1000;
     char *byteData = new char[size];
     std::memset(byteData, '0', size);
@@ -144,7 +144,7 @@ class FloodPub
     this->running = true;
     while (this->running)
     {
-      for (ignition::transport::Node::Publisher &pub : this->floodPubs)
+      for (gz::transport::Node::Publisher &pub : this->floodPubs)
       {
         pub.Publish(msg);
       }
@@ -153,7 +153,7 @@ class FloodPub
   }
 
   /// \brief Communication node.
-  private: ignition::transport::Node node;
+  private: gz::transport::Node node;
 
   /// \brief Run thread.
   private: std::thread runThread;
@@ -162,7 +162,7 @@ class FloodPub
   private: bool running{false};
 
   /// \brief The publishers.
-  private: std::vector<ignition::transport::Node::Publisher> floodPubs;
+  private: std::vector<gz::transport::Node::Publisher> floodPubs;
 };
 
 /// \brief The ReplyTester subscribes to the benchmark topics, and relays
@@ -173,14 +173,14 @@ class FloodPub
 ///   1. /benchmark/latency/request For latency testing
 ///   2. /benchmark/throughput/request For throughput testing.
 ///
-/// The incoming and outgoing message types are ignition::msgs::Bytes.
+/// The incoming and outgoing message types are gz::msgs::Bytes.
 class ReplyTester
 {
   /// Constructor that creates the publishers and subscribers.
   public: ReplyTester()
   {
     // Advertise on the throughput reply topic
-    this->throughputPub = this->node.Advertise<ignition::msgs::Bytes>(
+    this->throughputPub = this->node.Advertise<gz::msgs::Bytes>(
         "/benchmark/throughput/reply");
     if (!this->throughputPub)
     {
@@ -190,7 +190,7 @@ class ReplyTester
     }
 
     // Advertise on the latency reply topic
-    this->latencyPub = this->node.Advertise<ignition::msgs::Bytes>(
+    this->latencyPub = this->node.Advertise<gz::msgs::Bytes>(
         "/benchmark/latency/reply");
     if (!this->latencyPub)
     {
@@ -225,7 +225,7 @@ class ReplyTester
 
   /// \brief Function called each time a throughput message is received.
   /// \param[in] _msg Incoming message of variable size.
-  private: void ThroughputCb(const ignition::msgs::Bytes &_msg)
+  private: void ThroughputCb(const gz::msgs::Bytes &_msg)
   {
     if (this->prevStamp > 0 && _msg.header().stamp().sec() != 0)
     {
@@ -246,19 +246,19 @@ class ReplyTester
 
   /// \brief Function called each time a latency message is received.
   /// \param[in] _msg Incoming message of variable size.
-  private: void LatencyCb(const ignition::msgs::Bytes &_msg)
+  private: void LatencyCb(const gz::msgs::Bytes &_msg)
   {
     this->latencyPub.Publish(_msg);
   }
 
   /// \brief The transport node
-  private: ignition::transport::Node node;
+  private: gz::transport::Node node;
 
   /// \brief The throughput publisher
-  private: ignition::transport::Node::Publisher throughputPub;
+  private: gz::transport::Node::Publisher throughputPub;
 
   /// \brief The latency publisher
-  private: ignition::transport::Node::Publisher latencyPub;
+  private: gz::transport::Node::Publisher latencyPub;
 
   private: int prevStamp = 0;
 };
@@ -305,7 +305,7 @@ class PubTester
   public: void Init()
   {
     // Throughput publisher
-    this->throughputPub = this->node.Advertise<ignition::msgs::Bytes>(
+    this->throughputPub = this->node.Advertise<gz::msgs::Bytes>(
         "/benchmark/throughput/request");
     if (!this->throughputPub)
     {
@@ -315,7 +315,7 @@ class PubTester
     }
 
     // Latency publisher
-    this->latencyPub = this->node.Advertise<ignition::msgs::Bytes>(
+    this->latencyPub = this->node.Advertise<gz::msgs::Bytes>(
         "/benchmark/latency/request");
     if (!this->latencyPub)
     {
@@ -535,7 +535,7 @@ class PubTester
 
   /// \brief Callback that handles throughput replies
   /// \param[in] _msg The reply message
-  private: void ThroughputCb(const ignition::msgs::Bytes &_msg)
+  private: void ThroughputCb(const gz::msgs::Bytes &_msg)
   {
     // Lock
     std::unique_lock<std::mutex> lk(this->mutex);
@@ -564,7 +564,7 @@ class PubTester
 
   /// \brief Callback that handles latency replies
   /// \param[in] _msg The reply message
-  private: void LatencyCb(const ignition::msgs::Bytes &_msg)
+  private: void LatencyCb(const gz::msgs::Bytes &_msg)
   {
     // End the time.
     this->timeEnd = std::chrono::high_resolution_clock::now();
@@ -604,7 +604,7 @@ class PubTester
   private: std::mutex mutex;
 
   /// \brief Message that is sent.
-  private: ignition::msgs::Bytes msg;
+  private: gz::msgs::Bytes msg;
 
   /// \brief Size of the message currently under test
   private: uint64_t dataSize = 0;
@@ -619,13 +619,13 @@ class PubTester
   private: uint64_t sentMsgs = 100;
 
   /// \brief Communication node
-  private: ignition::transport::Node node;
+  private: gz::transport::Node node;
 
   /// \brief Throughput publisher
-  private: ignition::transport::Node::Publisher throughputPub;
+  private: gz::transport::Node::Publisher throughputPub;
 
   /// \brief Latency publisher
-  private: ignition::transport::Node::Publisher latencyPub;
+  private: gz::transport::Node::Publisher latencyPub;
 
   /// \brief Used to stop the test.
   private: bool stop = false;

example/custom_query.cc

@@ -28,17 +28,17 @@
 //////////////////////////////////////////////////
 /// \brief Query for all the topics in reverse
 class AllTopicsReverse final
-    : public virtual ignition::transport::log::QueryOptions
+    : public virtual gz::transport::log::QueryOptions
 {
   // See documentation on QueryOptions
-  public: std::vector<ignition::transport::log::SqlStatement>
+  public: std::vector<gz::transport::log::SqlStatement>
     GenerateStatements(
-      const ignition::transport::log::Descriptor &/*_descriptor*/)
+      const gz::transport::log::Descriptor &/*_descriptor*/)
       const override
   {
     // The preamble has all the necessary joins and the correct column order
     // for a SELECT statement that returns messages.
-    ignition::transport::log::SqlStatement statement =
+    gz::transport::log::SqlStatement statement =
       this->StandardMessageQueryPreamble();
     // Reverse the order of the messages
     statement.statement += "ORDER BY messages.time_recv DESC;";
@@ -55,7 +55,7 @@ int main(int argc, char *argv[])
     return -1;
   }
 
-  ignition::transport::log::Log log;
+  gz::transport::log::Log log;
   if (!log.Open(argv[1]))
   {
     std::cerr << "Failed to open log\n";

example/playback.cc

@@ -35,7 +35,7 @@ int main(int argc, char *argv[])
     return -1;
   }
 
-  ignition::transport::log::Playback player(argv[1]);
+  gz::transport::log::Playback player(argv[1]);
 
   // Playback all topics
   const int64_t addTopicResult = player.AddTopic(std::regex(".*"));

example/publisher.cc

@@ -45,18 +45,18 @@ int main(int argc, char **argv)
   std::signal(SIGTERM, signal_handler);
 
   // Create a transport node and advertise a topic.
-  ignition::transport::Node node;
+  gz::transport::Node node;
   std::string topic = "/foo";
 
-  auto pub = node.Advertise<ignition::msgs::StringMsg>(topic);
+  auto pub = node.Advertise<gz::msgs::StringMsg>(topic);
   if (!pub)
   {
     std::cerr << "Error advertising topic [" << topic << "]" << std::endl;
     return -1;
   }
 
   // Prepare the message.
-  ignition::msgs::StringMsg msg;
+  gz::msgs::StringMsg msg;
   msg.set_data("HELLO");
 
   // Publish messages at 1Hz.

example/publisher_c.cc

@@ -45,7 +45,7 @@ int main(int argc, char **argv)
   const char *topic = "/foo";
 
   // Prepare the message.
-  ignition::msgs::StringMsg msg;
+  gz::msgs::StringMsg msg;
   msg.set_data("HELLO");
 
   // Get the size of the serialized message
@@ -62,7 +62,7 @@ int main(int argc, char **argv)
   msg.SerializeToArray(buffer, size);
 
   // Prepare the message.
-  ignition::msgs::StringMsg msgRed;
+  gz::msgs::StringMsg msgRed;
   msgRed.set_data("RED HELLO");
 
   // Get the size of the serialized message

example/publisher_c_fast.cc

@@ -45,7 +45,7 @@ int main(int argc, char **argv)
   const char *topic = "/foo";
 
   // Prepare the message.
-  ignition::msgs::StringMsg msg;
+  gz::msgs::StringMsg msg;
   msg.set_data("HELLO");
 
   // Get the size of the serialized message
@@ -58,7 +58,7 @@ int main(int argc, char **argv)
   msg.SerializeToArray(buffer, size);
 
   // Prepare the message.
-  ignition::msgs::StringMsg msgRed;
+  gz::msgs::StringMsg msgRed;
   msgRed.set_data("RED HELLO");
 
   // Get the size of the serialized message

example/publisher_custom_msg.cc

@@ -46,7 +46,7 @@ int main(int argc, char **argv)
   std::signal(SIGTERM, signal_handler);
 
   // Create a transport node and advertise a topic.
-  ignition::transport::Node node;
+  gz::transport::Node node;
   std::string topic = "/foo";
 
   auto pub = node.Advertise<example::msgs::StringMsg>(topic);

example/publisher_raw.cc

@@ -45,10 +45,10 @@ int main(int argc, char **argv)
   std::signal(SIGTERM, signal_handler);
 
   // Create a transport node and advertise a topic.
-  ignition::transport::Node node;
+  gz::transport::Node node;
   std::string topic = "/foo";
 
-  ignition::msgs::StringMsg msg;
+  gz::msgs::StringMsg msg;
   msg.set_data("HELLO");
 
   auto pub = node.Advertise(topic, msg.GetTypeName());

example/record.cc

@@ -36,7 +36,7 @@ int main(int argc, char *argv[])
     return -1;
   }
 
-  ignition::transport::log::Recorder recorder;
+  gz::transport::log::Recorder recorder;
 
   // Record all topics
   const int64_t addTopicResult = recorder.AddTopic(std::regex(".*"));
@@ -49,7 +49,7 @@ int main(int argc, char *argv[])
 
   // Begin recording, saving received messages to the given file
   const auto result = recorder.Start(argv[1]);
-  if (ignition::transport::log::RecorderError::SUCCESS != result)
+  if (gz::transport::log::RecorderError::SUCCESS != result)
   {
     std::cerr << "Failed to start recording: " << static_cast<int64_t>(result)
               << "\n";
@@ -60,7 +60,7 @@ int main(int argc, char *argv[])
             << std::endl;
 
   // Wait until the interrupt signal is sent.
-  ignition::transport::waitForShutdown();
+  gz::transport::waitForShutdown();
 
   recorder.Stop();
 

example/requester.cc

@@ -23,13 +23,13 @@
 int main(int argc, char **argv)
 {
   // Create a transport node.
-  ignition::transport::Node node;
+  gz::transport::Node node;
 
   // Prepare the input parameters.
-  ignition::msgs::StringMsg req;
+  gz::msgs::StringMsg req;
   req.set_data("HELLO");
 
-  ignition::msgs::StringMsg rep;
+  gz::msgs::StringMsg rep;
   bool result;
   unsigned int timeout = 5000;
 

example/requester_async.cc

@@ -21,7 +21,7 @@
 
 //////////////////////////////////////////////////
 /// \brief Service response callback.
-void responseCb(const ignition::msgs::StringMsg &_rep, const bool _result)
+void responseCb(const gz::msgs::StringMsg &_rep, const bool _result)
 {
   if (_result)
     std::cout << "Response: [" << _rep.data() << "]" << std::endl;
@@ -33,10 +33,10 @@ void responseCb(const ignition::msgs::StringMsg &_rep, const bool _result)
 int main(int argc, char **argv)
 {
   // Create a transport node.
-  ignition::transport::Node node;
+  gz::transport::Node node;
 
   // Prepare the input parameters.
-  ignition::msgs::StringMsg req;
+  gz::msgs::StringMsg req;
   req.set_data("HELLO");
 
   std::cout << "Press <CTRL-C> to exit" << std::endl;
@@ -45,5 +45,5 @@ int main(int argc, char **argv)
   node.Request("/echo", req, responseCb);
 
   // Zzzzzz.
-  ignition::transport::waitForShutdown();
+  gz::transport::waitForShutdown();
 }