/usr/include/image_transport/publisher.h is in libimage-transport-dev 1.11.10-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | /*********************************************************************
* Software License Agreement (BSD License)
*
* Copyright (c) 2009, Willow Garage, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* * Neither the name of the Willow Garage nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*********************************************************************/
#ifndef IMAGE_TRANSPORT_PUBLISHER_H
#define IMAGE_TRANSPORT_PUBLISHER_H
#include <ros/ros.h>
#include <sensor_msgs/Image.h>
#include "image_transport/single_subscriber_publisher.h"
#include "image_transport/exception.h"
#include "image_transport/loader_fwds.h"
namespace image_transport {
/**
* \brief Manages advertisements of multiple transport options on an Image topic.
*
* Publisher is a drop-in replacement for ros::Publisher when publishing
* Image topics. In a minimally built environment, they behave the same; however,
* Publisher is extensible via plugins to publish alternative representations of
* the image on related subtopics. This is especially useful for limiting bandwidth and
* latency over a network connection, when you might (for example) use the theora plugin
* to transport the images as streamed video. All topics are published only on demand
* (i.e. if there are subscribers).
*
* A Publisher should always be created through a call to ImageTransport::advertise(),
* or copied from one that was.
* Once all copies of a specific Publisher go out of scope, any subscriber callbacks
* associated with that handle will stop being called. Once all Publisher for a
* given base topic go out of scope the topic (and all subtopics) will be unadvertised.
*/
class Publisher
{
public:
Publisher() {}
/*!
* \brief Returns the number of subscribers that are currently connected to
* this Publisher.
*
* Returns the total number of subscribers to all advertised topics.
*/
uint32_t getNumSubscribers() const;
/*!
* \brief Returns the base topic of this Publisher.
*/
std::string getTopic() const;
/*!
* \brief Publish an image on the topics associated with this Publisher.
*/
void publish(const sensor_msgs::Image& message) const;
/*!
* \brief Publish an image on the topics associated with this Publisher.
*/
void publish(const sensor_msgs::ImageConstPtr& message) const;
/*!
* \brief Shutdown the advertisements associated with this Publisher.
*/
void shutdown();
operator void*() const;
bool operator< (const Publisher& rhs) const { return impl_ < rhs.impl_; }
bool operator!=(const Publisher& rhs) const { return impl_ != rhs.impl_; }
bool operator==(const Publisher& rhs) const { return impl_ == rhs.impl_; }
private:
Publisher(ros::NodeHandle& nh, const std::string& base_topic, uint32_t queue_size,
const SubscriberStatusCallback& connect_cb,
const SubscriberStatusCallback& disconnect_cb,
const ros::VoidPtr& tracked_object, bool latch,
const PubLoaderPtr& loader);
struct Impl;
typedef boost::shared_ptr<Impl> ImplPtr;
typedef boost::weak_ptr<Impl> ImplWPtr;
ImplPtr impl_;
static void weakSubscriberCb(const ImplWPtr& impl_wptr,
const SingleSubscriberPublisher& plugin_pub,
const SubscriberStatusCallback& user_cb);
SubscriberStatusCallback rebindCB(const SubscriberStatusCallback& user_cb);
friend class ImageTransport;
};
} //namespace image_transport
#endif
|