Goby3 3.2.3
2025.05.13
Loading...
Searching...
No Matches
goby::middleware::io::SerialThreadLineBased< line_in_group, line_out_group, publish_layer, subscribe_layer, ThreadType, use_indexed_groups > Class Template Reference

Reads/Writes strings from/to serial port using a line-based (typically ASCII) protocol with a defined end-of-line regex. More...

#include <goby/middleware/io/line_based/serial.h>

Inheritance diagram for goby::middleware::io::SerialThreadLineBased< line_in_group, line_out_group, publish_layer, subscribe_layer, ThreadType, use_indexed_groups >:
goby::middleware::io::detail::SerialThread< line_in_group, line_out_group, publish_layer, subscribe_layer, ThreadType, use_indexed_groups > goby::middleware::io::detail::IOThread< line_in_group, line_out_group, publish_layer, subscribe_layer, IOConfig, SocketType, ThreadType, use_indexed_groups > goby::middleware::io::detail::IOPublishTransporter< Derived, line_in_group, layer, use_indexed_group > goby::middleware::io::detail::IOSubscribeTransporter< Derived, line_out_group, layer, use_indexed_group >

Public Member Functions

 SerialThreadLineBased (const goby::middleware::protobuf::SerialConfig &config, int index=-1)
 Constructs the thread.
 
 ~SerialThreadLineBased () override
 
- Public Member Functions inherited from goby::middleware::io::detail::SerialThread< line_in_group, line_out_group, publish_layer, subscribe_layer, ThreadType, use_indexed_groups >
 SerialThread (const goby::middleware::protobuf::SerialConfig &config, int index=-1)
 Constructs the thread.
 
virtual ~SerialThread () override
 
- Public Member Functions inherited from goby::middleware::io::detail::IOThread< line_in_group, line_out_group, publish_layer, subscribe_layer, IOConfig, SocketType, ThreadType, use_indexed_groups >
 IOThread (const IOConfig &config, int index, std::string glog_group="i/o")
 Constructs the thread.
 
void initialize () override
 
void finalize () override
 
virtual ~IOThread ()
 

Additional Inherited Members

- Protected Member Functions inherited from goby::middleware::io::detail::SerialThread< line_in_group, line_out_group, publish_layer, subscribe_layer, ThreadType, use_indexed_groups >
boost::asio::serial_port & mutable_serial_port ()
 Access the (mutable) serial_port object.
 
- Protected Member Functions inherited from goby::middleware::io::detail::IOThread< line_in_group, line_out_group, publish_layer, subscribe_layer, IOConfig, SocketType, ThreadType, use_indexed_groups >
void write (std::shared_ptr< const goby::middleware::protobuf::IOData > io_msg)
 
void handle_read_success (std::size_t bytes_transferred, const std::string &bytes)
 
void handle_read_success (std::size_t bytes_transferred, std::shared_ptr< goby::middleware::protobuf::IOData > io_msg)
 
void handle_write_success (std::size_t bytes_transferred)
 
void handle_read_error (const boost::system::error_code &ec)
 
void handle_write_error (const boost::system::error_code &ec)
 
SocketType & mutable_socket ()
 Access the (mutable) socket (or serial_port) object.
 
boost::asio::io_contextmutable_io ()
 
bool socket_is_open ()
 Does the socket exist and is it open?
 
const std::string & glog_group ()
 

Detailed Description

template<const goby::middleware::Group & line_in_group, const goby::middleware::Group & line_out_group, PubSubLayer publish_layer = PubSubLayer::INTERPROCESS, PubSubLayer subscribe_layer = PubSubLayer::INTERTHREAD, template< class > class ThreadType = goby::middleware::SimpleThread, bool use_indexed_groups = false>
class goby::middleware::io::SerialThreadLineBased< line_in_group, line_out_group, publish_layer, subscribe_layer, ThreadType, use_indexed_groups >

Reads/Writes strings from/to serial port using a line-based (typically ASCII) protocol with a defined end-of-line regex.

Template Parameters
line_in_groupgoby::middleware::Group to publish to after receiving data from the serial port
line_out_groupgoby::middleware::Group to subcribe to for data to send to the serial port

Definition at line 71 of file serial.h.

Constructor & Destructor Documentation

◆ SerialThreadLineBased()

template<const goby::middleware::Group & line_in_group, const goby::middleware::Group & line_out_group, PubSubLayer publish_layer = PubSubLayer::INTERPROCESS, PubSubLayer subscribe_layer = PubSubLayer::INTERTHREAD, template< class > class ThreadType = goby::middleware::SimpleThread, bool use_indexed_groups = false>
goby::middleware::io::SerialThreadLineBased< line_in_group, line_out_group, publish_layer, subscribe_layer, ThreadType, use_indexed_groups >::SerialThreadLineBased ( const goby::middleware::protobuf::SerialConfig config,
int  index = -1 
)
inline

Constructs the thread.

Parameters
configA reference to the Protocol Buffers config read by the main application at launch
indexThread index for multiple instances in a given application (-1 indicates a single instance)

Definition at line 82 of file serial.h.

◆ ~SerialThreadLineBased()

template<const goby::middleware::Group & line_in_group, const goby::middleware::Group & line_out_group, PubSubLayer publish_layer = PubSubLayer::INTERPROCESS, PubSubLayer subscribe_layer = PubSubLayer::INTERTHREAD, template< class > class ThreadType = goby::middleware::SimpleThread, bool use_indexed_groups = false>
goby::middleware::io::SerialThreadLineBased< line_in_group, line_out_group, publish_layer, subscribe_layer, ThreadType, use_indexed_groups >::~SerialThreadLineBased ( )
inlineoverride

Definition at line 87 of file serial.h.


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