Renamed method to get num. of RX bytes to 'Available'. Updated CHANGELOG.

Geoffrey Hunter
1 parent eb5698ae
Showing 3 changed files with 10 additions and 6 deletions
CHANGELOG.md
include/CppLinuxSerial/SerialPort.hpp
src/SerialPort.cpp
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+## [v2.4.0] - 2022-02-12
+
+- Added `Available()` method to return number of bytes ready to be read from the receive buffer (thanks lotricekCZ).
+- Added CMake option for shared library (thanks lotricekCZ).
+
 ## [v2.3.0] - 2021-12-23
 - Added support for setting the num. data bits.
@@ -168,13 +168,12 @@ namespace mn {
             /// \throws		CppLinuxSerial::Exception if state != OPEN.
             void ReadBinary(std::vector<uint8_t>& data);
-			/// \brief		Use to get number of bytes available in buffer
+			/// \brief		Use to get number of bytes available in receive buffer.
+            /// \returns    The number of bytes available in the receive buffer (ready to be read).
             /// \throws		CppLinuxSerial::Exception if state != OPEN.
-            int32_t InWaiting();
-        private:
+            int32_t Available();
-            /// \brief		Returns a populated termios structure for the passed in file descriptor.
-            // termios GetTermios();
+        private:
             /// \brief		Configures the tty device as a serial port.
             /// \warning    Device must be open (valid file descriptor) when this is called.
@@ -630,7 +630,7 @@ namespace CppLinuxSerial {
         timeout_ms_ = timeout_ms;
     }
-    int32_t SerialPort::InWaiting() {
+    int32_t SerialPort::Available() {
 		if(state_ != State::OPEN)
             THROW_EXCEPT(std::string() + __PRETTY_FUNCTION__ + " called but state != OPEN. Please call Open() first.");
         int32_t ret = 0;