MessagePublisher Class Reference

This class stores all the information about a message publisher. More...

#include <Publisher.hh>

Public Member Functions
	MessagePublisher ()=default
	Default constructor.
	MessagePublisher (const std::string &_topic, const std::string &_addr, const std::string &_ctrl, const std::string &_pUuid, const std::string &_nUuid, const std::string &_msgTypeName, const AdvertiseMessageOptions &_opts)
	Constructor.
virtual	~MessagePublisher ()=default
	Destructor.
std::string	Ctrl () const
	Get the ZeroMQ control address. This address is used by the subscribers to notify the publisher about the new subscription.
virtual void	FillDiscovery (msgs::Discovery &_msg) const final
	Populate a discovery message.
std::string	MsgTypeName () const
	Get the message type advertised by this publisher.
bool	operator!= (const MessagePublisher &_pub) const
	Inequality operator. This function checks if the given message publisher does not have identical Topic, Addr, PUuid, NUuid, Scope, Ctrl, and MsgTypeName strings to this object.
bool	operator== (const MessagePublisher &_pub) const
	Equality operator. This function checks if the given message publisher has identical Topic, Addr, PUuid, NUuid, Scope, Ctrl, and MsgTypeName strings to this object.
virtual const AdvertiseMessageOptions &	Options () const
	Get the advertised options.
void	SetCtrl (const std::string &_ctrl)
	Set the ZeroMQ control address of the publisher.
virtual void	SetFromDiscovery (const msgs::Discovery &_msg)
	Set data from a discovery message.
void	SetMsgTypeName (const std::string &_msgTypeName)
	Set the message type advertised by this publisher.
void	SetOptions (const AdvertiseMessageOptions &_opts)
	Set the advertised options.
Public Member Functions inherited from Publisher
	Publisher ()=default
	Default constructor.
	Publisher (const std::string &_topic, const std::string &_addr, const std::string &_pUuid, const std::string &_nUuid, const AdvertiseOptions &_opts)
	Constructor.
virtual	~Publisher ()=default
	Destructor.
std::string	Addr () const
	Get the ZeroMQ address of the publisher.
std::string	NUuid () const
	Get the node UUID of the publisher.
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.
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.
std::string	PUuid () const
	Get the process UUID of the publisher. return Process UUID.
void	SetAddr (const std::string &_addr)
	Set ZeroMQ address of the publisher.
void	SetNUuid (const std::string &_nUuid)
	Set the node UUID of the publisher.
void	SetOptions (const AdvertiseOptions &_opts)
	Set the advertised options.
void	SetPUuid (const std::string &_pUuid)
	Set the process UUID of the publisher.
void	SetTopic (const std::string &_topic)
	Set the topic name published by this publisher.
std::string	Topic () const
	Get the topic published by this publisher.

Additional Inherited Members
Protected Attributes inherited from Publisher
std::string	addr
	ZeroMQ address of the publisher.
std::string	nUuid
	Node UUID of the publisher.
std::string	pUuid
	Process UUID of the publisher.
std::string	topic
	Topic name.

Detailed Description

This class stores all the information about a message publisher.

gz/transport/Publisher.hh

Constructor & Destructor Documentation

MessagePublisher() [1/2]

MessagePublisher ( )

default

Default constructor.

MessagePublisher() [2/2]

MessagePublisher ( const std::string &  _topic, const std::string &  _addr, const std::string &  _ctrl, const std::string &  _pUuid, const std::string &  _nUuid, const std::string &  _msgTypeName, const AdvertiseMessageOptions &  _opts  )

explicit

Constructor.

Parameters

[in]	_topic	Topic name.
[in]	_addr	ZeroMQ address.
[in]	_ctrl	ZeroMQ control address.
[in]	_pUuid	Process UUID.
[in]	_nUuid	node UUID.
[in]	_msgTypeName	Message type advertised by this publisher.
[in]	_opts	Advertise options.

~MessagePublisher()

virtual ~MessagePublisher ( )

virtualdefault

Destructor.

Member Function Documentation

Ctrl()

std::string Ctrl

(

)

const

Get the ZeroMQ control address. This address is used by the subscribers to notify the publisher about the new subscription.

Returns

ZeroMQ control address of the publisher.

See also

SetCtrl.

FillDiscovery()

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

finalvirtual

Populate a discovery message.

Parameters

[in]

_msg

Message to fill.

Reimplemented from Publisher.

MsgTypeName()

std::string MsgTypeName

(

)

const

Get the message type advertised by this publisher.

Returns

Message type.

operator!=()

bool operator!=

(

const MessagePublisher &

_pub

)

const

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

Parameters

[in]

_pub

The message publisher to compare against.

Returns

True if this object does not match the provided object.

operator==()

bool operator==

(

const MessagePublisher &

_pub

)

const

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

Parameters

[in]

_pub

The message publisher to compare against.

Returns

True if this object matches the provided object.

Options()

virtual const AdvertiseMessageOptions & Options ( ) const

virtual

Get the advertised options.

Returns

The advertised options.

See also

SetOptions.

Reimplemented from Publisher.

SetCtrl()

void SetCtrl

(

const std::string &

_ctrl

)

Set the ZeroMQ control address of the publisher.

Parameters

[in]

_ctrl

New control address.

See also

Ctrl.

SetFromDiscovery()

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

virtual

Set data from a discovery message.

Parameters

[in]

_msg

Discovery message.

Reimplemented from Publisher.

SetMsgTypeName()

void SetMsgTypeName

(

const std::string &

_msgTypeName

)

Set the message type advertised by this publisher.

Parameters

[in]

_msgTypeName

New message type.

See also

MsgTypeName.

SetOptions()

void SetOptions

(

const AdvertiseMessageOptions &

_opts

)

Set the advertised options.

Parameters

[in]

_opts

New advertised options.

See also

Options.

---

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

• Publisher.hh