Public Member Functions | Private Member Functions | Private Attributes | List of all members
roswrap::SingleSubscriberPublisher Class Reference

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

#include <single_subscriber_publisher.h>

Inheritance diagram for roswrap::SingleSubscriberPublisher:
Inheritance graph
[legend]

Public Member Functions

std::string getSubscriberName () const
 Returns the name of the subscriber node. More...
 
std::string getTopic () const
 Returns the topic this publisher publishes on. More...
 
template<class M >
void publish (const M &message) const
 Publish a message on the topic associated with this Publisher. More...
 
template<class M >
void publish (const std::shared_ptr< M > &message) const
 Publish a message on the topic associated with this Publisher. More...
 
template<class M >
void publish (const std::shared_ptr< M const > &message) const
 Publish a message on the topic associated with this Publisher. More...
 
 SingleSubscriberPublisher (const SubscriberLinkPtr &link)
 
 ~SingleSubscriberPublisher ()
 

Private Member Functions

void publish (const SerializedMessage &m) const
 

Private Attributes

SubscriberLinkPtr link_
 

Additional Inherited Members

- Protected Member Functions inherited from boost::noncopyable_::noncopyable
constexpr noncopyable ()=default
 
 noncopyable (const noncopyable &)=delete
 
noncopyableoperator= (const noncopyable &)=delete
 
 ~noncopyable ()=default
 

Detailed Description

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

Definition at line 45 of file single_subscriber_publisher.h.

Constructor & Destructor Documentation

◆ SingleSubscriberPublisher()

roswrap::SingleSubscriberPublisher::SingleSubscriberPublisher ( const SubscriberLinkPtr link)

◆ ~SingleSubscriberPublisher()

roswrap::SingleSubscriberPublisher::~SingleSubscriberPublisher ( )

Member Function Documentation

◆ getSubscriberName()

std::string roswrap::SingleSubscriberPublisher::getSubscriberName ( ) const

Returns the name of the subscriber node.

◆ getTopic()

std::string roswrap::SingleSubscriberPublisher::getTopic ( ) const

Returns the topic this publisher publishes on.

◆ publish() [1/4]

template<class M >
void roswrap::SingleSubscriberPublisher::publish ( const M &  message) const
inline

Publish a message on the topic associated with this Publisher.

Definition at line 83 of file single_subscriber_publisher.h.

◆ publish() [2/4]

void roswrap::SingleSubscriberPublisher::publish ( const SerializedMessage m) const
private

◆ publish() [3/4]

template<class M >
void roswrap::SingleSubscriberPublisher::publish ( const std::shared_ptr< M > &  message) const
inline

Publish a message on the topic associated with this Publisher.

This version of publish will allow fast intra-process message-passing in the future, so you may not mutate the message after it has been passed in here (since it will be passed directly into a callback function)

Definition at line 74 of file single_subscriber_publisher.h.

◆ publish() [4/4]

template<class M >
void roswrap::SingleSubscriberPublisher::publish ( const std::shared_ptr< M const > &  message) const
inline

Publish a message on the topic associated with this Publisher.

This version of publish will allow fast intra-process message-passing in the future, so you may not mutate the message after it has been passed in here (since it will be passed directly into a callback function)

Definition at line 60 of file single_subscriber_publisher.h.

Member Data Documentation

◆ link_

SubscriberLinkPtr roswrap::SingleSubscriberPublisher::link_
private

Definition at line 103 of file single_subscriber_publisher.h.


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


sick_scan_xd
Author(s): Michael Lehning , Jochen Sprickerhof , Martin Günther
autogenerated on Fri Oct 25 2024 02:47:15