Public Types | Public Member Functions | Private Attributes | Friends
message_transport::SingleSubscriberPublisher< M > Class Template Reference

Allows publication of an image to a single subscriber. Only available inside subscriber connection callbacks. More...

#include <single_subscriber_publisher.h>

Inheritance diagram for message_transport::SingleSubscriberPublisher< M >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef boost::function
< uint32_t()> 
GetNumSubscribersFn
typedef boost::function< void(const
M &)> 
PublishFn
typedef boost::function< void(const
SingleSubscriberPublisher< M > &)> 
StatusCB

Public Member Functions

uint32_t getNumSubscribers () const
std::string getSubscriberName () const
std::string getTopic () const
void publish (const M &message) const
void publish (const typename M::ConstPtr &message) const
 SingleSubscriberPublisher (const std::string &caller_id, const std::string &topic, const GetNumSubscribersFn &num_subscribers_fn, const PublishFn &publish_fn)

Private Attributes

std::string caller_id_
GetNumSubscribersFn num_subscribers_fn_
PublishFn publish_fn_
std::string topic_

Friends

class Publisher
class PublisherImplGen

Detailed Description

template<class M>
class message_transport::SingleSubscriberPublisher< M >

Allows publication of an image to a single subscriber. Only available inside subscriber connection callbacks.

Definition at line 15 of file single_subscriber_publisher.h.


Member Typedef Documentation

template<class M>
typedef boost::function<uint32_t()> message_transport::SingleSubscriberPublisher< M >::GetNumSubscribersFn

Definition at line 18 of file single_subscriber_publisher.h.

template<class M>
typedef boost::function<void(const M&)> message_transport::SingleSubscriberPublisher< M >::PublishFn

Definition at line 19 of file single_subscriber_publisher.h.

template<class M>
typedef boost::function<void(const SingleSubscriberPublisher<M>&)> message_transport::SingleSubscriberPublisher< M >::StatusCB

Definition at line 20 of file single_subscriber_publisher.h.


Constructor & Destructor Documentation

template<class M>
message_transport::SingleSubscriberPublisher< M >::SingleSubscriberPublisher ( const std::string &  caller_id,
const std::string &  topic,
const GetNumSubscribersFn num_subscribers_fn,
const PublishFn publish_fn 
) [inline]

Definition at line 22 of file single_subscriber_publisher.h.


Member Function Documentation

template<class M>
uint32_t message_transport::SingleSubscriberPublisher< M >::getNumSubscribers ( ) const [inline]

Definition at line 39 of file single_subscriber_publisher.h.

template<class M>
std::string message_transport::SingleSubscriberPublisher< M >::getSubscriberName ( ) const [inline]

Definition at line 29 of file single_subscriber_publisher.h.

template<class M>
std::string message_transport::SingleSubscriberPublisher< M >::getTopic ( ) const [inline]

Definition at line 34 of file single_subscriber_publisher.h.

template<class M>
void message_transport::SingleSubscriberPublisher< M >::publish ( const M &  message) const [inline]

Definition at line 44 of file single_subscriber_publisher.h.

template<class M>
void message_transport::SingleSubscriberPublisher< M >::publish ( const typename M::ConstPtr &  message) const [inline]

Definition at line 49 of file single_subscriber_publisher.h.


Friends And Related Function Documentation

template<class M>
friend class Publisher [friend]

Definition at line 60 of file single_subscriber_publisher.h.

template<class M>
friend class PublisherImplGen [friend]

Definition at line 61 of file single_subscriber_publisher.h.


Member Data Documentation

template<class M>
std::string message_transport::SingleSubscriberPublisher< M >::caller_id_ [private]

Definition at line 55 of file single_subscriber_publisher.h.

Definition at line 57 of file single_subscriber_publisher.h.

Definition at line 58 of file single_subscriber_publisher.h.

template<class M>
std::string message_transport::SingleSubscriberPublisher< M >::topic_ [private]

Definition at line 56 of file single_subscriber_publisher.h.


The documentation for this class was generated from the following file:


message_transport_common
Author(s): Cedric Pradalier
autogenerated on Sat Dec 28 2013 16:56:55