Added getStream() support.

bakercp · Jul 26, 2019 · 91fdf51 · 91fdf51
1 parent de1bd5a
commit 91fdf51
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 2 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 
-- Updated README.
+- None
 
 ### Removed
 
@@ -27,6 +27,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - None
 
+## [1.4.0] 2019-07-26
+
+### Added
+
+- Added `const Stream* getStream() const` and `Stream* getStream()` methods. Thanks @orgicus.
+
+### Changed
+
+- Updated README.
+
 ## [1.3.0] 2019-07-25
 
 ### Removed

diff --git a/docs/CONTRIBUTORS.md b/docs/CONTRIBUTORS.md
@@ -4,5 +4,6 @@
 - Antoine Villeret [@avilleret](https://github.com/avilleret) - SLIP Encoding.
 - Anton Viktorov [@latonita](https://github.com/latonita) - Bugfixes.
 - [@per1234](https://github.com/per1234) - Metadata.
+- George Profenza [@orgicus](https://github.com/orgicus) - API Suggestions.
 
 _For and up-to-date list of contributors, see [contributors](../graphs/contributors)._
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=PacketSerial
-version=1.3.0
+version=1.4.0
 author=Christopher Baker <info@christopherbaker.net>
 maintainer=Christopher Baker <info@christopherbaker.net>
 sentence=An Arduino Library that facilitates packet-based serial communication using COBS or SLIP encoding.

diff --git a/src/PacketSerial.h b/src/PacketSerial.h
@@ -171,6 +171,30 @@ class PacketSerial_
         _stream = stream;
     }
 
+    /// \brief Get a pointer to the current stream.
+    /// \warning Reading from or writing to the stream managed by PacketSerial_
+    ///          may break the packet-serial protocol if not done so with care. 
+    ///          Access to the stream is allowed because PacketSerial_ never
+    ///          takes ownership of the stream and thus does not have exclusive
+    ///          access to the stream anyway.
+    /// \returns a non-const pointer to the stream, or nullptr if unset.
+    Stream* getStream()
+    {
+        return _stream;
+    }
+
+    /// \brief Get a pointer to the current stream.
+    /// \warning Reading from or writing to the stream managed by PacketSerial_
+    ///          may break the packet-serial protocol if not done so with care. 
+    ///          Access to the stream is allowed because PacketSerial_ never
+    ///          takes ownership of the stream and thus does not have exclusive
+    ///          access to the stream anyway.
+    /// \returns a const pointer to the stream, or nullptr if unset.
+    const Stream* getStream() const
+    {
+        return _stream;
+    }
+
     /// \brief The update function services the serial connection.
     ///
     /// This must be called often, ideally once per `loop()`, e.g.: