1. /*
  2. * File: BufferedAsyncSerial.h
  3. * Author: Terraneo Federico
  4. * Distributed under the Boost Software License, Version 1.0.
  5. * Created on January 6, 2011, 3:31 PM
  6. */
  8. #include "AsyncSerial.h"
  10. #ifndef BUFFEREDASYNCSERIAL_H
  11. #define BUFFEREDASYNCSERIAL_H
  13. class BufferedAsyncSerial: public AsyncSerial
  14. {
  15. public:
  16. BufferedAsyncSerial();
  18. /**
  19. * Opens a serial device.
  20. * \param devname serial device name, example "/dev/ttyS0" or "COM1"
  21. * \param baud_rate serial baud rate
  22. * \param opt_parity serial parity, default none
  23. * \param opt_csize serial character size, default 8bit
  24. * \param opt_flow serial flow control, default none
  25. * \param opt_stop serial stop bits, default 1
  26. * \throws boost::system::system_error if cannot open the
  27. * serial device
  28. */
  29. BufferedAsyncSerial(const std::string& devname, unsigned int baud_rate,
  30. boost::asio::serial_port_base::parity opt_parity=
  31. boost::asio::serial_port_base::parity(
  32. boost::asio::serial_port_base::parity::none),
  33. boost::asio::serial_port_base::character_size opt_csize=
  34. boost::asio::serial_port_base::character_size(8),
  35. boost::asio::serial_port_base::flow_control opt_flow=
  36. boost::asio::serial_port_base::flow_control(
  37. boost::asio::serial_port_base::flow_control::none),
  38. boost::asio::serial_port_base::stop_bits opt_stop=
  39. boost::asio::serial_port_base::stop_bits(
  40. boost::asio::serial_port_base::stop_bits::one));
  42. /**
  43. * Read some data asynchronously. Returns immediately.
  44. * \param data array of char to be read through the serial device
  45. * \param size array size
  46. * \return numbr of character actually read 0<=return<=size
  47. */
  48. size_t read(char *data, size_t size);
  50. /**
  51. * Read all available data asynchronously. Returns immediately.
  52. * \return the receive buffer. It iempty if no data is available
  53. */
  54. std::vector<char> read();
  56. /**
  57. * Read a string asynchronously. Returns immediately.
  58. * Can only be used if the user is sure that the serial device will not
  59. * send binary data. For binary data read, use read()
  60. * The returned string is empty if no data has arrived
  61. * \return a string with the received data.
  62. */
  63. std::string readString();
  65. /**
  66. * Read a line asynchronously. Returns immediately.
  67. * Can only be used if the user is sure that the serial device will not
  68. * send binary data. For binary data read, use read()
  69. * The returned string is empty if the line delimiter has not yet arrived.
  70. * \param delimiter line delimiter, default='\n'
  71. * \return a string with the received data. The delimiter is removed from
  72. * the string.
  73. */
  74. std::string readStringUntil(const std::string delim="\n");
  76. virtual ~BufferedAsyncSerial();
  78. private:
  80. /**
  81. * Read callback, stores data in the buffer
  82. */
  83. void readCallback(const char *data, size_t len);
  85. /**
  86. * Finds a substring in a vector of char. Used to look for the delimiter.
  87. * \param v vector where to find the string
  88. * \param s string to find
  89. * \return the beginning of the place in the vector where the first
  90. * occurrence of the string is, or v.end() if the string was not found
  91. */
  92. static std::vector<char>::iterator findStringInVector(std::vector<char>& v,
  93. const std::string& s);
  95. std::vector<char> readQueue;
  96. boost::mutex readQueueMutex;
  97. };
  99. #endif //BUFFEREDASYNCSERIAL_H