Deprecated 1-arg specialisation: use goby::zeromq::SimpleThread or goby::udpm::SimpleThread. More...

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

Inheritance diagram for goby::middleware::SimpleThread< Config, void >:

Public Types
using	Base = SimpleThread<Config, zeromq::detail::InterProcessTag>
Public Types inherited from goby::middleware::Thread< Config, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, void > > >
using	Transporter
Public Types inherited from goby::middleware::Thread< Config, TransporterType >
using	Transporter = TransporterType

Public Member Functions
	SimpleThread (const Config &cfg, double loop_freq_hertz=0, int index=-1)
	SimpleThread (const Config &cfg, boost::units::quantity< boost::units::si::frequency > loop_freq, int index=-1)
InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, void > > &	intervehicle ()
	Access the transporter on the intervehicle layer (which wraps interprocess and interthread).
InterProcessForwarder< InterThreadTransporter, void > &	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, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, void > > >
	Thread (const Config &cfg, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, void > > *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)
Public Member Functions inherited from goby::middleware::SimpleThread< Config, zeromq::detail::InterProcessTag >
	SimpleThread (const Config &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 Config &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, zeromq::detail::InterProcessTag > > &	intervehicle ()
	Access the transporter on the intervehicle layer (which wraps interprocess and interthread).
InterProcessForwarder< InterThreadTransporter, zeromq::detail::InterProcessTag > &	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)
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)

Friends
class	coroner::Thread< SimpleThread< Config, ImplementationTag > >

Additional Inherited Members
Static Public Attributes inherited from goby::middleware::Thread< Config, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, void > > >
static constexpr goby::middleware::Group	shutdown_group_
static constexpr goby::middleware::Group	joinable_group_
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, InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, void > > >
void	set_transporter (InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, void > > *transporter)
virtual void	loop ()
double	loop_max_frequency () const
void	run_once ()
InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, void > > &	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< SimpleThread< Config, void > >
void	subscribe_coroner ()
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)
virtual void	loop ()
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 Config>
class goby::middleware::SimpleThread< Config, void >

Deprecated 1-arg specialisation: use goby::zeromq::SimpleThread or goby::udpm::SimpleThread.

Definition at line 124 of file simple_thread.h.

Member Typedef Documentation

◆ Base

template<typename Config>

using goby::middleware::SimpleThread< Config, void >::Base = SimpleThread<Config, zeromq::detail::InterProcessTag>

Definition at line 128 of file simple_thread.h.

Constructor & Destructor Documentation

◆ SimpleThread() [1/2]

template<typename Config>

goby::middleware::SimpleThread< Config, void >::SimpleThread	(	const Config &	cfg,
		double	loop_freq_hertz = 0,
		int	index = -1 )

inline

Definition at line 132 of file simple_thread.h.

◆ SimpleThread() [2/2]

template<typename Config>

goby::middleware::SimpleThread< Config, void >::SimpleThread	(	const Config &	cfg,
		boost::units::quantity< boost::units::si::frequency >	loop_freq,
		int	index = -1 )

inline

Definition at line 139 of file simple_thread.h.

Member Function Documentation

◆ interprocess()

InterProcessForwarder< InterThreadTransporter, void > & goby::middleware::SimpleThread< Config, void >::interprocess ( )

inline

Access the transporter on the interprocess layer (which wraps interthread).

Definition at line 96 of file simple_thread.h.

◆ interthread()

InterThreadTransporter & goby::middleware::SimpleThread< Config, void >::interthread ( )

inline

Access the transporter on the interthread layer (this is the innermost transporter).

Definition at line 102 of file simple_thread.h.

◆ intervehicle()

InterVehicleForwarder< InterProcessForwarder< InterThreadTransporter, void > > & goby::middleware::SimpleThread< Config, void >::intervehicle ( )

inline

Access the transporter on the intervehicle layer (which wraps interprocess and interthread).

Definition at line 90 of file simple_thread.h.

◆ coroner::Thread< SimpleThread< Config, ImplementationTag > >

friend class coroner::Thread< SimpleThread< Config, void > >

friend

Definition at line 1 of file simple_thread.h.

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

goby/middleware/application/simple_thread.h

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ SimpleThread() [1/2]

◆ SimpleThread() [2/2]

Member Function Documentation

◆ interprocess()

◆ interthread()

◆ intervehicle()

Friends And Related Symbol Documentation

◆ coroner::Thread< SimpleThread< Config, ImplementationTag > >