Update docs

marcusspangenberg · Jan 11, 2024 · c9a6919 · c9a6919
1 parent c92aafe
commit c9a6919
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Marcus Spangenberg
+Copyright (c) 2024 Marcus Spangenberg
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -54,6 +54,26 @@ if (queue.pop(element)) {
     // queue is empty
 }
 
+
+// Checks if the queue is empty.
+// Returns true if the queue is empty, otherwise false.
+// Not thread safe with regards to pop operations, thread safe with regards to push operations. Regarding
+// thread safety empty() is considered a pop operation.
+
+if (queue.empty()) {
+   // queue is empty
+}
+
+
+// Checks if the queue is full.
+// Returns true if the queue is full, otherwise false.
+// Thread safe with regards to pop operations and to push operations. Regarding thread safety, full() is considered
+// a push operation.
+
+if (queue.full()) {
+    // queue is full
+}
+
 ```
 
 # License

diff --git a/WaitFreeMPSCQueue.h b/WaitFreeMPSCQueue.h
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2023 Marcus Spangenberg
+Copyright (c) 2024 Marcus Spangenberg
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal