Publisher.hh

Go to the documentation of this file.

/*
 * Copyright 2012 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
/* Desc: Handles pushing messages out on a named topic
 * Author: Nate Koenig
 */

#ifndef _PUBLISHER_HH_
#define _PUBLISHER_HH_

#include <google/protobuf/message.h>
#include <boost/thread.hpp>
#include <string>
#include <list>

#include "transport/TransportTypes.hh"

namespace gazebo
{
  namespace transport
  {

    class Publisher
    {
      public: Publisher(const std::string &_topic, const std::string &_msgType,
                  unsigned int _limit, bool _latch) GAZEBO_DEPRECATED(1.5);

      public: Publisher(const std::string &_topic, const std::string &_msgType,
                        unsigned int _limit, double _hzRate);

      public: virtual ~Publisher();

      public: bool HasConnections() const;

      public: void WaitForConnection() const;

      public: void SetPublication(PublicationPtr &_publication, int _i)
              GAZEBO_DEPRECATED(1.5);

      public: void SetPublication(PublicationPtr _publication);

      public: void Publish(const google::protobuf::Message &_message,
                 bool _block = false)
              { this->PublishImpl(_message, _block); }

      public: template< typename M>
              void Publish(M _message, bool _block = false)
              { this->PublishImpl(_message, _block); }

      public: unsigned int GetOutgoingCount() const;

      private: void PublishImpl(const google::protobuf::Message &_message,
                                bool _block);

      public: std::string GetTopic() const;

      public: std::string GetMsgType() const;

      public: void SendMessage();

      public: bool GetLatching() const GAZEBO_DEPRECATED(1.5);

      public: std::string GetPrevMsg() const;

      public: MessagePtr GetPrevMsgPtr() const;

      private: void OnPublishComplete();

      private: std::string topic;

      private: std::string msgType;

      private: unsigned int queueLimit;

      private: double updatePeriod;

      private: bool queueLimitWarned;

      private: std::list<MessagePtr> messages;

      private: mutable boost::recursive_mutex mutex;

      private: PublicationPtr publication;

      private: MessagePtr prevMsg;

      private: common::Time currentTime;
      private: common::Time prevPublishTime;
    };
  }
}
#endif