rti::pub Namespace Reference

<<extension>> Extensions to dds::pub More...

Classes
class	AcknowledgmentInfo
	<<extension>> <<value-type>> Information about an application-acknowledged sample More...
struct	FlowControllerSchedulingPolicy_def
	<<extension>> Kinds of flow controller shceduling policy More...
class	FlowControllerTokenBucketProperty
	<<extension>> <<value-type>> Configures a FlowController based on a tocken-bucket mechanism More...
class	FlowControllerProperty
	<<extension>> <<value-type>> Configures a FlowController More...
class	FlowController
	<<extension>> <<reference-type>> A flow controller is the object responsible for shaping the network traffic by determining when attached asynchronous dds::pub::DataWriter instances are allowed to write data. More...
class	WriteParams
	<<extension>> <<value-type>> Advanced parameters for writing with a DataWriter More...

Typedefs
typedef dds::core::safe_enum < FlowControllerSchedulingPolicy_def >	FlowControllerSchedulingPolicy
	<<extension>> The safe enumeration for FlowControllerSchedulingPolicy_def::type

Functions
template<typename PublisherForwardIterator >
uint32_t	find_publishers (const dds::domain::DomainParticipant participant, PublisherForwardIterator begin, uint32_t max_size)
	<<extension>> Retrieve all of the dds::pub::Publisher created from this dds::domain::DomainParticipant
template<typename PublisherBackInsertIterator >
uint32_t	find_publishers (const dds::domain::DomainParticipant participant, PublisherBackInsertIterator begin)
	Retrieve all the dds::pub::Publisher created from this dds::domain::DomainParticipant.
dds::pub::Publisher	find_publisher (const dds::domain::DomainParticipant participant, const std::string &publisher_name)
	<<extension>> Looks up a dds::pub::Publisher by its entity name within the dds::domain::DomainParticipant.
template<typename AnyDataWriterBackInsertIterator >
uint32_t	find_datawriters (dds::pub::Publisher publisher, AnyDataWriterBackInsertIterator begin)
	Retrieve all the dds::pub::DataWriter created from this dds::pub::Publisher.
template<typename AnyDataWriterForwardIterator >
uint32_t	find_datawriters (dds::pub::Publisher publisher, AnyDataWriterForwardIterator begin, uint32_t max_size)
	Retrieve all the dds::pub::DataWriter created from this dds::pub::Publisher.
template<typename Writer >
Writer	find_datawriter_by_topic_name (dds::pub::Publisher publisher, const std::string &topic_name)
	<<extension>> Retrieves a dds::pub::DataWriter with the given name within the dds::pub::Publisher
template<typename Writer >
Writer	find_datawriter_by_name (dds::pub::Publisher publisher, const std::string &datawriter_name)
	<<extension>> Retrieves a dds::pub::DataWriter with the given name within the dds::pub::Publisher
template<typename Writer >
Writer	find_datawriter_by_name (dds::domain::DomainParticipant participant, const std::string &datawriter_name)
	<<extension>> Retrieves a dds::pub::DataWriter within the dds::domain::DomainParticipant with the given name
dds::pub::Publisher	implicit_publisher (const dds::domain::DomainParticipant &dp)
	<<extension>> Get the implicit dds::pub::Publisher for a given dds::domain::DomainParticipant.
FlowController	find_flow_controller (dds::domain::DomainParticipant participant, const std::string &name)
	Retrieves an existing FlowController.

Detailed Description

<<extension>> Extensions to dds::pub

Function Documentation

template<typename PublisherForwardIterator >

uint32_t rti::pub::find_publishers	(	const dds::domain::DomainParticipant	participant,
		PublisherForwardIterator	begin,
		uint32_t	max_size
	)

<<extension>> Retrieve all of the dds::pub::Publisher created from this dds::domain::DomainParticipant

Template Parameters

PublisherForwardIterator

A forward iterator whose value type is dds::pub::Publisher

Parameters

participant	The dds::domain::DomainParticipant the Publishers belong to
begin	A forward iterator to the position in the destination container to insert the found Publishers into
max_size	The maximum number of Publishers to add

Returns

The number of found Publishers

See Also

DDSWriterExampleModule_lookup

template<typename PublisherBackInsertIterator >

