Merge pull request #32 from DNedic/optional_function_overloads

feat(): Use function overloads for std::optional API

Author: DNedic

docs/mpmc/priority_queue.md

@@ -30,7 +30,7 @@ if (read_success) {
 
 There is also a `std::optional` API for `Pop`:
 ```c
-auto read = queue_events.PopOptional();
+auto read = queue_events.Pop();
 
 if (read) {
     actor2.ProcessEvent(read);

docs/mpmc/queue.md

@@ -30,7 +30,7 @@ if (read_success) {
 
 There is also a `std::optional` API for the `Pop` method:
 ```c
-auto job = queue_jobs.PopOptional();
+auto job = queue_jobs.Pop();
 
 if (job) {
     worker.ProcessJob(read);

docs/spsc/priority_queue.md

@@ -30,7 +30,7 @@ if (read_success) {
 
 There is also a `std::optional` API for `Pop`:
 ```c
-auto read = queue_events.PopOptional();
+auto read = queue_events.Pop();
 
 if (read) {
     actor2.ProcessEvent(read);

docs/spsc/queue.md

@@ -30,7 +30,7 @@ if (read_success) {
 
 There is also a `std::optional` API for the `Pop` method:
 ```c
-auto read = queue_adc.PopOptional();
+auto read = queue_adc.Pop();
 
 if (read) {
     DoStuffWithData(read);

lockfree/mpmc/priority_queue.hpp

@@ -83,7 +83,7 @@ template <typename T, size_t size, size_t priority_count> class PriorityQueue {
      * Should only be called from the consumer thread.
      * @retval Either the element or nothing if the queue is empty.
      */
-    std::optional<T> PopOptional();
+    std::optional<T> Pop();
 #endif
 
     /********************** PRIVATE MEMBERS ***********************/

lockfree/mpmc/priority_queue_impl.hpp

@@ -68,7 +68,7 @@ bool PriorityQueue<T, size, priority_count>::Pop(T &element) {
 /********************* std::optional API **********************/
 #if __cplusplus >= 201703L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
 template <typename T, size_t size, size_t priority_count>
-std::optional<T> PriorityQueue<T, size, priority_count>::PopOptional() {
+std::optional<T> PriorityQueue<T, size, priority_count>::Pop() {
     T element;
     bool result = Pop(element);
 

lockfree/mpmc/queue.hpp

@@ -80,7 +80,7 @@ template <typename T, size_t size> class Queue {
      * @brief Removes an element from the queue.
      * @retval Either the element or nothing
      */
-    std::optional<T> PopOptional();
+    std::optional<T> Pop();
 #endif
 
     /*********************** PRIVATE TYPES ************************/

lockfree/mpmc/queue_impl.hpp

@@ -113,8 +113,7 @@ template <typename T, size_t size> bool Queue<T, size>::Pop(T &element) {
 
 /********************* std::optional API **********************/
 #if __cplusplus >= 201703L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
-template <typename T, size_t size>
-std::optional<T> Queue<T, size>::PopOptional() {
+template <typename T, size_t size> std::optional<T> Queue<T, size>::Pop() {
     T element;
     bool result = Pop(element);
 

lockfree/spsc/priority_queue.hpp

@@ -84,7 +84,7 @@ template <typename T, size_t size, size_t priority_count> class PriorityQueue {
      * Should only be called from the consumer thread.
      * @retval Either the element or nothing if the queue is empty.
      */
-    std::optional<T> PopOptional();
+    std::optional<T> Pop();
 #endif
 
     /********************** PRIVATE MEMBERS ***********************/

lockfree/spsc/priority_queue_impl.hpp

@@ -69,7 +69,7 @@ bool PriorityQueue<T, size, priority_count>::Pop(T &element) {
 /********************* std::optional API **********************/
 #if __cplusplus >= 201703L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
 template <typename T, size_t size, size_t priority_count>
-std::optional<T> PriorityQueue<T, size, priority_count>::PopOptional() {
+std::optional<T> PriorityQueue<T, size, priority_count>::Pop() {
     T element;
     bool result = Pop(element);