Loading...
Searching...
No Matches
goby::util::LineBasedCommsThreadStub< Config > Class Template Reference
#include <goby/util/linebasedcomms/thread_stub.h>
Inheritance diagram for goby::util::LineBasedCommsThreadStub< Config >:
Public Member Functions | |
| LineBasedCommsThreadStub (const Config &cfg, double loop_freq_hertz, int index) | |
| ~LineBasedCommsThreadStub ()=default | |
| middleware::InterThreadTransporter & | interthread () |
| Public Member Functions inherited from goby::middleware::Thread< Config, middleware::InterThreadTransporter > | |
| Thread (const Config &cfg, middleware::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, middleware::InterThreadTransporter > | |
| using | Transporter |
| Static Public Attributes inherited from goby::middleware::Thread< Config, middleware::InterThreadTransporter > | |
| static constexpr goby::middleware::Group | shutdown_group_ |
| static constexpr goby::middleware::Group | joinable_group_ |
| Protected Member Functions inherited from goby::middleware::Thread< Config, middleware::InterThreadTransporter > | |
| void | set_transporter (middleware::InterThreadTransporter *transporter) |
| virtual void | loop () |
| double | loop_max_frequency () const |
| void | run_once () |
| middleware::InterThreadTransporter & | 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 () |
Detailed Description
template<typename Config>
class goby::util::LineBasedCommsThreadStub< Config >
class goby::util::LineBasedCommsThreadStub< Config >
Definition at line 36 of file thread_stub.h.
Constructor & Destructor Documentation
◆ LineBasedCommsThreadStub()
template<typename Config>
|
inline |
Definition at line 40 of file thread_stub.h.
◆ ~LineBasedCommsThreadStub()
template<typename Config>
|
default |
Member Function Documentation
◆ interthread()
template<typename Config>
|
inline |
Definition at line 47 of file thread_stub.h.
The documentation for this class was generated from the following file:
- goby/util/linebasedcomms/thread_stub.h
