From e27be0a4d917bf2b9d0b25f4b01272aff1bf9503 Mon Sep 17 00:00:00 2001
From: alikia2x <alikia2x@outlook.com>
Date: Tue, 11 Feb 2025 16:07:25 +0000
Subject: [PATCH] doc: GitBook - No subject

---
 doc/en/SUMMARY.md                                  |  2 ++
 doc/en/architecure/message-queue/README.md         |  2 ++
 doc/en/architecure/message-queue/videotagsqueue.md | 11 +++++++++++
 3 files changed, 15 insertions(+)
 create mode 100644 doc/en/architecure/message-queue/README.md
 create mode 100644 doc/en/architecure/message-queue/videotagsqueue.md

diff --git a/doc/en/SUMMARY.md b/doc/en/SUMMARY.md
index e40326e..5137229 100644
--- a/doc/en/SUMMARY.md
+++ b/doc/en/SUMMARY.md
@@ -12,6 +12,8 @@
 * [Overview](architecure/overview.md)
 * [Database Structure](architecure/database-structure/README.md)
   * [Type of Song](architecure/database-structure/type-of-song.md)
+* [Message Queue](architecure/message-queue/README.md)
+  * [VideoTagsQueue](architecure/message-queue/videotagsqueue.md)
 * [Artificial Intelligence](architecure/artificial-intelligence.md)
 
 ## API Doc
diff --git a/doc/en/architecure/message-queue/README.md b/doc/en/architecure/message-queue/README.md
new file mode 100644
index 0000000..d0a8349
--- /dev/null
+++ b/doc/en/architecure/message-queue/README.md
@@ -0,0 +1,2 @@
+# Message Queue
+
diff --git a/doc/en/architecure/message-queue/videotagsqueue.md b/doc/en/architecure/message-queue/videotagsqueue.md
new file mode 100644
index 0000000..bdddddb
--- /dev/null
+++ b/doc/en/architecure/message-queue/videotagsqueue.md
@@ -0,0 +1,11 @@
+# VideoTagsQueue
+
+### Jobs
+
+The VideoTagsQueue contains two jobs: `getVideoTags`and `getVideosTags`. The former is used to fetch the tags of a video, and the latter is responsible for scheduling the former.
+
+### Return value
+
+The return values across two jobs follows the following table:
+
+<table><thead><tr><th width="168">Return Value</th><th>Description</th></tr></thead><tbody><tr><td>0</td><td>In <code>getVideoTags</code>: the tags was successfully fetched<br>In <code>getVideosTags</code>: all null-tags videos have a corresponding job successfully queued.</td></tr><tr><td>1</td><td>Used in <code>getVideoTags</code>: occured <code>fetch</code>error during the job</td></tr><tr><td>2</td><td>Used in <code>getVideoTags</code>: we've reached the rate limit set in NetScheduler</td></tr><tr><td>3</td><td>Used in <code>getVideoTags</code>: did't provide aid in the job data</td></tr><tr><td>4</td><td>Used in<code>getVideosTags</code>: There's no video with NULL as `tags`</td></tr><tr><td>1xx</td><td>Used in<code>getVideosTags</code>:  the number of tasks in the queue has exceeded the limit, thus <code>getVideosTags</code> stops adding tasks. <code>xx</code> is the number of jobs added to the queue during execution.</td></tr></tbody></table>