Add queue pages

docs/pages/api/queue/begin.md

@@ -0,0 +1,11 @@
+# `bulk::queue::begin`
+
+```cpp
+iterator begin();
+```
+
+Obtain an iterator to the begin of the local queue.
+
+## Return value
+
+- an iterator to the begin of the local queue

docs/pages/api/queue/constructor.md

@@ -0,0 +1,11 @@
+# `bulk::queue::queue`
+
+```cpp
+queue(world& world);
+```
+
+Constructs a message queue for use in `world`.
+
+## Parameters
+
+* `world` - the world this queue belongs to

docs/pages/api/queue/deconstructor.md

@@ -0,0 +1,7 @@
+# `bulk::queue::~queue`
+
+```cpp
+~queue();
+```
+
+Deconstructs a queue, clears and deregisters it.

docs/pages/api/queue/empty.md

@@ -0,0 +1,11 @@
+# `bulk::queue::empty`
+
+```cpp
+bool empty() const;
+```
+
+Checks whether the inbox is empty.
+
+## Return value
+
+- `true` if the inbox is empty, `false` otherwise.

docs/pages/api/queue/end.md

@@ -0,0 +1,11 @@
+# `bulk::queue::end`
+
+```cpp
+iterator end();
+```
+
+Obtain an iterator to the end of the local queue.
+
+## Return value
+
+- an iterator to the end of the local queue

docs/pages/api/queue/sender.md

@@ -0,0 +1,16 @@
+# `bulk::queue::sender`
+
+Defined in header `<bulk/messages.hpp>`.
+
+```cpp
+class sender
+```
+
+Provides a way to send messages to remote queues.
+
+## Member functions
+
+|                                                 |                                               |
+|-------------------------------------------------|-----------------------------------------------|
+| **Value access**                                |                                               |
+| [`send`](sender/send.md) | assign values to the variable                 |

docs/pages/api/queue/sender/send.md

@@ -0,0 +1,16 @@
+# `bulk::queue::sender::send`
+
+```cpp
+template <typename... Us>
+void send(Us... args)
+```
+
+Send a message to a remote queue
+
+## Parameters
+
+* `args` - the content to send
+
+## Complexity and cost
+
+* **Cost** - `sizeof(Us...) * g`

docs/pages/api/queue/size.md

@@ -0,0 +1,11 @@
+# `bulk::queue::size`
+
+```cpp
+size_t size() const;
+```
+
+Obtain the number of messages in the local queue.
+
+## Return value
+
+- the number of messages in the local queue

docs/pages/api/queue/world.md

@@ -0,0 +1,11 @@
+# `bulk::queue::world`
+
+```cpp
+bulk::world& world();
+```
+
+Returns a reference to the world the queue belongs to
+
+## Return value
+
+- A reference to the world.