A Publication manages an advertised topic.
More...
#include <publication.h>
|
void | addCallbacks (const SubscriberCallbacksPtr &callbacks) |
|
void | addSubscriberLink (const SubscriberLinkPtr &sub_link) |
| Adds a publisher to our list. More...
|
|
void | drop () |
| Drop this publication. Disconnects all publishers. More...
|
|
bool | enqueueMessage (const SerializedMessage &m) |
| queues an outgoing message into each of the publishers, so that it gets sent to every subscriber More...
|
|
const std::string & | getDataType () const |
| Returns the data type of the message published by this publication. More...
|
|
void | getInfo (XmlRpc::XmlRpcValue &info) |
| Get the accumulated info for this publication. More...
|
|
size_t | getMaxQueue () |
| returns the max queue size of this publication More...
|
|
const std::string & | getMD5Sum () const |
| Returns the md5sum of the message published by this publication. More...
|
|
const std::string & | getMessageDefinition () const |
| Returns the full definition of the message published by this publication. More...
|
|
const std::string & | getName () const |
| Returns the name of the topic this publication broadcasts to. More...
|
|
size_t | getNumCallbacks () |
|
uint32_t | getNumSubscribers () |
| Returns the number of subscribers this publication has. More...
|
|
void | getPublishTypes (bool &serialize, bool &nocopy, const std::type_info &ti) |
|
uint32_t | getSequence () |
| Returns the sequence number. More...
|
|
XmlRpc::XmlRpcValue | getStats () |
| Get the accumulated stats for this publication. More...
|
|
bool | hasSubscribers () |
| Returns whether or not this publication has any subscribers. More...
|
|
uint32_t | incrementSequence () |
|
bool | isDropped () |
| Returns if this publication is valid or not. More...
|
|
bool | isLatched () |
|
bool | isLatching () |
|
void | processPublishQueue () |
|
| Publication (const std::string &name, const std::string &datatype, const std::string &_md5sum, const std::string &message_definition, size_t max_queue, bool latch, bool has_header) |
|
void | publish (SerializedMessage &m) |
|
void | removeCallbacks (const SubscriberCallbacksPtr &callbacks) |
|
void | removeSubscriberLink (const SubscriberLinkPtr &sub_link) |
| Removes a publisher from our list (deleting it if it's the last reference) More...
|
|
bool | validateHeader (const Header &h, std::string &error_msg) |
|
| ~Publication () |
|
A Publication manages an advertised topic.
Definition at line 53 of file publication.h.
ros::Publication::Publication |
( |
const std::string & |
name, |
|
|
const std::string & |
datatype, |
|
|
const std::string & |
_md5sum, |
|
|
const std::string & |
message_definition, |
|
|
size_t |
max_queue, |
|
|
bool |
latch, |
|
|
bool |
has_header |
|
) |
| |
ros::Publication::~Publication |
( |
| ) |
|
void ros::Publication::drop |
( |
| ) |
|
Drop this publication. Disconnects all publishers.
Definition at line 138 of file publication.cpp.
void ros::Publication::dropAllConnections |
( |
| ) |
|
|
private |
queues an outgoing message into each of the publishers, so that it gets sent to every subscriber
Definition at line 157 of file publication.cpp.
const std::string& ros::Publication::getDataType |
( |
| ) |
const |
|
inline |
Returns the data type of the message published by this publication.
Definition at line 104 of file publication.h.
Get the accumulated info for this publication.
Definition at line 287 of file publication.cpp.
size_t ros::Publication::getMaxQueue |
( |
| ) |
|
|
inline |
returns the max queue size of this publication
Definition at line 76 of file publication.h.
const std::string& ros::Publication::getMD5Sum |
( |
| ) |
const |
|
inline |
Returns the md5sum of the message published by this publication.
Definition at line 108 of file publication.h.
const std::string& ros::Publication::getMessageDefinition |
( |
| ) |
const |
|
inline |
Returns the full definition of the message published by this publication.
Definition at line 112 of file publication.h.
const std::string& ros::Publication::getName |
( |
| ) |
const |
|
inline |
Returns the name of the topic this publication broadcasts to.
Definition at line 100 of file publication.h.
size_t ros::Publication::getNumCallbacks |
( |
| ) |
|
uint32_t ros::Publication::getNumSubscribers |
( |
| ) |
|
Returns the number of subscribers this publication has.
Definition at line 374 of file publication.cpp.
void ros::Publication::getPublishTypes |
( |
bool & |
serialize, |
|
|
bool & |
nocopy, |
|
|
const std::type_info & |
ti |
|
) |
| |
uint32_t ros::Publication::getSequence |
( |
| ) |
|
|
inline |
Get the accumulated stats for this publication.
Definition at line 255 of file publication.cpp.
bool ros::Publication::hasSubscribers |
( |
| ) |
|
Returns whether or not this publication has any subscribers.
Definition at line 401 of file publication.cpp.
uint32_t ros::Publication::incrementSequence |
( |
| ) |
|
bool ros::Publication::isDropped |
( |
| ) |
|
|
inline |
Returns if this publication is valid or not.
Definition at line 136 of file publication.h.
bool ros::Publication::isLatched |
( |
| ) |
|
|
inline |
bool ros::Publication::isLatching |
( |
| ) |
|
|
inline |
Called when a new peer has connected. Calls the connection callback.
Definition at line 325 of file publication.cpp.
Called when a peer has disconnected. Calls the disconnection callback.
Definition at line 342 of file publication.cpp.
void ros::Publication::processPublishQueue |
( |
| ) |
|
Removes a publisher from our list (deleting it if it's the last reference)
Definition at line 225 of file publication.cpp.
bool ros::Publication::validateHeader |
( |
const Header & |
h, |
|
|
std::string & |
error_msg |
|
) |
| |
boost::mutex ros::Publication::callbacks_mutex_ |
|
private |
std::string ros::Publication::datatype_ |
|
private |
bool ros::Publication::dropped_ |
|
private |
bool ros::Publication::has_header_ |
|
private |
uint32_t ros::Publication::intraprocess_subscriber_count_ |
|
private |
bool ros::Publication::latch_ |
|
private |
size_t ros::Publication::max_queue_ |
|
private |
std::string ros::Publication::md5sum_ |
|
private |
std::string ros::Publication::message_definition_ |
|
private |
std::string ros::Publication::name_ |
|
private |
boost::mutex ros::Publication::publish_queue_mutex_ |
|
private |
uint32_t ros::Publication::seq_ |
|
private |
boost::mutex ros::Publication::seq_mutex_ |
|
private |
boost::mutex ros::Publication::subscriber_links_mutex_ |
|
private |
The documentation for this class was generated from the following files:
roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim, Dirk Thomas
autogenerated on Mon Nov 2 2020 03:52:27