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

Class for use with MultiThreadStandaloneApplication (interthread only). More...

#include <goby/middleware/application/multi_thread.h>

Inheritance diagram for goby::middleware::StandaloneThread< Config >:
goby::middleware::Thread< Config, InterThreadTransporter >

Public Member Functions

 StandaloneThread (const Config &cfg, double loop_freq_hertz=0, int index=-1)
 StandaloneThread (const Config &cfg, boost::units::quantity< boost::units::si::frequency > loop_freq, int index=-1)
InterThreadTransporterinterthread ()
Public Member Functions inherited from goby::middleware::Thread< Config, InterThreadTransporter >
 Thread (const Config &cfg, InterThreadTransporter *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< Config, InterThreadTransporter >
using Transporter
Static Public Attributes inherited from goby::middleware::Thread< Config, InterThreadTransporter >
static constexpr goby::middleware::Group shutdown_group_
static constexpr goby::middleware::Group joinable_group_
Protected Member Functions inherited from goby::middleware::Thread< Config, InterThreadTransporter >
void set_transporter (InterThreadTransporter *transporter)
virtual void loop ()
double loop_max_frequency () const
void run_once ()
InterThreadTransportertransporter () 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 ()

Detailed Description

template<typename Config>
class goby::middleware::StandaloneThread< Config >

Class for use with MultiThreadStandaloneApplication (interthread only).

Definition at line 416 of file multi_thread.h.

Constructor & Destructor Documentation

◆ StandaloneThread() [1/2]

template<typename Config>
goby::middleware::StandaloneThread< Config >::StandaloneThread ( const Config & cfg,
double loop_freq_hertz = 0,
int index = -1 )
inline

Definition at line 419 of file multi_thread.h.

◆ StandaloneThread() [2/2]

template<typename Config>
goby::middleware::StandaloneThread< Config >::StandaloneThread ( const Config & cfg,
boost::units::quantity< boost::units::si::frequency > loop_freq,
int index = -1 )
inline

Definition at line 424 of file multi_thread.h.

Member Function Documentation

◆ interthread()

template<typename Config>
InterThreadTransporter & goby::middleware::StandaloneThread< Config >::interthread ( )
inline

Definition at line 433 of file multi_thread.h.


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