uint32_t rti::pub::find_publishers	(	const dds::domain::DomainParticipant	participant,
		PublisherBackInsertIterator	begin
	)

Retrieve all the dds::pub::Publisher created from this dds::domain::DomainParticipant.

Template Parameters

PublisherBackInsertIterator

A back-inserting iterator whose value type is dds::pub::Publisher

Parameters

participant	The dds::domain::DomainParticipant the Publishers belong to
begin	A back-inserting iterator to the position in the destination container to insert the found Publishers in

Returns

The number of found Publishers

See Also

DDSWriterExampleModule_lookup

dds::pub::Publisher rti::pub::find_publisher	(	const dds::domain::DomainParticipant	participant,
		const std::string &	publisher_name
	)

<<extension>> Looks up a dds::pub::Publisher by its entity name within the dds::domain::DomainParticipant.

Every dds::pub::Publisher in the system has an entity name which is configured and stored in the EntityName policy, ENTITY_NAME.

This operation retrieves a dds::pub::Publisher within the dds::domain::DomainParticipant given the entity's name. If there are several dds::pub::Publisher with the same name within the dds::domain::DomainParticipant, this function returns the first matching occurrence.

Parameters

participant	The dds::domain::DomainParticipant to look for the dds::pub::Publisher in.
publisher_name	Entity name of the Publisher

Returns

The first Publisher found with the specified name or dds::core::null if it is not found.

See Also

DDSWriterExampleModule_lookup

template<typename AnyDataWriterBackInsertIterator >

uint32_t rti::pub::find_datawriters	(	dds::pub::Publisher	publisher,
		AnyDataWriterBackInsertIterator	begin
	)

Retrieve all the dds::pub::DataWriter created from this dds::pub::Publisher.

Template Parameters

AnyDataWriterBackInsertIterator

An iterator whose value_type is dds::pub::AnyDataWriter

Parameters

publisher	The dds::pub::Publisher the DataWriters belong to
begin	A back-inserting iterator to the position in the destination container to insert the found DataWriters into

Returns

The number of found DataWriters

See Also

DDSWriterExampleModule_lookup

template<typename AnyDataWriterForwardIterator >

uint32_t rti::pub::find_datawriters	(	dds::pub::Publisher	publisher,
		AnyDataWriterForwardIterator	begin,
		uint32_t	max_size
	)

Retrieve all the dds::pub::DataWriter created from this dds::pub::Publisher.

Template Parameters

AnyDataWriterForwardIterator

An iterator whose value_type is dds::pub::AnyDataWriter

Parameters

publisher	The dds::pub::Publisher the DataWriters belong to
begin	A forward iterator to the first position in the destination container to copy the found DataWriters into
max_size	The maximum number of DataWriters to return

Returns

The number of found DataWriters

See Also

DDSWriterExampleModule_lookup

template<typename Writer >

Writer rti::pub::find_datawriter_by_topic_name	(	dds::pub::Publisher	publisher,
		const std::string &	topic_name
	)

<<extension>> Retrieves a dds::pub::DataWriter with the given name within the dds::pub::Publisher

Every dds::pub::DataWriter in the system has an entity name which is configured and stored in the <<extension>> EntityName policy, ENTITY_NAME.

This operation retrieves the dds::pub::DataWriter within the dds::pub::Publisher whose name matches the one specified. If there are several dds::pub::DataWriter with the same name within the dds::pub::Publisher, the operation returns the first matching occurrence.

Template Parameters

Writer

The type of the writer. It can be dds::pub::AnyDataWriter, or an instantiation of dds::pub::DataWriter<T> (if T is not the correct type, this function throws dds::core::InvalidDowncastError)

Parameters

publisher	The dds::pub::Publisher that created the DataWriter to find
topic_name	Entity name of the DataWriter to find

Returns

The AnyDataWriter with the given name

See Also

DDSWriterExampleModule_lookup

template<typename Writer >

Writer rti::pub::find_datawriter_by_name	(	dds::pub::Publisher	publisher,
		const std::string &	datawriter_name
	)

<<extension>> Retrieves a dds::pub::DataWriter with the given name within the dds::pub::Publisher

Every dds::pub::DataWriter in the system has an entity name which is configured and stored in the <<extension>> EntityName policy, ENTITY_NAME.

