basic interface class for all the derived serial (and networking mimics) line-based nodes (serial, tcp, udp, etc.)
More...
#include <goby/util/linebasedcomms/interface.h>
basic interface class for all the derived serial (and networking mimics) line-based nodes (serial, tcp, udp, etc.)
Definition at line 61 of file interface.h.
◆ AccessOrder
Enumerator |
---|
NEWEST_FIRST | |
OLDEST_FIRST | |
Definition at line 81 of file interface.h.
◆ LineBasedInterface()
goby::util::LineBasedInterface::LineBasedInterface |
( |
const std::string & |
delimiter | ) |
|
◆ ~LineBasedInterface()
virtual goby::util::LineBasedInterface::~LineBasedInterface |
( |
| ) |
|
|
virtual |
◆ active()
bool goby::util::LineBasedInterface::active |
( |
| ) |
|
|
inline |
◆ clear()
void goby::util::LineBasedInterface::clear |
( |
| ) |
|
◆ close()
void goby::util::LineBasedInterface::close |
( |
| ) |
|
◆ delimiter() [1/2]
std::string& goby::util::LineBasedInterface::delimiter |
( |
| ) |
|
|
inlineprotected |
◆ delimiter() [2/2]
std::string goby::util::LineBasedInterface::delimiter |
( |
| ) |
const |
|
inline |
◆ do_close()
virtual void goby::util::LineBasedInterface::do_close |
( |
| ) |
|
|
protectedpure virtual |
◆ do_start()
virtual void goby::util::LineBasedInterface::do_start |
( |
| ) |
|
|
protectedpure virtual |
◆ do_subscribe()
virtual void goby::util::LineBasedInterface::do_subscribe |
( |
| ) |
|
|
protectedpure virtual |
◆ in()
std::deque<goby::util::protobuf::Datagram>& goby::util::LineBasedInterface::in |
( |
| ) |
|
|
inlineprotected |
◆ in_group()
◆ index()
int goby::util::LineBasedInterface::index |
( |
| ) |
|
|
inlineprotected |
◆ interthread()
◆ io_thread_ready()
bool goby::util::LineBasedInterface::io_thread_ready |
( |
| ) |
|
|
inlineprotected |
◆ local_endpoint()
virtual std::string goby::util::LineBasedInterface::local_endpoint |
( |
| ) |
|
|
protectedpure virtual |
◆ out_group()
◆ readline() [1/2]
◆ readline() [2/2]
returns string line (including delimiter)
- Returns
- true if data was read, false if no data to read
◆ remote_endpoint()
virtual std::string goby::util::LineBasedInterface::remote_endpoint |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ set_active()
void goby::util::LineBasedInterface::set_active |
( |
bool |
active | ) |
|
|
inlineprotected |
◆ set_delimiter()
void goby::util::LineBasedInterface::set_delimiter |
( |
const std::string & |
s | ) |
|
|
inline |
◆ sleep()
void goby::util::LineBasedInterface::sleep |
( |
int |
sec | ) |
|
◆ start()
void goby::util::LineBasedInterface::start |
( |
| ) |
|
◆ write() [1/2]
void goby::util::LineBasedInterface::write |
( |
const protobuf::Datagram & |
msg | ) |
|
◆ write() [2/2]
void goby::util::LineBasedInterface::write |
( |
const std::string & |
s | ) |
|
|
inline |
The documentation for this class was generated from the following file: