From 4528273931c75380604f94f0b5a99a7f476b3333 Mon Sep 17 00:00:00 2001 From: Jan-Wilem Buurlage Date: Thu, 1 Jun 2017 17:40:50 +0200 Subject: [PATCH] Add queue pages --- docs/pages/api/queue/begin.md | 11 +++++++++++ docs/pages/api/queue/constructor.md | 11 +++++++++++ docs/pages/api/queue/deconstructor.md | 7 +++++++ docs/pages/api/queue/empty.md | 11 +++++++++++ docs/pages/api/queue/end.md | 11 +++++++++++ docs/pages/api/queue/sender.md | 16 ++++++++++++++++ docs/pages/api/queue/sender/send.md | 16 ++++++++++++++++ docs/pages/api/queue/size.md | 11 +++++++++++ docs/pages/api/queue/world.md | 11 +++++++++++ 9 files changed, 105 insertions(+) create mode 100644 docs/pages/api/queue/begin.md create mode 100644 docs/pages/api/queue/constructor.md create mode 100644 docs/pages/api/queue/deconstructor.md create mode 100644 docs/pages/api/queue/empty.md create mode 100644 docs/pages/api/queue/end.md create mode 100644 docs/pages/api/queue/sender.md create mode 100644 docs/pages/api/queue/sender/send.md create mode 100644 docs/pages/api/queue/size.md create mode 100644 docs/pages/api/queue/world.md diff --git a/docs/pages/api/queue/begin.md b/docs/pages/api/queue/begin.md new file mode 100644 index 00000000..443fdb6b --- /dev/null +++ b/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 diff --git a/docs/pages/api/queue/constructor.md b/docs/pages/api/queue/constructor.md new file mode 100644 index 00000000..43ceb396 --- /dev/null +++ b/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 diff --git a/docs/pages/api/queue/deconstructor.md b/docs/pages/api/queue/deconstructor.md new file mode 100644 index 00000000..921bc43d --- /dev/null +++ b/docs/pages/api/queue/deconstructor.md @@ -0,0 +1,7 @@ +# `bulk::queue::~queue` + +```cpp +~queue(); +``` + +Deconstructs a queue, clears and deregisters it. diff --git a/docs/pages/api/queue/empty.md b/docs/pages/api/queue/empty.md new file mode 100644 index 00000000..3fb2b275 --- /dev/null +++ b/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. diff --git a/docs/pages/api/queue/end.md b/docs/pages/api/queue/end.md new file mode 100644 index 00000000..98b37515 --- /dev/null +++ b/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 diff --git a/docs/pages/api/queue/sender.md b/docs/pages/api/queue/sender.md new file mode 100644 index 00000000..1962f317 --- /dev/null +++ b/docs/pages/api/queue/sender.md @@ -0,0 +1,16 @@ +# `bulk::queue::sender` + +Defined in header ``. + +```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 | diff --git a/docs/pages/api/queue/sender/send.md b/docs/pages/api/queue/sender/send.md new file mode 100644 index 00000000..6f784cde --- /dev/null +++ b/docs/pages/api/queue/sender/send.md @@ -0,0 +1,16 @@ +# `bulk::queue::sender::send` + +```cpp +template +void send(Us... args) +``` + +Send a message to a remote queue + +## Parameters + +* `args` - the content to send + +## Complexity and cost + +* **Cost** - `sizeof(Us...) * g` diff --git a/docs/pages/api/queue/size.md b/docs/pages/api/queue/size.md new file mode 100644 index 00000000..51bb4d0f --- /dev/null +++ b/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 diff --git a/docs/pages/api/queue/world.md b/docs/pages/api/queue/world.md new file mode 100644 index 00000000..93d5ddb6 --- /dev/null +++ b/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.