ros::AdvertiseOptions Struct Reference

Encapsulates all options available for creating a Publisher. More...

#include <advertise_options.h>

List of all members.

Public Member Functions
	AdvertiseOptions (const std::string &_topic, uint32_t _queue_size, const std::string &_md5sum, const std::string &_datatype, const std::string &_message_definition, const SubscriberStatusCallback &_connect_cb=SubscriberStatusCallback(), const SubscriberStatusCallback &_disconnect_cb=SubscriberStatusCallback())
	AdvertiseOptions ()
template<class M >
void	init (const std::string &_topic, uint32_t _queue_size, const SubscriberStatusCallback &_connect_cb=SubscriberStatusCallback(), const SubscriberStatusCallback &_disconnect_cb=SubscriberStatusCallback())
	templated helper function for automatically filling out md5sum, datatype and message definition
Static Public Member Functions
template<class M >
static AdvertiseOptions	create (const std::string &topic, uint32_t queue_size, const SubscriberStatusCallback &connect_cb, const SubscriberStatusCallback &disconnect_cb, const VoidConstPtr &tracked_object, CallbackQueueInterface *queue)
	Templated helper function for creating an AdvertiseOptions for a message type with most options.
Public Attributes
CallbackQueueInterface *	callback_queue
	Queue to add callbacks to. If NULL, the global callback queue will be used.
SubscriberStatusCallback	connect_cb
	The function to call when a subscriber connects to this topic.
std::string	datatype
	The datatype of the message published on this topic (eg. "std_msgs/String").
SubscriberStatusCallback	disconnect_cb
	The function to call when a subscriber disconnects from this topic.
bool	has_header
	Tells whether or not the message has a header. If it does, the sequence number will be written directly into the serialized bytes after the message has been serialized.
bool	latch
	Whether or not this publication should "latch". A latching publication will automatically send out the last published message to any new subscribers.
std::string	md5sum
	The md5sum of the message datatype published on this topic.
std::string	message_definition
	The full definition of the message published on this topic.
uint32_t	queue_size
	The maximum number of outgoing messages to be queued for delivery to subscribers.
std::string	topic
	The topic to publish on.
VoidConstPtr	tracked_object
	An object whose destruction will prevent the callbacks associated with this advertisement from being called.

---

Detailed Description

Encapsulates all options available for creating a Publisher.

Definition at line 38 of file advertise_options.h.

---

Constructor & Destructor Documentation

ros::AdvertiseOptions::AdvertiseOptions

(

)

[inline]

Definition at line 34 of file advertise_options.h.

ros::AdvertiseOptions::AdvertiseOptions	(	const std::string &	_topic,
		uint32_t	_queue_size,
		const std::string &	_md5sum,
		const std::string &	_datatype,
		const std::string &	_message_definition,
		const SubscriberStatusCallback &	_connect_cb = SubscriberStatusCallback(),
		const SubscriberStatusCallback &	_disconnect_cb = SubscriberStatusCallback()
	)			[inline]

Definition at line 49 of file advertise_options.h.

---

Member Function Documentation

template<class M >

static AdvertiseOptions ros::AdvertiseOptions::create	(	const std::string &	topic,
		uint32_t	queue_size,
		const SubscriberStatusCallback &	connect_cb,
		const SubscriberStatusCallback &	disconnect_cb,
		const VoidConstPtr &	tracked_object,
		CallbackQueueInterface *	queue
	)			[inline, static]

Templated helper function for creating an AdvertiseOptions for a message type with most options.

Parameters:

	M	[template] Message type
	topic	Topic to publish on
	queue_size	Maximum number of outgoing messages to be queued for delivery to subscribers
	connect_cb	Function to call when a subscriber connects to this topic
	disconnect_cb	Function to call when a subscriber disconnects from this topic
	tracked_object	tracked object to use (see AdvertiseOptions::tracked_object)
	queue	The callback queue to use (see AdvertiseOptions::callback_queue)

Returns:

an AdvertiseOptions which embodies the parameters

Definition at line 139 of file advertise_options.h.

template<class M >

void ros::AdvertiseOptions::init	(	const std::string &	_topic,
		uint32_t	_queue_size,
		const SubscriberStatusCallback &	_connect_cb = SubscriberStatusCallback(),
		const SubscriberStatusCallback &	_disconnect_cb = SubscriberStatusCallback()
	)			[inline]

templated helper function for automatically filling out md5sum, datatype and message definition

Parameters:

	M	[template] Message type
	_topic	Topic to publish on
	_queue_size	Maximum number of outgoing messages to be queued for delivery to subscribers
	_connect_cb	Function to call when a subscriber connects to this topic
	_disconnect_cb	Function to call when a subscriber disconnects from this topic

Definition at line 75 of file advertise_options.h.

---

Member Data Documentation

CallbackQueueInterface* ros::AdvertiseOptions::callback_queue

Queue to add callbacks to. If NULL, the global callback queue will be used.

Definition at line 99 of file advertise_options.h.

SubscriberStatusCallback ros::AdvertiseOptions::connect_cb

The function to call when a subscriber connects to this topic.

Definition at line 96 of file advertise_options.h.

std::string ros::AdvertiseOptions::datatype

The datatype of the message published on this topic (eg. "std_msgs/String").

Definition at line 93 of file advertise_options.h.

SubscriberStatusCallback ros::AdvertiseOptions::disconnect_cb

The function to call when a subscriber disconnects from this topic.

Definition at line 97 of file advertise_options.h.

bool ros::AdvertiseOptions::has_header

Tells whether or not the message has a header. If it does, the sequence number will be written directly into the serialized bytes after the message has been serialized.

Definition at line 122 of file advertise_options.h.

bool ros::AdvertiseOptions::latch

Whether or not this publication should "latch". A latching publication will automatically send out the last published message to any new subscribers.

Definition at line 117 of file advertise_options.h.

std::string ros::AdvertiseOptions::md5sum

The md5sum of the message datatype published on this topic.

Definition at line 92 of file advertise_options.h.

std::string ros::AdvertiseOptions::message_definition

The full definition of the message published on this topic.

Definition at line 94 of file advertise_options.h.

uint32_t ros::AdvertiseOptions::queue_size

The maximum number of outgoing messages to be queued for delivery to subscribers.

Definition at line 90 of file advertise_options.h.

std::string ros::AdvertiseOptions::topic

The topic to publish on.

Definition at line 89 of file advertise_options.h.

VoidConstPtr ros::AdvertiseOptions::tracked_object

An object whose destruction will prevent the callbacks associated with this advertisement from being called.

A shared pointer to an object to track for these callbacks. If set, the a weak_ptr will be created to this object, and if the reference count goes to 0 the subscriber callbacks will not get called.

Note:

Note that setting this will cause a new reference to be added to the object before the callback, and for it to go out of scope (and potentially be deleted) in the code path (and therefore thread) that the callback is invoked from.

Definition at line 111 of file advertise_options.h.

---

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

• advertise_options.h