goby::zeromq::LiaisonCommsThread< WtContainer > Class Template Reference

#include <goby/zeromq/liaison/liaison_container.h>

Inheritance diagram for goby::zeromq::LiaisonCommsThread< WtContainer >:

Public Member Functions
	LiaisonCommsThread (WtContainer *container, const goby::apps::zeromq::protobuf::LiaisonConfig &config, int index)
void	loop () override
Public Member Functions inherited from goby::middleware::SimpleThread< goby::apps::zeromq::protobuf::LiaisonConfig >
	SimpleThread (const goby::apps::zeromq::protobuf::LiaisonConfig &cfg, double loop_freq_hertz=0, int index=-1)
	Construct a thread with a given configuration, optionally a loop frequency and/or index.
	SimpleThread (const goby::apps::zeromq::protobuf::LiaisonConfig &cfg, boost::units::quantity< boost::units::si::frequency > loop_freq, int index=-1)
	Construct a thread with a given configuration, a loop frequency (using boost::units) and optionally an index.
InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter > > &	intervehicle ()
	Access the transporter on the intervehicle layer (which wraps interprocess and interthread)
InterProcessForwarder< InterThreadTransporter > &	interprocess ()
	Access the transporter on the interprocess layer (which wraps interthread)
InterThreadTransporter &	interthread ()
	Access the transporter on the interthread layer (this is the innermost transporter)
Public Member Functions inherited from goby::middleware::Thread< Config, TransporterType >
	Thread (const Config &cfg, TransporterType *transporter, int index)
	Construct a thread with a given configuration, underlying transporter, and index (for multiple instantiations), but without any loop() frequency.
	Thread (const Config &cfg, TransporterType *transporter, double loop_freq_hertz=0, int index=-1)
	Construct a thread with all possible metadata (using double to specify frequency in Hertz)
	Thread (const Config &cfg, TransporterType *transporter, boost::units::quantity< boost::units::si::frequency > loop_freq, int index=-1)
	Construct a thread with all possible metadata (using boost::units to specify frequency)
virtual	~Thread ()
void	run (std::atomic< bool > &alive)
	Run the thread until the boolean reference passed is set false. This call blocks, and should be run in a std::thread by the caller.
int	index () const
std::type_index	type_index ()
void	set_type_index (std::type_index type_i)
std::string	name ()
void	set_name (const std::string &name)
int	uid ()
void	set_uid (int uid)

Additional Inherited Members
Public Types inherited from goby::middleware::Thread< Config, TransporterType >
using	Transporter = TransporterType
Static Public Attributes inherited from goby::middleware::Thread< Config, TransporterType >
static constexpr goby::middleware::Group	shutdown_group_ {"goby::middleware::Thread::shutdown"}
static constexpr goby::middleware::Group	joinable_group_ {"goby::middleware::Thread::joinable"}
Protected Member Functions inherited from goby::middleware::Thread< Config, TransporterType >
	Thread (const Config &cfg, boost::units::quantity< boost::units::si::frequency > loop_freq, int index=-1)
void	set_transporter (TransporterType *transporter)
double	loop_frequency_hertz () const
decltype(loop_frequency_)	loop_frequency () const
double	loop_max_frequency () const
void	run_once ()
TransporterType &	transporter () const
const Config &	cfg () const
virtual void	initialize ()
virtual void	finalize ()
void	thread_health (goby::middleware::protobuf::ThreadHealth &health)
virtual void	health (goby::middleware::protobuf::ThreadHealth &health)
	Called when HealthRequest is made by goby_coroner.
void	thread_quit ()
bool	alive ()
Protected Member Functions inherited from goby::middleware::coroner::Thread< Derived >
void	subscribe_coroner ()

Detailed Description

template<typename WtContainer>
class goby::zeromq::LiaisonCommsThread< WtContainer >

Definition at line 212 of file liaison_container.h.

Constructor & Destructor Documentation

LiaisonCommsThread()

template<typename WtContainer >

goby::zeromq::LiaisonCommsThread< WtContainer >::LiaisonCommsThread ( WtContainer *  container, const goby::apps::zeromq::protobuf::LiaisonConfig &  config, int  index  )

inline

Definition at line 216 of file liaison_container.h.

Member Function Documentation

loop()

template<typename WtContainer >

void goby::zeromq::LiaisonCommsThread< WtContainer >::loop ( )

inlineoverridevirtual

Reimplemented from goby::middleware::Thread< Config, TransporterType >.

Definition at line 224 of file liaison_container.h.

---

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

• goby/zeromq/liaison/liaison_container.h