#include <goby/acomms/modemdriver/store_server_driver.h>
|
template<typename StoreServerMessage > |
static void | parse_store_server_message (const std::string &bytes, StoreServerMessage *msg) |
|
template<typename StoreServerMessage > |
static void | serialize_store_server_message (const StoreServerMessage &msg, std::string *bytes) |
|
static std::string | driver_name (const protobuf::DriverConfig &cfg) |
| Unique driver name (e.g. UDP_MULTICAST::1 or my_driver_name::2) More...
|
|
|
boost::signals2::signal< void(const protobuf::ModemTransmission &message)> | signal_receive |
| Called when a binary data transmission is received from the modem. More...
|
|
boost::signals2::signal< void(const protobuf::ModemTransmission &message)> | signal_transmit_result |
| Called when a transmission is completed. More...
|
|
boost::signals2::signal< void(protobuf::ModemTransmission *msg)> | signal_data_request |
| Called when the modem or modem driver needs data to send. The returned data should be stored in ModemTransmission::frame. More...
|
|
boost::signals2::signal< void(protobuf::ModemTransmission *msg_request)> | signal_modify_transmission |
| Called before the modem driver begins processing a transmission. This allows a third party to modify the parameters of the transmission (such as destination or rate) on the fly. More...
|
|
boost::signals2::signal< void(const protobuf::ModemRaw &msg)> | signal_raw_incoming |
| Called after any message is received from the modem by the driver. Used by the MACManager for auto-discovery of vehicles. Also useful for higher level analysis and debugging of the transactions between the driver and the modem. More...
|
|
boost::signals2::signal< void(const protobuf::ModemRaw &msg)> | signal_raw_outgoing |
| Called after any message is sent from the driver to the modem. Useful for higher level analysis and debugging of the transactions between the driver and the modem. More...
|
|
| ModemDriverBase () |
| Constructor. More...
|
|
void | modem_write (const std::string &out) |
| write a line to the serial port. More...
|
|
bool | modem_read (std::string *in) |
| read a line from the serial port, including end-of-line character(s) More...
|
|
void | modem_start (const protobuf::DriverConfig &cfg, bool modem_connection_expected=true) |
| start the physical connection to the modem (serial port, TCP, etc.). must be called before ModemDriverBase::modem_read() or ModemDriverBase::modem_write() More...
|
|
void | modem_close () |
| closes the serial port. Use modem_start to reopen the port. More...
|
|
const std::string & | glog_out_group () const |
|
const std::string & | glog_in_group () const |
|
util::LineBasedInterface & | modem () |
| use for direct access to the modem More...
|
|
static std::atomic< int > | count_ |
|
Definition at line 38 of file store_server_driver.h.
◆ StoreServerDriver()
goby::acomms::StoreServerDriver::StoreServerDriver |
( |
| ) |
|
◆ do_work()
void goby::acomms::StoreServerDriver::do_work |
( |
| ) |
|
|
virtual |
Allows the modem driver to do its work.
Should be called regularly to perform the work of the driver as the driver does not run in its own thread. This allows us to guarantee that no signals are called except inside this method. Does not block.
Implements goby::acomms::ModemDriverBase.
◆ handle_initiate_transmission()
void goby::acomms::StoreServerDriver::handle_initiate_transmission |
( |
const protobuf::ModemTransmission & |
m | ) |
|
|
virtual |
◆ parse_store_server_message()
template<typename StoreServerMessage >
static void goby::acomms::StoreServerDriver::parse_store_server_message |
( |
const std::string & |
bytes, |
|
|
StoreServerMessage * |
msg |
|
) |
| |
|
inlinestatic |
◆ serialize_store_server_message()
template<typename StoreServerMessage >
static void goby::acomms::StoreServerDriver::serialize_store_server_message |
( |
const StoreServerMessage & |
msg, |
|
|
std::string * |
bytes |
|
) |
| |
|
inlinestatic |
◆ shutdown()
void goby::acomms::StoreServerDriver::shutdown |
( |
| ) |
|
|
virtual |
◆ startup()
void goby::acomms::StoreServerDriver::startup |
( |
const protobuf::DriverConfig & |
cfg | ) |
|
|
virtual |
◆ default_port
constexpr static int goby::acomms::StoreServerDriver::default_port {11244} |
|
staticconstexpr |
◆ eol
constexpr static const char* goby::acomms::StoreServerDriver::eol {"\r"} |
|
staticconstexpr |
The documentation for this class was generated from the following file: