Goby3 3.5.1
2026.06.04
Loading...
Searching...
No Matches
goby::middleware::HealthMonitorThread< ImplementationTag > Class Template Reference

#include <goby/middleware/coroner/health_monitor_thread.h>

Inheritance diagram for goby::middleware::HealthMonitorThread< ImplementationTag >:
goby::middleware::SimpleThread< NullConfig, ImplementationTag > goby::middleware::Thread< NullConfig, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, ImplementationTag > > > goby::middleware::coroner::Thread< SimpleThread< NullConfig, ImplementationTag > >

Public Member Functions

 HealthMonitorThread ()
Public Member Functions inherited from goby::middleware::SimpleThread< NullConfig, ImplementationTag >
 SimpleThread (const NullConfig &cfg, double loop_freq_hertz=0, int index=-1)
 Construct a thread with a given configuration, optionally a loop frequency and/or index.
InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, ImplementationTag > > & intervehicle ()
 Access the transporter on the intervehicle layer (which wraps interprocess and interthread).
InterProcessForwarder< InterThreadTransporter, ImplementationTag > & interprocess ()
 Access the transporter on the interprocess layer (which wraps interthread).
InterThreadTransporterinterthread ()
 Access the transporter on the interthread layer (this is the innermost transporter).
Public Member Functions inherited from goby::middleware::Thread< NullConfig, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, ImplementationTag > > >
 Thread (const NullConfig &cfg, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, ImplementationTag > > *transporter, int index)
 Construct a thread with a given configuration, underlying transporter, and index (for multiple instantiations), but without any loop() 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)
double loop_frequency_hertz () const
decltype(loop_frequency_) loop_frequency () const
void set_loop_frequency_hertz (double loop_freq_hertz)
void set_loop_frequency (boost::units::quantity< boost::units::si::frequency > loop_freq)

Additional Inherited Members

Public Types inherited from goby::middleware::Thread< NullConfig, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, ImplementationTag > > >
using Transporter
Static Public Attributes inherited from goby::middleware::Thread< NullConfig, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, ImplementationTag > > >
static constexpr goby::middleware::Group shutdown_group_
static constexpr goby::middleware::Group joinable_group_
Protected Member Functions inherited from goby::middleware::Thread< NullConfig, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, ImplementationTag > > >
void set_transporter (InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, ImplementationTag > > *transporter)
double loop_max_frequency () const
void run_once ()
InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, ImplementationTag > > & transporter () const
const NullConfigcfg () const
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< SimpleThread< NullConfig, ImplementationTag > >
void subscribe_coroner ()

Detailed Description

template<typename ImplementationTag>
class goby::middleware::HealthMonitorThread< ImplementationTag >

Definition at line 42 of file health_monitor_thread.h.

Constructor & Destructor Documentation

◆ HealthMonitorThread()

template<typename ImplementationTag>
goby::middleware::HealthMonitorThread< ImplementationTag >::HealthMonitorThread ( )
inline

Definition at line 45 of file health_monitor_thread.h.


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