Goby3  3.1.5a
2024.05.23
goby::middleware::intervehicle::ModemDriverThread Class Reference

#include <goby/middleware/transport/intervehicle/driver_thread.h>

Inheritance diagram for goby::middleware::intervehicle::ModemDriverThread:
goby::middleware::Thread< intervehicle::protobuf::PortalConfig::LinkConfig, InterProcessForwarder< InterThreadTransporter > >

Public Types

using buffer_data_type = goby::middleware::protobuf::SerializerTransporterMessage
 
using modem_id_type = goby::acomms::DynamicBuffer< buffer_data_type >::modem_id_type
 
using subbuffer_id_type = goby::acomms::DynamicBuffer< buffer_data_type >::subbuffer_id_type
 
- Public Types inherited from goby::middleware::Thread< intervehicle::protobuf::PortalConfig::LinkConfig, InterProcessForwarder< InterThreadTransporter > >
using Transporter = InterProcessForwarder< InterThreadTransporter >
 

Public Member Functions

 ModemDriverThread (const intervehicle::protobuf::PortalConfig::LinkConfig &cfg)
 
void loop () override
 
int tx_queue_size ()
 
- Public Member Functions inherited from goby::middleware::Thread< intervehicle::protobuf::PortalConfig::LinkConfig, InterProcessForwarder< InterThreadTransporter > >
 Thread (const intervehicle::protobuf::PortalConfig::LinkConfig &cfg, InterProcessForwarder< InterThreadTransporter > *transporter, int index)
 Construct a thread with a given configuration, underlying transporter, and index (for multiple instantiations), but without any loop() frequency. More...
 
 Thread (const intervehicle::protobuf::PortalConfig::LinkConfig &cfg, InterProcessForwarder< InterThreadTransporter > *transporter, double loop_freq_hertz=0, int index=-1)
 Construct a thread with all possible metadata (using double to specify frequency in Hertz) More...
 
 Thread (const intervehicle::protobuf::PortalConfig::LinkConfig &cfg, InterProcessForwarder< InterThreadTransporter > *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) More...
 
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. More...
 
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

- Static Public Attributes inherited from goby::middleware::Thread< intervehicle::protobuf::PortalConfig::LinkConfig, InterProcessForwarder< InterThreadTransporter > >
static constexpr goby::middleware::Group shutdown_group_
 
static constexpr goby::middleware::Group joinable_group_
 
- Protected Member Functions inherited from goby::middleware::Thread< intervehicle::protobuf::PortalConfig::LinkConfig, InterProcessForwarder< InterThreadTransporter > >
 Thread (const intervehicle::protobuf::PortalConfig::LinkConfig &cfg, boost::units::quantity< boost::units::si::frequency > loop_freq, int index=-1)
 
void set_transporter (InterProcessForwarder< InterThreadTransporter > *transporter)
 
double loop_frequency_hertz () const
 
decltype(loop_frequency_) loop_frequency () const
 
double loop_max_frequency () const
 
void run_once ()
 
InterProcessForwarder< InterThreadTransporter > & transporter () const
 
const intervehicle::protobuf::PortalConfig::LinkConfigcfg () 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. More...
 
void thread_quit ()
 
bool alive ()
 

Detailed Description

Definition at line 130 of file driver_thread.h.

Member Typedef Documentation

◆ buffer_data_type

◆ modem_id_type

◆ subbuffer_id_type

Constructor & Destructor Documentation

◆ ModemDriverThread()

goby::middleware::intervehicle::ModemDriverThread::ModemDriverThread ( const intervehicle::protobuf::PortalConfig::LinkConfig cfg)

Member Function Documentation

◆ loop()

void goby::middleware::intervehicle::ModemDriverThread::loop ( )
overridevirtual

◆ tx_queue_size()

int goby::middleware::intervehicle::ModemDriverThread::tx_queue_size ( )
inline

Definition at line 141 of file driver_thread.h.


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