This operation retrieves the dds::pub::DataWriter within the dds::pub::Publisher whose name matches the one specified. If there are several dds::pub::DataWriter with the same name within the dds::pub::Publisher, the operation returns the first matching occurrence.

Template Parameters

Writer

The type of the writer. It can be dds::pub::AnyDataWriter, or an instantiation of dds::pub::DataWriter<T> (if T is not the correct type, this function throws dds::core::InvalidDowncastError)

Parameters

publisher	The dds::pub::Publisher that created the DataWriter to find
datawriter_name	Entity name of the DataWriter to find

Returns

The WRITER with the given name

See Also

DDSWriterExampleModule_lookup

template<typename Writer >

Writer rti::pub::find_datawriter_by_name	(	dds::domain::DomainParticipant	participant,
		const std::string &	datawriter_name
	)

<<extension>> Retrieves a dds::pub::DataWriter within the dds::domain::DomainParticipant with the given name

Every dds::pub::DataWriter in the system has an entity name which is configured and stored in the EntityName policy, ENTITY_NAME.

Every dds::pub::Publisher in the system has an entity name which is also configured and stored in the EntityName policy.

This operation retrieves a dds::pub::DataWriter within a dds::pub::Publisher given the specified name which encodes both to the dds::pub::DataWriter and the dds::pub::Publisher name.

If there are several dds::pub::DataWriter with the same name within the corresponding dds::pub::Publisher this function returns the first matching occurrence.

The specified name might be given as a fully-qualified entity name or as a plain name.

The fully qualified entity name is a concatenation of the dds::pub::Publisher to which the dds::pub::DataWriter belongs and the entity name of of the dds::pub::DataWriter itself, separated by a double colon "::". For example: MyPublisherName::MyDataWriterName

The plain name contains the dds::pub::DataWriter name only. In this situation it is implied that the dds::pub::DataWriter belongs to the implicit dds::pub::Publisher so the use of a plain name is equivalent to specifying a fully qualified name with the dds::pub::Publisher name part being "implicit". For example: the plain name "MyDataWriterName" is equivalent to specifiying the fully qualified name "implicit::MyDataWriterName"

The dds::pub::DataWriter is only looked up within the dds::pub::Publisher specified in the fully qualified name, or within the implicit dds::pub::Publisher if the name was not fully qualified.

Template Parameters

Writer

The type of the writer. It can be dds::pub::AnyDataWriter, or an instantiation of dds::pub::DataWriter<T> (if T is not the correct type, this function throws dds::core::InvalidDowncastError)

Parameters

participant	The dds::domain::DomainParticipant within which the dds::pub::DataWriter exists
datawriter_name	EntityName of the DataWriter to find

Returns

The WRITER with the given name

See Also

implicit_publisher(const dds::domain::DomainParticipant& dp);

DDSWriterExampleModule_lookup

dds::pub::Publisher rti::pub::implicit_publisher

(

const dds::domain::DomainParticipant &

dp

)

<<extension>> Get the implicit dds::pub::Publisher for a given dds::domain::DomainParticipant.

If an implicit Publisher does not already exist, this creates one.

The implicit Publisher is created with default dds::pub::qos::PublisherQos and no listener. When a DomainParticipant is deleted, if there are no attached dds::pub::DataWriter that belong to the implicit Publisher, the implicit Publisher will be implicitly deleted.

MT Safety:

UNSAFE. It is not safe to create an implicit Publisher while another thread may be simultaneously calling dds::domain::DomainParticipant::default_publisher_qos.

Parameters

dp	The DomainParticipant that the implicit publisher belongs to

Returns

The implicit publisher

FlowController find_flow_controller	(	dds::domain::DomainParticipant	participant,
		const std::string &	name
	)

Retrieves an existing FlowController.

Parameters

participant	The DomainParticipant associated to the FlowController
name	The name used to create the FlowController or the name of one of the built-in FlowControllers (FlowController::DEFAULT_NAME, FlowController::FIXED_RATE_NAME, FlowController::ON_DEMAND_NAME)

Returns

The flow controller with that name in that participant or an empty reference (equals to dds::core::null) if it doesn't exist

See Also

FlowController::retain()