This class stores all the information about a publisher. It stores the topic name that publishes, addresses, UUIDs, scope, etc. More...

#include <Publisher.hh>

Public Member Functions
	Publisher ()=default
	Default constructor. More...

	Publisher (const Publisher &_other)
	Copy constructor. More...

	Publisher (const std::string &_topic, const std::string &_addr, const std::string &_pUuid, const std::string &_nUuid, const AdvertiseOptions &_opts)
	Constructor. More...

virtual	~Publisher ()=default
	Destructor. More...

std::string	Addr () const
	Get the ZeroMQ address of the publisher. More...

virtual void	FillDiscovery (msgs::Discovery &_msg) const
	Populate a discovery message. More...

virtual size_t	MsgLength () const
	Get the total length of the message. More...

std::string	NUuid () const
	Get the node UUID of the publisher. More...

bool	operator!= (const Publisher &_pub) const
	Inequality operator. This function checks if the given publisher does not have identical Topic, Addr, PUuid, NUuid, and Scope strings to this object. More...

Publisher &	operator= (const Publisher &_other)
	Assignment operator. More...

bool	operator== (const Publisher &_pub) const
	Equality operator. This function checks if the given publisher has identical Topic, Addr, PUuid, NUuid, and Scope strings to this object. More...

virtual const AdvertiseOptions &	Options () const
	Get the advertised options. More...

virtual size_t	Pack (char *_buffer) const
	Serialize the publisher. The caller has ownership of the buffer and is responsible for its [de]allocation. More...

std::string	PUuid () const
	Get the process UUID of the publisher. return Process UUID. More...

void	SetAddr (const std::string &_addr)
	Set ZeroMQ address of the publisher. More...

virtual void	SetFromDiscovery (const msgs::Discovery &_msg)
	Set data from a discovery message. More...

void	SetNUuid (const std::string &_nUuid)
	Set the node UUID of the publisher. More...

void	SetOptions (const AdvertiseOptions &_opts)
	Set the advertised options. More...

void	SetPUuid (const std::string &_pUuid)
	Set the process UUID of the publisher. More...

void	SetTopic (const std::string &_topic)
	Set the topic name published by this publisher. More...

std::string	Topic () const
	Get the topic published by this publisher. More...

virtual size_t	Unpack (const char *_buffer)
	Unserialize the publisher. More...

Protected Member Functions
size_t	MsgLengthInternal () const
	Get the total length of the message without counting the advertised options. This is useful when [un]serializing a derived publisher because we want to ignore the advertised options in the base publisher. More...

size_t	PackInternal (char *_buffer) const
	Serialize all fields except the advertise options. This is useful when we are serializing a derived class that contains its own advertise options. More...

size_t	UnpackInternal (const char *_buffer)
	Unserialize all fields except the advertise options. This is useful when we are unserializing a derived class that contains its own advertise options. More...

Protected Attributes
std::string	addr
	ZeroMQ address of the publisher. More...

std::string	nUuid
	Node UUID of the publisher. More...

std::string	pUuid
	Process UUID of the publisher. More...

std::string	topic
	Topic name. More...

Detailed Description

This class stores all the information about a publisher. It stores the topic name that publishes, addresses, UUIDs, scope, etc.

ignition/transport/Publisher.hh

Constructor & Destructor Documentation

◆ Publisher() [1/3]

Publisher ( )

default

Default constructor.

◆ Publisher() [2/3]

Publisher	(	const std::string &	_topic,
		const std::string &	_addr,
		const std::string &	_pUuid,
		const std::string &	_nUuid,
		const AdvertiseOptions &	_opts
	)

Constructor.

Parameters

[in]	_topic	Topic name.
[in]	_addr	ZeroMQ address.
[in]	_pUuid	Process UUID.
[in]	_nUuid	node UUID.
[in]	_opts	The advertise options.

◆ Publisher() [3/3]

Publisher ( const Publisher & _other )

Copy constructor.

Parameters

[in] _other Other Publisher object.

◆ ~Publisher()

virtual ~Publisher ( )

virtualdefault

Destructor.

Member Function Documentation

◆ Addr()

std::string Addr ( ) const

Get the ZeroMQ address of the publisher.

Returns: ZeroMQ address.

See also: SetAddr.

◆ FillDiscovery()

virtual void FillDiscovery ( msgs::Discovery & _msg ) const

virtual

Populate a discovery message.

Parameters

[in] _msg Message to fill.

Reimplemented in ServicePublisher, and MessagePublisher.

◆ MsgLength()

virtual size_t MsgLength ( ) const

virtual

Get the total length of the message.

Returns: Return the length of the message in bytes.

Reimplemented in ServicePublisher, and MessagePublisher.

◆ MsgLengthInternal()

size_t MsgLengthInternal ( ) const

