Asynchronous serial class with read callback Asynchronous serial class with read callback. User code can write data from one thread, and read data will be reported through a callback called from a separate thred.
More...
#include <AsyncSerial.h>
|
| CallbackAsyncSerial () |
|
| CallbackAsyncSerial (const std::string &devname, unsigned int baud_rate, boost::asio::serial_port_base::parity opt_parity=boost::asio::serial_port_base::parity(boost::asio::serial_port_base::parity::none), boost::asio::serial_port_base::character_size opt_csize=boost::asio::serial_port_base::character_size(8), boost::asio::serial_port_base::flow_control opt_flow=boost::asio::serial_port_base::flow_control(boost::asio::serial_port_base::flow_control::none), boost::asio::serial_port_base::stop_bits opt_stop=boost::asio::serial_port_base::stop_bits(boost::asio::serial_port_base::stop_bits::one)) |
|
void | clearCallback () |
|
void | setCallback (const boost::function< void(const char *, size_t) > &callback) |
|
virtual | ~CallbackAsyncSerial () |
|
| AsyncSerial () |
|
| AsyncSerial (const std::string &devname, unsigned int baud_rate, boost::asio::serial_port_base::parity opt_parity=boost::asio::serial_port_base::parity(boost::asio::serial_port_base::parity::none), boost::asio::serial_port_base::character_size opt_csize=boost::asio::serial_port_base::character_size(8), boost::asio::serial_port_base::flow_control opt_flow=boost::asio::serial_port_base::flow_control(boost::asio::serial_port_base::flow_control::none), boost::asio::serial_port_base::stop_bits opt_stop=boost::asio::serial_port_base::stop_bits(boost::asio::serial_port_base::stop_bits::one)) |
|
void | close () |
|
bool | errorStatus () const |
|
bool | isOpen () const |
|
void | open (const std::string &devname, unsigned int baud_rate, boost::asio::serial_port_base::parity opt_parity=boost::asio::serial_port_base::parity(boost::asio::serial_port_base::parity::none), boost::asio::serial_port_base::character_size opt_csize=boost::asio::serial_port_base::character_size(8), boost::asio::serial_port_base::flow_control opt_flow=boost::asio::serial_port_base::flow_control(boost::asio::serial_port_base::flow_control::none), boost::asio::serial_port_base::stop_bits opt_stop=boost::asio::serial_port_base::stop_bits(boost::asio::serial_port_base::stop_bits::one)) |
|
void | write (const char *data, size_t size) |
|
void | write (const std::vector< char > &data) |
|
void | writeString (const std::string &s) |
|
virtual | ~AsyncSerial () |
|
Asynchronous serial class with read callback Asynchronous serial class with read callback. User code can write data from one thread, and read data will be reported through a callback called from a separate thred.
Definition at line 872 of file AsyncSerial.h.
CallbackAsyncSerial::CallbackAsyncSerial |
( |
| ) |
|
|
inline |
CallbackAsyncSerial::CallbackAsyncSerial |
( |
const std::string & |
devname, |
|
|
unsigned int |
baud_rate, |
|
|
boost::asio::serial_port_base::parity |
opt_parity = boost::asio::serial_port_base::parity ( boost::asio::serial_port_base::parity:: none ) , |
|
|
boost::asio::serial_port_base::character_size |
opt_csize = boost::asio::serial_port_base::character_size ( 8 ) , |
|
|
boost::asio::serial_port_base::flow_control |
opt_flow = boost::asio::serial_port_base::flow_control ( boost::asio::serial_port_base::flow_control:: none ) , |
|
|
boost::asio::serial_port_base::stop_bits |
opt_stop = boost::asio::serial_port_base::stop_bits ( boost::asio::serial_port_base::stop_bits:: one ) |
|
) |
| |
|
inline |
Opens a serial device.
- Parameters
-
devname | serial device name, example "/dev/ttyS0" or "COM1" |
baud_rate | serial baud rate |
opt_parity | serial parity, default none |
opt_csize | serial character size, default 8bit |
opt_flow | serial flow control, default none |
opt_stop | serial stop bits, default 1 |
- Exceptions
-
boost::system::system_error | if cannot open the serial device |
Definition at line 892 of file AsyncSerial.h.
virtual CallbackAsyncSerial::~CallbackAsyncSerial |
( |
| ) |
|
|
inlinevirtual |
void CallbackAsyncSerial::clearCallback |
( |
| ) |
|
|
inline |
Removes the callback. Any data received after this function call will be lost.
Definition at line 924 of file AsyncSerial.h.
void CallbackAsyncSerial::setCallback |
( |
const boost::function< void(const char *, size_t) > & |
callback | ) |
|
|
inline |
Set the read callback, the callback will be called from a thread owned by the CallbackAsyncSerial class when data arrives from the serial port.
- Parameters
-
callback | the receive callback |
Definition at line 915 of file AsyncSerial.h.
The documentation for this class was generated from the following file: