@aj-shadow/actorjs-documentation-text 0.0.0-aj-beta.221

package/Documentation/markup/Document-global-markup-test-suite.txt

@@ -0,0 +1,13 @@
+# **Markup - Test Suite**
+[[DOC-STATUS=PARTLY, ]]
+
+Test Suite Markup defines a [Test Suite](test-suites) and it provides the documentation with test suite images. 
+
+```ts
+|TestSuiteAbstraction                                         |
+|name                                    |execution|iterations|
+|tc.ImageService.Image.ImagePng-1        |         |          |
+|tc.ImageService.Image.ImagePng-2        |         |          |
+|tc.ImageService.Image.ImagePng-2-Denmark|         |          |
+|                                        |         |          |
+```

package/Documentation/markup/embed/Document-global-inner_markup_tc.txt

@@ -0,0 +1,164 @@
+[[ANCHOR={"id":"7c3d5bab-2152-4273-9377-cca6ee528f56","visible":true}]]
+[[NOTE={"guid":"b6bb056c-9776-4157-94c4-1b86ab08b92e"}]]
+### **Example**
+Here is a simple example. The Orig client will get an image from the Term server with the http protocol.
+```seq
+Nodes[Orig, Term]
+Orig => Term[http]: Get /image
+Term => Orig[http]: 200 Ok
+```
+In the Actor table the [[REF=, ABS_Actor]]s to be used are defined. How they are executed and in which phase they will be executed in are defined. The [[REF=, ABS_Addressing_Address]]es are also chosen and some [[REF=, ABS_Test_Data]] might be set. 
+```tc
+|Actor                                                                                                                   |
+|name                                         |node|type|phase|execution|src     |dst     |srv     |testData|verification|
+|Actors-global.stack.stacks.http.HttpGetOkOrig|    |orig|exec |         |testSrc1|testSrv1|        |        |            |
+|Actors-global.stack.stacks.http.HttpGetOkTerm|    |term|exec |         |        |        |testSrv1|        |            |
+|                                             |    |    |     |         |        |        |        |        |            |
+
+|TestDataTestCase                   |
+|key         |value     |description|
+|content-name|pettersson|           |
+|            |          |           |
+
+|VerificationTestCase                              |
+|key         |value     |operation|type|description|
+|content-name|pettersson|         |    |           |
+|            |          |         |    |           |
+```
+
+## **Markup Tables**
+[TestCaseSettings](#TestCaseSettings)
+[Actor](#Actor)
+[TestDataTestCase](#TestDataTestCase)
+[VerificationTestCase](#VerificationTestCase)
+
+[[ANCHOR={"id":"TestCaseSettings","visible":true}]]
+[[NOTE={"guid":"e14aa0e0-cf69-4e3a-94e2-781d587d0d7f"}]]
+### **Table TestCaseSettings**
+The TestCaseSettings table makes it possible to verify different results from the tool.
+```tc
+|TestCaseSettings               |
+|preResult|execResult|postResult|
+|error    |failure   |success   |
+|         |          |          |
+```
+
+```table
+Config(classHeading: )
+
+|Parameters                                                                                |
+|Name      |Type                                                                           |
+|preResult |The expected result of the pre-condition phase of the [[REF=, ABS_Test_Case]]. |
+|execResult|The expected result of the execution phase of the [[REF=, ABS_Test_Case]].     |
+|postResult|The expected result of the post-condition phase of the [[REF=, ABS_Test_Case]].|
+```
+
+#### **Possible values in the table**
+[[EMBED=abstractions/test-case/test-case-result]]
+
+**note:** this table *should never* be used when building normal [[REF=, ABS_Test_Case]]s. A real [[REF=, ABS_Test_Case]] must always expect [[RESULT=success]] to succeed. If a real [[REF=, ABS_Test_Case]] tests an error code it must verify that it gets the correct error code and then the result of the [[REF=, ABS_Test_Case]] will be [[RESULT=success]].
+
+[[ANCHOR={"id":"Actor","visible":true}]]
+[[NOTE={"guid":"c1f0fba0-8226-4a07-9e99-04c241fd229d"}]]
+### **Table Actor**
+The Actor table defines which [[REF=, ABS_Actor]]s to use and when they are executed. The [[REF=Addresses, ABS_Addressing]] to use and [[REF=, ABS_Actor]] specific [[REF=, ABS_Test_Data]].
+```tc
+|Actor                                                                                                                   |
+|name                                         |node|type|phase|execution|src     |dst     |srv     |testData|verification|
+|Actors-global.stack.stacks.http.HttpGetOkOrig|    |orig|exec |         |testSrc1|testSrv1|        |        |            |
+|Actors-global.stack.stacks.http.HttpGetOkTerm|    |term|exec |         |        |        |testSrv1|        |            |
+|                                             |    |    |     |         |        |        |        |        |            |
+```
+
+
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+|Name        |Type                                                                                                                                                                                                                                                                                                                                                                                                        |Default                                                                                             |Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+|name        |[[REF=,MDN_string]]                                                                                                                                                                                                                                                                                                                                                                                         |                                                                                                    |The markup name of the [[REF=,ABS_Actor]].                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+|type        |<**enum**>                                                                                                                                                                                                                                                                                                                                                                                            |                                                                                                    |The type of [[REF=,ABS_Actor]]; [[REF=,ABS_Actor_orig]] | [[REF=,ABS_Actor_term]] | [[REF=,ABS_Actor_proxy]] | [[REF=,ABS_Actor_local]] | [[REF=,ABS_Actor_cond]].                                                                                                                                                                                                                                                                                                                                                                                                                         |
+|phase       |<**enum**>                                                                                                                                                                                                                                                                                                                                                                                            |[[REF=,ABS_Actor_cond]] == type ?  [[REF=,ABS_Actor_Phase_pre_post]] : [[REF=,ABS_Actor_Phase_exec]]|The [[REF=,ABS_Actor_Phase]] the [[REF=,ABS_Actor]] will run in; [[REF=,ABS_Actor_Phase_pre]] | [[REF=,ABS_Actor_Phase_exec]] | [[REF=,ABS_Actor_Phase_post]]. **special case**: an [[REF=,ABS_Actor_Condition]] will be executed in both the [[REF=,ABS_Actor_Phase_Precondition]] and the [[REF=,ABS_Actor_Phase_Postcondition]]; [[REF=,ABS_Actor_Phase_pre_post]].                                                                                                                                                                                                                                                   |
+|execution   |&lt;**enum**&gt;                                                                                                                                                                                                                                                                                                                                                                                            |                                                                                                    |The start dependencies between [[REF=,ABS_Actor]]s. [[REF=,ABS_Actor_Execution_serial]]&#160;&#124;&#160;[[REF=,ABS_Actor_Execution_parallel]]&#160;&#124;&#160;[[REF=,ABS_Actor_Execution_dependency]].<br>[[REF=,ABS_Actor_Execution_serial]]: The [[REF=,ABS_Actor]] will be executed after the previous [[REF=,ABS_Actor]] has finished. <br>[[REF=,ABS_Actor_Execution_parallel]]: The [[REF=,ABS_Actor]] will be executed at the same time as the previous [[REF=,ABS_Actor]].<br>[[REF=,ABS_Actor_Execution_dependency]]: ***`Not Implemented`*** The [[REF=,ABS_Actor]] will be executed when the dependency [[REF=,ABS_Actor]]s have finished.|
+|src         |[[REF=,MDN_string]]&#160;&#124;&#160;[[REF=,MDN_strings]]                                                                                                                                                                                                                                                                                                                                                   |                                                                                                    |Then name or names of the [[REF=, TOOL_Addressing_Src]]es to us by the [[REF=,ABS_Actor]].<br /> * If **src** is a [[REF=,MDN_string]] the [[REF=,ABS_Actor]] can access that address.<br /> *  If **src** is an [[REF=,MDN_strings]] the [[REF=,ABS_Actor]] can access several addresses by using the the connection option **srcIndex**, see [[REF=,API_Actor_Client_Stack_Create_Connection]] in the [[REF=,API_Actor_Client_Stack]].                                                                                                                                                                                                                                |
+|dst         |[[REF=,MDN_string]]&#160;&#124;&#160;[[REF=,MDN_strings]]<br />[ [[REF=,MDN_string]]&#160;&#124;&#160;[ [[REF=,MDN_string]], [[REF=,MDN_string]] ] ]                                                                                                                                                                                                                                                                                |                                                                                                    |Then name or names of the [[REF=, TOOL_Addressing_Dst]]es to us by the [[REF=,ABS_Actor]].<br /> * If **dst** is a [[REF=,MDN_string]] the [[REF=,ABS_Actor]] can access that address.<br />*  If **dst** is an [[REF=,MDN_strings]] or an [ [[REF=,MDN_string]]&#160;&#124;&#160; [ [[REF=,MDN_string]], [[REF=,MDN_string]] ] ] the [[REF=,ABS_Actor]] can access several addresses by using the the connection option **dstIndex**, see [[REF=,API_Actor_Client_Stack_Create_Connection]] in the [[REF=,API_Actor_Client_Stack]].<br /> * If **dst** is an [ [[REF=,MDN_string]]&#160;&#124;&#160;[ [[REF=,MDN_string]], [[REF=,MDN_string]] ] the Array with two strings is used when the address is an uri which connects to a proxy.<br />&#160;&#160;&#160; * **First address** is a **gui** address containing the **uri**. If the second parameter is missing, the **uri** will be used for a **DNS** lookup to decide where to connect.<br />&#160;&#160;&#160; * **Second address** is an **ip** address containing the proxy address, which to connect to.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+|srv         |[[REF=,MDN_string]]&#160;&#124;&#160;[[REF=,MDN_strings]]                                                                                                                                                                                                                                                                                                                                                   |                                                                                                    |Then name or names of the [[REF=, TOOL_Addressing_Srv]]es to us by the [[REF=,ABS_Actor]].                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+|testData    |[[[[REF=,MDN_string]], ***value***, [[REF=,MDN_string]]], ..., []]<br />***value***: [[REF=,MDN_string]]&#160;&#124;&#160;[[REF=,MDN_strings]]&#160;&#124;&#160;[[REF=,MDN_arraystrings]]<br>[[REF=,MDN_number]]&#160;&#124;&#160;[[REF=,MDN_numbers]]&#160;&#124;&#160;[[REF=,MDN_arraynumbers]]<br>[[REF=,MDN_boolean]]&#160;&#124;&#160;[[REF=,MDN_booleans]]&#160;&#124;&#160;[[REF=,MDN_arraybooleans]]|                                                                                                    |An outer [[REF=,MDN_Array]] with inner [[REF=,MDN_Array]]s containing [[REF=,ABS_Test_Data]]. The inner [[REF=,MDN_Array]]s contains two or three parameters.<br /> The first parameter is the ***key*** and is **Mandatory**.<br /> The second parameter is the ***value*** and is **Mandatory**.<br /> The third parameter is the ***description*** and it is ***Optional***.                                                                                                                                                                                                                                                                        |
+|verification|[[REF=,MDN_string]]&#160;&#124;&#160;[[REF=,MDN_strings]]&#160;&#124;&#160;[[REF=,MDN_arraystrings]]<br>[[REF=,MDN_number]]&#160;&#124;&#160;[[REF=,MDN_numbers]]&#160;&#124;&#160;[[REF=,MDN_arraynumbers]]<br>[[REF=,MDN_boolean]]&#160;&#124;&#160;[[REF=,MDN_booleans]]&#160;&#124;&#160;[[REF=,MDN_arraybooleans]]                                                                                     |                                                                                                    |`Not documented yet.`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+```
+
+[[ANCHOR={"id":"e77ad2af-36dc-416e-aa29-6ebab24a9904","visible":true}]]
+[[NOTE={"guid":"489f1f11-c39c-43b6-9955-7b184118baa0"}]]
+### **Table TestDataTestCase**
+The TestDataTestCase table defines [[REF=, ABS_Test_Data]] that are specific for current [[REF=, ABS_Test_Case]]. All [[REF=, ABS_Actor]]s can access the [[REF=, ABS_Test_Data]] defined in the TestDataTestCase table.
+```tc
+|TestDataTestCase                                 |
+|key         |value     |description              |
+|content-name|pettersson|An image of Mr Pettersson|
+|age         |33        |The age of Mr Pettersson |
+|            |          |                         |
+```
+
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                                                                                                                                                                                                     |
+|Name       |Type                                                                                                                                                                                                                                                                                                                                          |Description                                         |
+|key        |[[REF=,MDN_string]]                                                                                                                                                                                                                                                                                                                           |The ***name*** of the [[REF=, ABS_Test_Data]].      |
+|value      |[[REF=,MDN_string]]&#160;&#124;&#160;[[REF=,MDN_strings]]&#160;&#124;&#160;[[REF=,MDN_arraystrings]]<br>[[REF=,MDN_number]]&#160;&#124;&#160;[[REF=,MDN_numbers]]&#160;&#124;&#160;[[REF=,MDN_arraynumbers]]<br>[[REF=,MDN_boolean]]&#160;&#124;&#160;[[REF=,MDN_booleans]]&#160;&#124;&#160;[[REF=,MDN_arraybooleans]]<br>[[REF=,MDN_object]]|The ***value*** of the [[REF=, ABS_Test_Data]].     |
+|description|[[REF=,MDN_string]]                                                                                                                                                                                                                                                                                                                           |Optional description of the [[REF=, ABS_Test_Data]].|
+```
+
+[[ANCHOR={"id":"6b149b2d-2fae-4576-856a-0349d2542e8f","visible":true}]]
+[[NOTE={"guid":"ba59fe83-7728-46bd-9063-88eedd8a4b10"}]]
+### **Table VerificationTestCase**
+The VerificationTestCase table defines [[REF=, ABS_Verification_Data]] that are specific for current [[REF=, ABS_Test_Case]]. All [[REF=, ABS_Actor]]s can access the [[REF=, ABS_Verification_Data]] defined in the VerificationTestCase table.
+
+```tc
+|VerificationTestCase                              |
+|key         |value     |operation|type|description|
+|content-name|pettersson|         |    |           |
+|            |          |         |    |           |
+```
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                                                                                                                                                                                                                                |
+|Name       |Type                                                                                                                                                                                                                                                                                                                                          |Default|Description                                                            |
+|key        |[[REF=,MDN_string]]                                                                                                                                                                                                                                                                                                                           |       |The ***name*** of the [[REF=, ABS_Verification_Data]].                 |
+|value      |[[REF=,MDN_string]]&#160;&#124;&#160;[[REF=,MDN_strings]]&#160;&#124;&#160;[[REF=,MDN_arraystrings]]<br>[[REF=,MDN_number]]&#160;&#124;&#160;[[REF=,MDN_numbers]]&#160;&#124;&#160;[[REF=,MDN_arraynumbers]]<br>[[REF=,MDN_boolean]]&#160;&#124;&#160;[[REF=,MDN_booleans]]&#160;&#124;&#160;[[REF=,MDN_arraybooleans]]<br>[[REF=,MDN_object]]|       |The ***value*** of the [[REF=, ABS_Verification_Data]].                |
+|operation  |===&#160;&#124;&#160;!==&#160;&#124;&#160;=\=&#160;&#124;&#160;!\=&#160;&#124;&#160;<&#160;&#124;&#160;<=&#160;&#124;&#160;>&#160;&#124;&#160;>=                                                                                                                                                                                              |===    |The operation to use when verifing the [[REF=, ABS_Verification_Data]].|
+|type       |                                                                                                                                                                                                                                                                                                                                              |string |The type of the ***value*** of the [[REF=, ABS_Verification_Data]].    |
+|description|[[REF=,MDN_string]]                                                                                                                                                                                                                                                                                                                           |       |Optional description of the [[REF=, ABS_Verification_Data]].           |
+```
+
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>

package/Documentation/nodejs-api/Document-global-fs.txt

@@ -0,0 +1,7 @@
+# **Fs API**
+[[API-STATUS=EXPERIMENTAL, ]]
+[[DOC-STATUS=NOT-YET, ]]
+
+[[NOTE={"guid":"2d4402ac-4c7b-4784-addb-3cbc5d12b609"}]]
+[[ANCHOR={"id":"b27ddff4-48d8-42c3-a7fe-7e3d216d0b84","visible":true}]]
+## **Description**

package/Documentation/stack-api/Document-global-ascii-dictionary.txt

@@ -0,0 +1,108 @@
+# **AsciiDictionary API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=PARTLY, ]]
+
+[[NOTE={"guid":"18019ed6-865e-411b-b2f3-503b21f8ff35"}]]
+[[ANCHOR={"id":"422737c3-bc67-47e1-bb5d-9e354c538990","visible":true}]]
+## **Description**
+AsciiDictionary is a helper API to make text more readable.
+
+AsciiDictionary API implementation is in [[REF=, CODE_AsciiDictionary]].
+
+[[NOTE={"guid":"4527d04b-e157-4435-ae84-89b7ac8436c9"}]]
+[[ANCHOR={"id":"584b54ee-c5bb-4cae-b0e2-34c4402bcdf3","visible":true}]]
+## **API Methods**
+* **[getSymbolString](#stack-api-log-ascii-dictionary-getSymbolString)**
+* **[getSymbol](#stack-api-log-ascii-dictionary-getSymbol)**
+* **[getHtmlName](#stack-api-log-ascii-dictionary-getHtmlName)**
+* **[getDesciption](#stack-api-log-ascii-dictionary-getSymbolString)**
+
+***
+[[NOTE={"guid":"866dcdd6-c344-4cc8-9bf3-aa5bf3a8ce5d"}]]
+[[ANCHOR={"id":"stack-api-log-ascii-dictionary-getSymbolString","visible":true}]]
+### **AsciiDictionary.getSymbolString**
+```
+AsciiDictionary.getSymbolString(text);
+```
+
+[[NOTE={"guid":"2a42957f-34d7-4aa5-b5b7-5f57e8aa89a6"}]]
+[[ANCHOR={"id":"1dcc8502-7848-46b3-a897-764e00261bbe","visible":true}]]
+#### **Method Description**
+
+Converts a text to a readable text. This is done by showing the codes of not visible characters. 
+
+```table
+Config(classHeading: )
+
+|Parameters                                         |
+|Name|Type                |Description              |
+|text|[[REF=, MDN_string]]|The text to be converted.|
+```
+
+```table
+Config(classHeading: )
+
+|Returns                                 |
+|Type                |Description        |
+|[[REF=, MDN_string]]|The resulting text.|
+```
+[[NOTE={"guid":"affe69f1-8ad6-4644-a5a7-f1911cf049b2"}]]
+[[ANCHOR={"id":"83df9526-5fcb-462b-b46a-439c04e743ea","visible":true}]]
+#### **Example using AsciiDictionary.getSymbolString**
+
+```javascript
+
+const StackApi = require('stack-api');
+
+
+console.log(StackApi.AsciiDictionary.getSymbolString('Hello\r\n'));      // Output will be "Hello[CR][LF]"
+
+```
+
+[[NOTE={"guid":"dda27b31-f35a-4eaa-a313-d306b4f7805a"}]]
+[[ANCHOR={"id":"a0bda67e-84ac-4e0a-9763-c818f61c7cc9","visible":true}]]
+#### **Test Cases AsciiDictionary.getSymbolString**
+
+***
+[[NOTE={"guid":"00872d36-92ef-4e5e-80e8-b92e58e703de"}]]
+[[ANCHOR={"id":"stack-api-log-ascii-dictionary-getSymbol","visible":true}]]
+### **AsciiDictionary.getSymbol**
+```
+AsciiDictionary.getSymbol(index);
+```
+
+[[NOTE={"guid":"c6b22864-8711-4e5b-9415-00290e334977"}]]
+[[ANCHOR={"id":"ae78e1e6-de9b-40bc-a80b-a70b4286de8d","visible":true}]]
+#### **Method Description**
+`Not documented yet`
+
+***
+
+[[NOTE={"guid":"62bf53ef-721f-4f3f-80c6-4ac625d4831d"}]]
+[[ANCHOR={"id":"stack-api-log-ascii-dictionary-getHtmlName","visible":true}]]
+### **AsciiDictionary.getHtmlName**
+```
+AsciiDictionary.getHtmlName(index);
+```
+
+[[NOTE={"guid":"a2f77149-aca5-4452-b487-3edee953d95a"}]]
+[[ANCHOR={"id":"10c2e823-2be2-4ddf-b5b8-313aa82b7af4","visible":true}]]
+#### **Method Description**
+`Not documented yet`
+
+***
+
+[[NOTE={"guid":"f6352d84-b8f6-4b10-bf9a-50ef8805a8fb"}]]
+[[ANCHOR={"id":"stack-api-log-ascii-dictionary-getSymbolString","visible":true}]]
+### **AsciiDictionary.getDesciption**
+```
+AsciiDictionary.getDesciption(index);
+```
+
+[[NOTE={"guid":"95fe09c0-5f37-4f8f-b90c-22291ca6d0aa"}]]
+[[ANCHOR={"id":"5eee1f10-a911-481a-b815-e7809c3bfeb1","visible":true}]]
+#### **Method Description**
+`Not documented yet`
+
+***
+

package/Documentation/stack-api/Document-global-binary-log.txt

@@ -0,0 +1,91 @@
+# **BinaryLog API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=MOSTLY, ]]
+
+[[NOTE={"guid":"382a5e72-85cb-41f4-a851-fadbc5bdcf8d"}]]
+[[ANCHOR={"id":"083ea94e-5459-48e1-8506-5bfb9d4e6949","visible":true}]]
+## **Description**
+
+BinaryLog API implementation is in [[REF=, CODE_BinaryLog]].
+
+[[NOTE={"guid":"d4fe8d85-0252-4e0f-9605-5776301b32d8"}]]
+[[ANCHOR={"id":"ff0941a3-4359-41e3-b43f-f15f14943dfb","visible":true}]]
+## **API Methods**
+* **[static generateLog](#stack-api-binary-log-sgenerateLog)**
+
+***
+
+[[NOTE={"guid":"c91b573a-8f2d-4c1b-9862-8d974c702dcb"}]]
+[[ANCHOR={"id":"stack-api-binary-log-sgenerateLog","visible":true}]]
+### **static generateLog**
+```
+BinaryLog.generateLog(buffer, ipLogs);
+```
+
+[[NOTE={"guid":"7efb8ab0-f873-4e6f-a87f-8b0a1db3ff00"}]]
+[[ANCHOR={"id":"4f22852e-fea8-4622-a958-a9c767c12a35","visible":true}]]
+#### **Method Description**
+
+Generates a binary log and a log caption.
+
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                            |
+|Name  |Type                                                        |Description                                                       |
+|buffer|[[REF=,NODEJS_Buffer]] | [[REF=, MDN_string]]|The buffer to be converted to LogInner objects.                   |
+|ipLogs|[[REF=, MDN_Array]]                                         |An [[REF=, MDN_Array]] to put the resulting LogInner objects into.|
+```
+
+```table
+Config(classHeading: )
+
+|Returns                                   |
+|Type               |Description           |
+|[[REF=,MDN_string]]|The generated caption.|
+```
+[[NOTE={"guid":"86a36473-1102-410a-a483-9fe928df9b8d"}]]
+[[ANCHOR={"id":"ad2a4eca-b236-48b7-8bb0-058239501f90","visible":true}]]
+#### **Example using BinaryLog.generateLog**
+
+```javascript
+
+const StackApi = require('stack-api');
+
+
+*encode() {
+  yield* this.send(this.msg);
+  if(this.isLogIp) {
+    process.nextTick(() => {
+      this.caption = StackApi.BinaryLog.generateLog(this.msg, this.ipLogs);
+      this.logMessage();
+    });
+  }
+}
+ 
+```
+
+```javascript
+
+const StackApi = require('stack-api');
+
+
+*decode() {
+    const msg = yield* this.receiveSize(this.size);
+    if(this.isLogIp) {
+      process.nextTick(() => {
+        this.caption = StackApi.BinaryLog.generateLog(msg, this.ipLogs);
+        this.logMessage();
+      });
+    }
+    return msg;
+  }
+}
+```
+
+[[NOTE={"guid":"0fc4d056-9f74-4d05-8cfc-aad7056251e7"}]]
+[[ANCHOR={"id":"ee6f2ee8-6c70-4d4b-a09b-751bf2ceb386","visible":true}]]
+#### **Test Cases BinaryLog.generateLog**
++ [DocStackApiBinaryLog](/../test-cases/Actor/Doc/DocStackApiBinaryLog)
+
+***

package/Documentation/stack-api/Document-global-bit-byte.txt

@@ -0,0 +1,80 @@
+# **BitByte API**
+[[API-STATUS=STABLE,]]
+[[DOC-STATUS=PARTLY, ]]
+
+[[NOTE={"guid":"44571f44-f48b-4127-af55-a56c38be14aa"}]]
+[[ANCHOR={"id":"dbcde158-b1ae-4251-a085-2f85d8db44e7","visible":true}]]
+## **Description**
+The BitByte API is a helper API to make it easy to read and write specific bits of an byte.
+```node
+Config(nodeWidth: 20, nodeHeight: 20, nodeWidthBetween: 5, nodeHeightBetween: 25, widthBias: 10, heightBias: 10)
+
+Nodes[0, 1, 2, 3, 4, 5, 6, 7]
+
+
+```
+The bit index is in reversed order as it is when implenting a protocol.
+
+BitByte API implementation is in [[REF=, CODE_BitByte]].
+
+[[NOTE={"guid":"51ffee39-2093-469d-9a66-9fa6e035b3cf"}]]
+[[ANCHOR={"id":"766a14ad-95d7-4483-ae75-535fb0f8e229","visible":true}]]
+## **API Methods**
+* **[getBit](#stack-api-bit-byte-get-bit)**
+* **[getBits](#stack-api-bit-byte-get-bits)**
+* **[setBit](#stack-api-bit-byte-set-bit)**
+* **[setBits](#stack-api-bit-byte-set-bits)**
+
+***
+[[NOTE={"guid":"7c5e1cd3-dbe7-4462-a7a6-685abbf18b8a"}]]
+[[ANCHOR={"id":"stack-api-bit-byte-get-bit","visible":true}]]
+### **BitByte.getBit**
+```
+BitByte.getBit(byte, bit);
+```
+
+[[NOTE={"guid":"529367c3-b7f9-43c2-9430-a76b47f0d58f"}]]
+[[ANCHOR={"id":"226499f1-82be-4b03-a141-d0e027af7e5e","visible":true}]]
+#### **Method Description**
+Reads the value of a bit in a byte.
+
+***
+[[NOTE={"guid":"25fced41-730f-43e0-8c51-b2248fd73c63"}]]
+[[ANCHOR={"id":"stack-api-bit-byte-get-bits","visible":true}]]
+### **BitByte.getBits**
+```
+BitByte.getBits(byte, bitFrom, bitTo);
+```
+
+[[NOTE={"guid":"c344a346-039f-4755-bc10-918eae908f14"}]]
+[[ANCHOR={"id":"399e0736-c70b-4b1b-ae58-3ecdfb53e4cd","visible":true}]]
+#### **Method Description**
+Reads the value of chosen bits in a byte.
+
+***
+[[NOTE={"guid":"584a3ed1-f7c8-430e-b4ef-c1082473e34a"}]]
+[[ANCHOR={"id":"stack-api-bit-byte-set-bit","visible":true}]]
+### **BitByte.setBit**
+```
+BitByte.setBit(byte, bit, value = 1);
+```
+
+[[NOTE={"guid":"9c4c0b7a-b3c0-4d95-81d3-04e66c7d8da5"}]]
+[[ANCHOR={"id":"42517d88-82ba-446f-9613-e93300bfccfa","visible":true}]]
+#### **Method Description**
+Writes the value of a bit in a byte.
+
+***
+[[NOTE={"guid":"cebc2ad7-985d-484b-ad90-7ceeba12137f"}]]
+[[ANCHOR={"id":"stack-api-bit-byte-set-bits","visible":true}]]
+### **BitByte.gesBits**
+```
+BitByte.setBits(byte, bitFrom, bitTo, value);
+```
+
+[[NOTE={"guid":"ba78178c-de13-449e-8bba-48b01ad5a81c"}]]
+[[ANCHOR={"id":"7a65e701-8079-4f33-a5cc-84187812fcd2","visible":true}]]
+#### **Method Description**
+Writes the value of chosen bits in a byte.
+
+***

package/Documentation/stack-api/Document-global-content-base.txt

@@ -0,0 +1,169 @@
+# **ContentBase API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=PARTLY, ]]
+
+[[NOTE={"guid":"66188066-cbb1-40f5-af32-a9caf2f6319c"}]]
+[[ANCHOR={"id":"5f5b01a6-fdf1-4bcc-a676-7cee02f31e03","visible":true}]]
+## **Description**
+When using [[REF=, ABS_Content]] and/or certain [[REF=, ABS_Stack]]s, you will get data as a ContentBase [[REF=, MDN_object]]. It will help you manipulate and handle the data more efficiently.
+
+[[NOTE={"guid":"aeac0a8b-2556-402a-a41f-3c58a48c34c0"}]]
+[[ANCHOR={"id":"92a32d58-7b41-4883-b6ec-4ad68d0a7065","visible":true}]]
+### **Methods**
+* [ContentBase.getBuffer](#content-base-getBuffer)
+* [ContentBase.addBuffer](#content-base-addBuffer)
+* [ContentBase.getLength](#content-base-getLength)
+* [ContentBase.indexOf](#content-base-indexOf)
+* [ContentBase.slice](#content-base-slice)
+* [ContentBase.normalize](#content-base-normalize)
+
+***
+
+[[NOTE={"guid":"d3a63dc1-b6c1-4145-aec7-039d26ca934f"}]]
+[[ANCHOR={"id":"content-base-getBuffer","visible":true}]]
+### **ContentBase.getBuffer**
+```
+contentBase.getBuffer();
+```
+Gets the next [[REF=, NODEJS_Buffer]] of the [[REF=, ABS_Content]].
+
+[[NOTE={"guid":"2d6cb078-12c7-4a01-a070-81ed0861ee83"}]]
+[[ANCHOR={"id":"f1589538-2670-4ac3-972c-be694364efbc","visible":true}]]
+#### **Method Description**
+
+ Use the [getLength](#content-base-getLength) member function to see the total length of all [[REF=, NODEJS_Buffer]]s. Continue to call this member function until all [[REF=, NODEJS_Buffer]]s are returned. The [[REF=, API_Stack_Content_Base]] object has an internal member that remembers which [[REF=, NODEJS_Buffer]] is the current one. Call the member function [normalize](#content-base-normalize) to reset the current [[REF=, NODEJS_Buffer]] to the first [[REF=, NODEJS_Buffer]].
+
+```table
+Config(classHeading: )
+
+|Returns                                          |
+|Type                  |Description               |
+|[[REF=,NODEJS_Buffer]]|The resulting ***value***.|
+```
+
+***
+
+[[NOTE={"guid":"e9b78b61-2026-4830-8a1a-fc371294b690"}]]
+[[ANCHOR={"id":"content-base-addBuffer","visible":true}]]
+### **ContentBase.addBuffer**
+```
+contentBase.addBuffer();
+```
+Add a buffer to the [[REF=, ABS_Content]].
+
+[[NOTE={"guid":"6cc03b8a-af45-4855-b4e8-de1f0f8fcd2d"}]]
+[[ANCHOR={"id":"e1b18b45-9541-4d24-b262-4e3c2abbd22b","visible":true}]]
+#### **Method Description**
+
+
+```table
+Config(classHeading: )
+
+|Parameters                                                              |
+|Name  |Type                  |Description                               |
+|buffer|[[REF=,NODEJS_Buffer]]|Add a buffer to the [[REF=, ABS_Content]].|
+```
+
+***
+
+[[NOTE={"guid":"40ced9c4-6652-4739-9c29-5131a99be7fe"}]]
+[[ANCHOR={"id":"content-base-getLength","visible":true}]]
+### **ContentBase.getLength**
+```
+contentBase.getLength();
+```
+Retrieves the total length of all [[REF=, NODEJS_Buffer]]s of the [[REF=, ABS_Content]].
+
+[[NOTE={"guid":"86e65b6f-465f-4722-9405-3ec7d0ea3ec4"}]]
+[[ANCHOR={"id":"5bf11d7a-9f70-4c01-8878-9a412fe87197","visible":true}]]
+#### **Method Description**
+
+
+```table
+Config(classHeading: )
+
+|Returns                                                           |
+|Type               |Description                                   |
+|[[REF=,MDN_number]]|The total length of the [[REF=, ABS_Content]].|
+```
+
+***
+
+[[NOTE={"guid":"8d351eb1-e1d3-4396-93c8-9ad5903b97f8"}]]
+[[ANCHOR={"id":"content-base-indexOf","visible":true}]]
+### **ContentBase.indexOf**
+```
+contentBase.indexOf(value[, start]);
+```
+Searches for a value in the [[REF=, ABS_Content]].
+
+[[NOTE={"guid":"493cc51b-5e2f-4248-846d-890952dc953b"}]]
+[[ANCHOR={"id":"504ae659-5b12-42fd-92e5-bbd1e8314061","visible":true}]]
+#### **Method Description**
+
+
+```table
+Config(classHeading: )
+
+|Parameters                                                                                              |
+|Name |Type                                                       |Default|Description                   |
+|value|[[REF=,MDN_string]] | [[REF=,NODEJS_Buffer]]|       |The value to search for.      |
+|start|[[REF=,MDN_number]]                                        |0      |The start index of the search.|
+```
+
+```table
+Config(classHeading: )
+
+|Returns                                                                       |
+|Type               |Description                                               |
+|[[REF=,MDN_number]]|The index in which the value is found, or -1 if not found.|
+```
+
+***
+
+[[NOTE={"guid":"42a8007f-d5f1-4192-9936-0855fa19ca1b"}]]
+[[ANCHOR={"id":"content-base-slice","visible":true}]]
+### **ContentBase.slice**
+```
+contentBase.slice([start[, end]]);
+```
+Retrieves a slice of the [[REF=, ABS_Content]].
+
+[[NOTE={"guid":"a94cf4bf-8663-48b9-8297-5d731eff3844"}]]
+[[ANCHOR={"id":"21c01b67-3efd-4761-97b6-63f9ce21cd0e","visible":true}]]
+#### **Method Description**
+
+
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                    |
+|Name |Type                                                       |Default|Description                                         |
+|start|[[REF=,MDN_string]] | [[REF=,NODEJS_Buffer]]|0      |Start index.                                        |
+|end  |[[REF=,MDN_number]]                                        |-1     |End index. -1 means get everything from ***start***.|
+```
+
+```table
+Config(classHeading: )
+
+|Returns                                          |
+|Type                  |Description               |
+|[[REF=,NODEJS_Buffer]]|The resulting ***value***.|
+```
+
+***
+
+[[NOTE={"guid":"f6cb3227-bb47-4338-85f4-47d4a69d7f51"}]]
+[[ANCHOR={"id":"content-base-normalize","visible":true}]]
+### **ContentBase.normalize**
+```
+contentBase.normalize();
+```
+Resets the current [[REF=, NODEJS_Buffer]] to the first [[REF=, NODEJS_Buffer]].
+
+[[NOTE={"guid":"8f8b9061-b846-486e-8763-352cd097fb01"}]]
+[[ANCHOR={"id":"a36aa142-8dde-422f-be50-3a55f5b4f227","visible":true}]]
+#### **Method Description**
+
+
+***