protected

Get the total length of the message without counting the advertised options. This is useful when [un]serializing a derived publisher because we want to ignore the advertised options in the base publisher.

Returns: Return the length of the message in bytes.

◆ NUuid()

std::string NUuid ( ) const

Get the node UUID of the publisher.

Returns: Node UUID.

See also: SetNUuid.

◆ operator!=()

bool operator!= ( const Publisher & _pub ) const

Inequality operator. This function checks if the given publisher does not have identical Topic, Addr, PUuid, NUuid, and Scope strings to this object.

Parameters

[in] _pub The publisher to compare against.

Returns: True if this object does not match the provided object.

◆ operator=()

Publisher& operator= ( const Publisher & _other )

Assignment operator.

Parameters

[in] _other The other Publisher.

Returns: A reference to this instance.

◆ operator==()

bool operator== ( const Publisher & _pub ) const

Equality operator. This function checks if the given publisher has identical Topic, Addr, PUuid, NUuid, and Scope strings to this object.

Parameters

[in] _pub The publisher to compare against.

Returns: True if this object matches the provided object.

◆ Options()

virtual const AdvertiseOptions& Options ( ) const

virtual

Get the advertised options.

Returns: The advertised options.

See also: SetOptions.

Reimplemented in ServicePublisher, and MessagePublisher.

◆ Pack()

virtual size_t Pack ( char * _buffer ) const

virtual

Serialize the publisher. The caller has ownership of the buffer and is responsible for its [de]allocation.

Parameters

[out] _buffer Destination buffer in which the publisher will be serialized.

Returns: Number of bytes serialized.

Reimplemented in ServicePublisher, and MessagePublisher.

◆ PackInternal()

size_t PackInternal ( char * _buffer ) const

protected

Serialize all fields except the advertise options. This is useful when we are serializing a derived class that contains its own advertise options.

◆ PUuid()

std::string PUuid ( ) const

Get the process UUID of the publisher. return Process UUID.

See also: SetPUuid.

◆ SetAddr()

void SetAddr ( const std::string & _addr )

Set ZeroMQ address of the publisher.

Parameters

[in] _addr New address.

See also: Addr.

◆ SetFromDiscovery()

virtual void SetFromDiscovery ( const msgs::Discovery & _msg )

virtual

Set data from a discovery message.

Parameters

[in] _msg Discovery message.

Reimplemented in ServicePublisher, and MessagePublisher.

◆ SetNUuid()

void SetNUuid ( const std::string & _nUuid )

Set the node UUID of the publisher.

Parameters

[in] _nUuid New node UUID.

See also: NUuid.

◆ SetOptions()

void SetOptions ( const AdvertiseOptions & _opts )

Set the advertised options.

Parameters

[in] _opts New advertised options.

See also: Options.

◆ SetPUuid()

void SetPUuid ( const std::string & _pUuid )

Set the process UUID of the publisher.

Parameters

[in] _pUuid New process UUID.

See also: PUuid.

◆ SetTopic()

void SetTopic ( const std::string & _topic )

Set the topic name published by this publisher.

Parameters

[in] _topic New topic name.

See also: Topic.

◆ Topic()

std::string Topic ( ) const

Get the topic published by this publisher.

Returns: Topic name.

See also: SetTopic.

◆ Unpack()

virtual size_t Unpack ( const char * _buffer )

virtual

Unserialize the publisher.

Parameters

[in] _buffer Input buffer with the data to be unserialized.

Reimplemented in ServicePublisher, and MessagePublisher.

◆ UnpackInternal()

size_t UnpackInternal ( const char * _buffer )

protected

Unserialize all fields except the advertise options. This is useful when we are unserializing a derived class that contains its own advertise options.

Member Data Documentation

◆ addr

std::string addr

protected

ZeroMQ address of the publisher.

◆ nUuid

std::string nUuid

protected

Node UUID of the publisher.

◆ pUuid

std::string pUuid

protected

Process UUID of the publisher.

◆ topic

std::string topic

protected

Topic name.

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

gz/transport/Publisher.hh

Gazebo Transport

API Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Publisher() [1/3]

◆ Publisher() [2/3]

◆ Publisher() [3/3]

◆ ~Publisher()

Member Function Documentation

◆ Addr()

◆ FillDiscovery()

◆ MsgLength()

◆ MsgLengthInternal()

◆ NUuid()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ Options()

◆ Pack()

◆ PackInternal()

◆ PUuid()

◆ SetAddr()

◆ SetFromDiscovery()

◆ SetNUuid()

◆ SetOptions()

◆ SetPUuid()

◆ SetTopic()

◆ Topic()

◆ Unpack()

◆ UnpackInternal()

Member Data Documentation

◆ addr

◆ nUuid

◆ pUuid

◆ topic