single_subscriber_publisher.h
Go to the documentation of this file.
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2009, Willow Garage, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 * * Neither the name of the Willow Garage nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *********************************************************************/
34 
35 #ifndef IMAGE_TRANSPORT_SINGLE_SUBSCRIBER_PUBLISHER
36 #define IMAGE_TRANSPORT_SINGLE_SUBSCRIBER_PUBLISHER
37 
38 #include <boost/noncopyable.hpp>
39 #include <boost/function.hpp>
40 #include <sensor_msgs/Image.h>
41 #include "exports.h"
42 
43 namespace image_transport {
44 
50 {
51 public:
52  typedef boost::function<uint32_t()> GetNumSubscribersFn;
53  typedef boost::function<void(const sensor_msgs::Image&)> PublishFn;
54 
55  SingleSubscriberPublisher(const std::string& caller_id, const std::string& topic,
56  const GetNumSubscribersFn& num_subscribers_fn,
57  const PublishFn& publish_fn);
58 
59  std::string getSubscriberName() const;
60 
61  std::string getTopic() const;
62 
63  uint32_t getNumSubscribers() const;
64 
65  void publish(const sensor_msgs::Image& message) const;
66  void publish(const sensor_msgs::ImageConstPtr& message) const;
67 
68 private:
69  std::string caller_id_;
70  std::string topic_;
71  GetNumSubscribersFn num_subscribers_fn_;
72  PublishFn publish_fn_;
73 
74  friend class Publisher; // to get publish_fn_ directly
75 };
76 
77 typedef boost::function<void(const SingleSubscriberPublisher&)> SubscriberStatusCallback;
78 
79 } //namespace image_transport
80 
81 #endif
Manages advertisements of multiple transport options on an Image topic.
Definition: publisher.h:64
boost::function< void(const SingleSubscriberPublisher &)> SubscriberStatusCallback
boost::function< void(const sensor_msgs::Image &)> PublishFn
Allows publication of an image to a single subscriber. Only available inside subscriber connection ca...
#define IMAGE_TRANSPORT_DECL
Definition: exports.h:15


image_transport
Author(s): Patrick Mihelich
autogenerated on Mon Feb 28 2022 22:31:45