From b58fb718a78d5a3416cfcad62996bd37228e11d0 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Thu, 9 Sep 2021 16:09:27 +0200 Subject: [PATCH] Added some comments --- source/tristanable/manager.d | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/source/tristanable/manager.d b/source/tristanable/manager.d index f368f67..62f9c7b 100644 --- a/source/tristanable/manager.d +++ b/source/tristanable/manager.d @@ -8,6 +8,22 @@ import tristanable.watcher; import std.container.dlist; import tristanable.exceptions; +/** +* Manager +* +* This is the core class that is to be instantiated +* that represents an instance of the tristanable +* framework. It is passed a Socket from which it +* reads from (using a bformat block reader). +* +* It contains a Watcher which does the reading and +* appending to respective queues (the user need not +* worry about this factum). +* +* The functions provided allow users to wait in a +* tight loop to dequeue ("receive" in a blcoking mannger) +* from a specified queue. +*/ public final class Manager { /* All queues */