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

package/Documentation/actor-api/Document-global-logger.txt

@@ -0,0 +1,426 @@
+# **Logger API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=MOSTLY, ]]
+
+[[NOTE={"guid":"4456444f-8ed7-4ea0-b144-59d08f672233"}]]
+[[ANCHOR={"id":"cd34fd91-ae8f-4d75-8296-72d8a98ac233","visible":true}]]
+## **Description**
+[[REF=, ABS_Actor]]s can use this API to generate logs.
+
+Logger API implementation starts in [[REF=, CODE_Logger]].
+
+[[NOTE={"guid":"0fb3431f-166f-4e7a-93ec-832cd486a878"}]]
+[[ANCHOR={"id":"content-api-methods","visible":true}]]
+## **API Methods**
+* **[logDebug](#logger-api-log-debug)**
+* **[logEngine](#logger-api-log-engine)**
+* **[logError](#logger-api-log-error)**
+* **[logIp](#logger-api-log-ip)** `ToDo`
+* **[logGui](#logger-api-log-gui)** `ToDo`
+* **[logTestData](#logger-api-log-test-data)**
+* **[logVerifyFailure](#logger-api-log-verify-failure)**
+* **[logVerifySuccess](#logger-api-log-verify-success)**
+* **[logWarning](#logger-api-log-warning)**
+
+***
+[[NOTE={"guid":"d793886d-39ce-4868-a562-d3d1f130f933"}]]
+[[ANCHOR={"id":"logger-api-log-debug","visible":true}]]
+### **logDebug**
+```
+this.logDebug(message[, group[, guid[, depth=0]]])
+```
+Generates a debug log.
+
+[[NOTE={"guid":"1f67cef5-6bde-4e33-a79d-10932de2a7b6"}]]
+[[ANCHOR={"id":"d7c68fbe-919a-47dd-862a-8b96a25f21a3","visible":true}]]
+#### **Method Description**
+
+
+[[NOTE={"guid":"9358cef0-7080-4a01-82e7-c8acccc70ad0"}]]
+[[ANCHOR={"id":"b508de21-8320-4234-a7aa-fc17572813e0","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                      |
+|Name   |Type                                                      |Default  |Description                                                                                                                                        |
+|message|[[REF=,MDN_string]] | [[REF=,MDN_Function]]|         |The log as a [[REF=,MDN_string]] or a [[REF=,MDN_Function]] returning the log as a [[REF=,MDN_string]].                                            |
+|group  |[[REF=,MDN_string]]                                       |undefined|A name used for filtering of logs. `Filter on log groups not implemented yet.`                                                                     |
+|guid   |[[REF=,MDN_string]]                                       |undefined|A unique id, preferably a GUID, used for optimization. The GUID is used to access a cached stack.                                                  |
+|depth  |[[REF=,MDN_number]]                                       |0        |Move down depth steps in stack when choosing the **file name** to refer to in the log. `Values other than default mostly for use within ActorJs.`|
+```
+
+[[NOTE={"guid":"5def7ff0-37ef-4946-86e9-164ee22dd421"}]]
+[[ANCHOR={"id":"f305036e-8290-444c-9772-14076ece13d1","visible":true}]]
+#### **Example logDebug**
+
+```javascript
+
+
+
+this.logDebug('Demo debug log');
+this.logDebug(() => 'Demo debug log');
+
+```
+
+```object
+
+[log](Debug, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo success log., Actors-global.demo.log.DemoLogLocal.js)
+```
+
+[[NOTE={"guid":"30dce410-e7f9-4036-bd47-e355b9653102"}]]
+[[ANCHOR={"id":"7774e2f8-d5c4-4b7e-a361-eab3ab947618","visible":true}]]
+#### **Test Cases logDebug**
++ [DemoLog001](/../test-cases/Actor/Demo/DemoLog001)
+
+***
+[[NOTE={"guid":"1ab1abbd-1393-4b91-b1f9-be3101774bb5"}]]
+[[ANCHOR={"id":"logger-api-log-engine","visible":true}]]
+### **logEngine**
+```
+this.logEngine(message[, group[, guid[, depth=0]]])
+```
+Generates an engine log. `Mostly used internally.`
+
+[[NOTE={"guid":"3de925b5-f11f-47c5-9082-9421789c2157"}]]
+[[ANCHOR={"id":"37ef95a9-5c68-4f4b-9679-01b3481bdc26","visible":true}]]
+#### **Method Description**
+
+[[NOTE={"guid":"c011f07e-9911-4201-a3db-bd366d91c116"}]]
+[[ANCHOR={"id":"efbee403-eec6-42fe-818c-e0d861cd9262","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                      |
+|Name   |Type                                                      |Default  |Description                                                                                                                                        |
+|message|[[REF=,MDN_string]] | [[REF=,MDN_Function]]|         |The log as a [[REF=,MDN_string]] or a [[REF=,MDN_Function]] returning the log as a [[REF=,MDN_string]].                                            |
+|group  |[[REF=,MDN_string]]                                       |undefined|A name used for filtering of logs. `Filter on log groups not implemented yet.`                                                                     |
+|guid   |[[REF=,MDN_string]]                                       |undefined|A unique id, preferably a GUID, used for optimization. The GUID is used to access a cached stack.                                                  |
+|depth  |[[REF=,MDN_number]]                                       |0        |Move down depth steps in stack when choosing the **file name** to refer to in the log. `Values other than default mostly for use within ActorJs.`|
+```
+
+[[NOTE={"guid":"5245a83c-2558-4d8e-9c68-f4c12eddc69c"}]]
+[[ANCHOR={"id":"1923f805-5d5a-4e2d-a8d2-fc5a5d404f4c","visible":true}]]
+#### **Example logEngine**
+
+```javascript
+
+
+
+this.logEngine('Demo engine log');
+this.logEngine(() => 'Demo engine  log');
+
+```
+
+```object
+
+[log](Engine, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo engine log., Actors-global.demo.log.DemoLogLocal.js)
+```
+
+[[NOTE={"guid":"cab0458a-8266-48c3-ba40-74804dab60a1"}]]
+[[ANCHOR={"id":"eaa83882-92bc-4538-926a-eb7c3ce20e66","visible":true}]]
+#### **Test Cases logEngine**
++ [DemoLog001](/../test-cases/Actor/Demo/DemoLog001)
+
+***
+[[NOTE={"guid":"5c1589dc-2d93-4248-a95e-ab9923c702bd"}]]
+[[ANCHOR={"id":"logger-api-log-error","visible":true}]]
+### **logError**
+```
+this.logError(message[, group[, guid[, depth=0]]])
+```
+Generates an error log.
+[[NOTE={"guid":"e69215ce-ff8a-4a77-8646-f04f8184bad5"}]]
+[[ANCHOR={"id":"89e38ba7-1255-439a-a928-9526273e4bc9","visible":true}]]
+#### **Method Description**
+
+
+[[NOTE={"guid":"14e06130-a63d-4aa1-907f-f11f1e1cc8a6"}]]
+[[ANCHOR={"id":"3652a588-5a66-4d26-8074-1fb1d696c87f","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                                                                          |
+|Name    |Type                                                                                             |Default  |Description                                                                                                                                                    |
+|errOrMsg|[[REF=,MDN_string]] | [[REF=,MDN_Function]] | [[REF=,NODEJS_Error]]|         |The log as a [[REF=,MDN_string]] or an [[REF=,NODEJS_Error]] or a [[REF=,MDN_Function]] returning the log as a [[REF=,MDN_string]] or an [[REF=,NODEJS_Error]].|
+|guid    |[[REF=,MDN_string]]                                                                              |undefined|A unique id, preferably a GUID, used for optimization. The GUID is used to access a cached stack.                                                              |
+|depth   |[[REF=,MDN_number]]                                                                              |0        |Move down depth steps in stack when choosing the **file name** to refer to in the log. `Values other than default mostly for use within ActorJs.`|
+```
+
+[[NOTE={"guid":"c0355abb-c0b0-4bb4-999b-71ee04e26a04"}]]
+[[ANCHOR={"id":"f5533ff8-f970-4dd8-b727-3f33cad45e92","visible":true}]]
+#### **Example logError**
+
+```javascript
+
+
+
+this.logError('Demo success log');
+this.logError(() => 'Demo success log');
+
+```
+
+```object
+
+[log](Error, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo error log., Actors-global.demo.log.DemoLogLocal.js)
+```
+
+[[NOTE={"guid":"3b098a91-a933-46f0-bd38-c038f9f7ba25"}]]
+[[ANCHOR={"id":"6c7c1565-6715-4f8f-869a-70cf367cf72a","visible":true}]]
+#### **Test Cases logError**
++ [DemoLog001](/../test-cases/Actor/Demo/DemoLog001)
+
+***
+[[NOTE={"guid":"5714b5dd-3753-425f-b746-2f3e46eff518"}]]
+[[ANCHOR={"id":"logger-api-log-ip","visible":true}]]
+### **logIp `ToDo`**
+```
+this.logIp(message[, group[, guid[, depth=0]]])
+```
+Generates an IP log. `Mostly used internally.`
+
+[[NOTE={"guid":"216ece7c-54a6-4d96-b35c-ac2f6983eee8"}]]
+[[ANCHOR={"id":"67871037-2510-4806-bf8e-7ae940665431","visible":true}]]
+#### **Method Description**
+
+
+[[NOTE={"guid":"0f8b3fb4-60e5-429a-b24d-2bb65d73f330"}]]
+[[ANCHOR={"id":"940e4a54-6f08-4736-853c-8e60c0abbb8d","visible":true}]]
+#### **Example logIp**
+
+```object
+
+[log](IP, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo ip log., Actors-global.demo.log.DemoLogLocal.js)
+```
+
+[[NOTE={"guid":"edad4216-b1fe-4f92-ac13-6b588c9c86bd"}]]
+[[ANCHOR={"id":"c9c5b244-ad18-443b-af9c-a3c7266cd220","visible":true}]]
+#### **Test Cases logIp**
++ [DemoLog001](/../test-cases/Actor/Demo/DemoLog001)
+
+***
+[[NOTE={"guid":"a1c7e317-b4d6-438e-9036-5ac94e208841"}]]
+[[ANCHOR={"id":"logger-api-log-gui","visible":true}]]
+### **logGui `ToDo`**
+```
+this.logGui(message[, group[, guid[, depth=0]]])
+```
+Generates a GUI log. `Mostly used internally.`
+
+[[NOTE={"guid":"c94d2396-b08f-401c-9976-5e6b5d77cb6c"}]]
+[[ANCHOR={"id":"e5d86fe9-ebc9-413b-aec9-5f47a41a85e3","visible":true}]]
+#### **Method Description**
+
+
+[[NOTE={"guid":"72973e33-7d10-435e-8b30-3884f413ce7e"}]]
+[[ANCHOR={"id":"7cb44d32-84d7-485c-afc9-d9709857c87f","visible":true}]]
+#### **Example logGui**
+
+```object
+
+[log](GUI, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo gui log., Actors-global.demo.log.DemoLogLocal.js)
+```
+
+[[NOTE={"guid":"d3508306-0ee1-413c-8ee6-9c7c0b1ea8dd"}]]
+[[ANCHOR={"id":"ef3b5be4-0a7d-44ea-acbf-2d8cca2f090c","visible":true}]]
+#### **Test Cases logGui**
++ [DemoLog001](/../test-cases/Actor/Demo/DemoLog001)
+
+***
+[[NOTE={"guid":"eb7ed8d2-3ca8-468a-8447-66168718c01d"}]]
+[[ANCHOR={"id":"logger-api-log-test-data","visible":true}]]
+### **logTestData**
+```
+this.logTestData(message[, group[, guid[, depth=0]]])
+```
+Generates a test data log.
+
+[[NOTE={"guid":"3e6350b7-432d-4078-a7c7-f8b86604c55b"}]]
+[[ANCHOR={"id":"619c3fcd-0d30-417b-8edd-cd74a9da3c52","visible":true}]]
+#### **Method Description**
+
+
+[[NOTE={"guid":"3d648e2a-539b-400b-bdef-0f1966999130"}]]
+[[ANCHOR={"id":"2c8273af-47a8-4cf3-b6ad-aeb9b4db8b7c","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                      |
+|Name   |Type                                                      |Default  |Description                                                                                                                                        |
+|message|[[REF=,MDN_string]] | [[REF=,MDN_Function]]|         |The log as a [[REF=,MDN_string]] or a [[REF=,MDN_Function]] returning the log as a [[REF=,MDN_string]].                                            |
+|group  |[[REF=,MDN_string]]                                       |undefined|A name used for filtering of logs. `Filter on log groups not implemented yet.`                                                                     |
+|guid   |[[REF=,MDN_string]]                                       |undefined|A unique id, preferably a GUID, used for optimization. The GUID is used to access a cached stack.                                                  |
+|depth  |[[REF=,MDN_number]]                                       |0        |Move down depth steps in stack when choosing the **file name** to refer to in the log. `Values other than default mostly for use within ActorJs.`|
+```
+
+[[NOTE={"guid":"d0efe7e8-cd76-4a82-bed9-efbb257ceb76"}]]
+[[ANCHOR={"id":"026b950a-4db7-4d92-bcc9-8a44c1f4cc1e","visible":true}]]
+#### **Example logTestData**
+
+```javascript
+
+
+
+this.logTestData('Demo test data log');
+this.logTestData(() => 'Demo test data log');
+
+```
+
+```object
+
+[log](TestData, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo test data log., Actors-global.demo.log.DemoLogLocal.js)
+```
+
+[[NOTE={"guid":"4fbd3f4f-07fc-4392-b801-c9845264e222"}]]
+[[ANCHOR={"id":"32126e75-a1be-45e6-998a-b78652f11c74","visible":true}]]
+#### **Test Cases logTestData**
++ [DemoLog001](/../test-cases/Actor/Demo/DemoLog001)
+
+***
+[[NOTE={"guid":"74421d41-c437-4b53-8d2a-a2bc16b73000"}]]
+[[ANCHOR={"id":"logger-api-log-verify-failure","visible":true}]]
+### **logVerifyFailure**
+```
+this.logVerifyFailure(message[, group[, guid[, depth=0]]])
+```
+Generates a verify failure log. `Mostly used internally.`
+
+[[NOTE={"guid":"b91cd4a6-33bc-47a0-896f-86fbdaea4bed"}]]
+[[ANCHOR={"id":"db9b2053-62a5-4848-a0d5-3042424d054a","visible":true}]]
+#### **Method Description**
+
+
+[[NOTE={"guid":"5d05ff4c-7e2b-4d9b-901e-e9d68d44856e"}]]
+[[ANCHOR={"id":"aa104ce9-b8b9-471b-b74b-51aea2281c2f","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                      |
+|Name   |Type                                                      |Default  |Description                                                                                                                                        |
+|message|[[REF=,MDN_string]] | [[REF=,MDN_Function]]|         |The log as a [[REF=,MDN_string]] or a [[REF=,MDN_Function]] returning the log as a [[REF=,MDN_string]].                                            |
+|guid   |[[REF=,MDN_string]]                                       |undefined|A unique id, preferably a GUID, used for optimization. The GUID is used to access a cached stack.                                                  |
+|depth  |[[REF=,MDN_number]]                                       |0        |Move down depth steps in stack when choosing the **file name** to refer to in the log. `Values other than default mostly for use within ActorJs.`|
+```
+
+[[NOTE={"guid":"66fdab86-40a0-4fdf-af9b-d328e280a0f2"}]]
+[[ANCHOR={"id":"52b067cd-edf2-4f68-a820-a0dca14f6e6b","visible":true}]]
+#### **Example logVerifyFailure**
+
+```javascript
+
+
+
+this.logVerifyFailure('Demo verify failure log');
+this.logVerifyFailure(() => 'Demo verify failure log');
+
+```
+
+```object
+
+[log](Failure, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo verify success log., Actors-global.demo.log.DemoLogLocal.js)
+```
+
+[[NOTE={"guid":"f34b0ea9-904f-4905-b230-6d6dd92f47b2"}]]
+[[ANCHOR={"id":"a1827cec-b614-4a9a-ade7-f95e38133693","visible":true}]]
+#### **Test Cases logVerifyFailure**
++ [DemoLog001](/../test-cases/Actor/Demo/DemoLog001)
+
+***
+
+[[NOTE={"guid":"8dc4fa1a-488d-4ff3-b473-19c00b2bb8df"}]]
+[[ANCHOR={"id":"logger-api-log-verify-success","visible":true}]]
+### **logVerifySuccess**
+```
+this.logVerifySuccess(message[, group[, guid[, depth=0]]])
+```
+Generate a verify success log. `Mostly used internally.`
+[[NOTE={"guid":"f4209dd6-f972-4270-8b91-820061c90864"}]]
+[[ANCHOR={"id":"36c906e3-20dc-4474-9c7d-e14755131c16","visible":true}]]
+#### **Method Description**
+
+[[NOTE={"guid":"dc508ea6-ef14-4e2c-940c-cdf2f23ac954"}]]
+[[ANCHOR={"id":"9b522d95-c026-418e-8d19-ba44386b521f","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                      |
+|Name   |Type                                                      |Default  |Description                                                                                                                                        |
+|message|[[REF=,MDN_string]] | [[REF=,MDN_Function]]|         |The log as a [[REF=,MDN_string]] or a [[REF=,MDN_Function]] returning the log as a [[REF=,MDN_string]].                                            |
+|guid   |[[REF=,MDN_string]]                                       |undefined|A unique id, preferably a GUID, used for optimization. The GUID is used to access a cached stack.                                                  |
+|depth  |[[REF=,MDN_number]]                                       |0        |Move down depth steps in stack when choosing the **file name** to refer to in the log. `Values other than default mostly for use within ActorJs.`|
+```
+
+[[NOTE={"guid":"058d5e7f-5235-48d2-8018-617bfa4aeea0"}]]
+[[ANCHOR={"id":"05e492cd-2480-4885-862d-db8dd385190a","visible":true}]]
+#### **Example logVerifySuccess**
+
+```javascript
+
+
+
+this.logVerifySuccess('Demo verify success log');
+this.logVerifySuccess(() => 'Demo verify success log');
+
+```
+
+```object
+
+[log](Success, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo verify success log., Actors-global.demo.log.DemoLogLocal.js)
+```
+
+[[NOTE={"guid":"e330ddde-7b2a-4d73-8fae-f4d6abb32354"}]]
+[[ANCHOR={"id":"20139643-44ee-40a4-9678-31b24642a313","visible":true}]]
+#### **Test Cases logVerifySuccess**
++ [DemoLog001](/../test-cases/Actor/Demo/DemoLog001)
+
+***
+[[NOTE={"guid":"2a7ae479-076d-4c87-a4e2-e803802a9023"}]]
+[[ANCHOR={"id":"logger-api-log-warning","visible":true}]]
+### **logWarning**
+```
+this.logWarning(message[, group[, guid[, depth=0]]])
+```
+Generates a debug log.
+
+[[NOTE={"guid":"80af34a8-a888-4a2e-98ee-4ac240aefe7a"}]]
+[[ANCHOR={"id":"a8e09b72-6d80-4697-b236-5d1f9a4d2c0a","visible":true}]]
+#### **Method Description**
+
+
+[[NOTE={"guid":"335d920b-e1c0-4fa3-b840-959ac1c84bd7"}]]
+[[ANCHOR={"id":"b4979205-4326-407a-bc67-f1fee1eee634","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                      |
+|Name   |Type                                                      |Default  |Description                                                                                                                                        |
+|message|[[REF=,MDN_string]] | [[REF=,MDN_Function]]|         |The log as a [[REF=,MDN_string]] or a [[REF=,MDN_Function]] returning the log as a [[REF=,MDN_string]].                                            |
+|guid   |[[REF=,MDN_string]]                                       |undefined|A unique id, preferably a GUID, used for optimization. The GUID is used to access a cached stack.                                                  |
+|depth  |[[REF=,MDN_number]]                                       |0        |Move down depth steps in stack when choosing the **file name** to refer to in the log. `Values other than default mostly for use within ActorJs.`|
+```
+
+[[NOTE={"guid":"40f19132-eaa9-4e16-9a73-4fa8f975faeb"}]]
+[[ANCHOR={"id":"2913ca28-a3b4-422b-b4bd-d98bb9296d12","visible":true}]]
+#### **Example logWarning**
+
+```javascript
+
+
+
+this.logWarning('Demo warning log');
+this.logWarning(() => 'Demo warning log');
+
+```
+
+```object
+
+[log](Warning, Mon. 03 Oct 2016 22:52:05 GMT : 901.764, DemoLogLocal[1], Demo warning log., Actors-global.demo.log.DemoLogLocal.js)
+```
+
+[[NOTE={"guid":"3e51313c-8dc2-4bce-96f1-4541b719ed01"}]]
+[[ANCHOR={"id":"1bf3fedd-eb5f-4746-9bb9-b9e48fc49ead","visible":true}]]
+#### **Test Cases logWarning**
++ [DemoLog001](/../test-cases/Actor/Demo/DemoLog001)
+
+***
+
+

package/Documentation/actor-api/Document-global-process.txt

@@ -0,0 +1,7 @@
+# **Process API**
+[[API-STATUS=EXPERIMENTAL, ]]
+[[DOC-STATUS=NOT-YET, ]]
+
+[[NOTE={"guid":"237e7b87-9f14-465d-ad05-9913e51b3017"}]]
+[[ANCHOR={"id":"ea702194-4329-4818-b65c-09b9a2d99446","visible":true}]]
+## **Description**

package/Documentation/actor-api/Document-global-server-stack.txt

@@ -0,0 +1,213 @@
+# **Server Stack API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=PARTLY, ]]
+
+[[NOTE={"guid":"f0f932f7-60a0-4bfe-9f79-6bfe6b623051"}]]
+[[ANCHOR={"id":"97aa2f7b-182a-4530-bda1-e96694ce2500","visible":true}]]
+## **Description**
+
+By definition a server is an [[REF=, ABS_Actor]] allowing another parts called a clients to connect to it. When the [[REF=, ABS_Actor]] is connected it will get a [[REF=, ABS_Stack_Server_Connection]] to send and receive data through. A [[REF=, ABS_Stack_Server_Connection]] implements the stack part of a protocol and contains an Encoder and a Decoder. All kind of timing handling in the Stack will not be handled by the [[REF=, ABS_Stack_Server_Connection]] . It must be handled by the [[REF=, ABS_Actor]] it self. The transport layer is separated from the [[REF=, ABS_Stack]]  in the [[REF=, ABS_Stack_Server_Connection]] which makes it possible to use all implemented transports on all [[REF=, ABS_Stack]]s.
+
+The following Actor types do have server capability.
++ **[[REF=, ABS_Actor_Terminating]]**
++ **[[REF=, ABS_Actor_Proxy]]**
+
+In the ***initServer()** method and in the ***run()** method it's possible for an [[REF=, ABS_Actor]] to create a [[REF=, ABS_Stack_Server_Connection]]. 
+
+The implementation of the Server Stack API starts in [[REF=, CODE_Stack_Server]].
+
+[[NOTE={"guid":"511cb0c6-413e-4d9e-b89a-24d272866d55"}]]
+[[ANCHOR={"id":"fbf4c7a3-28fa-4cd1-9545-0b1ab9bad220","visible":true}]]
+## **API Methods**
+* **[*createServer](#server-stack-api-create-server)**
+* **[switchProtocol](#server-stack-api-switch-protocol)**
+
+***
+[[NOTE={"guid":"e4743fcb-5743-4b75-ba2e-86eb21e3e3f4"}]]
+[[ANCHOR={"id":"server-stack-api-create-server","visible":true}]]
+### ***createServer**
+
+``` js
+this.createServer(stackName, options)
+```
+
+#### **Method Description**
+Starts a server, if it is not already started, and returns a [[REF=, ABS_Stack_Server_Connection]].
+
+
+[[NOTE={"guid":"8ccf6fb4-685a-4d5a-a469-a8bc8a905430"}]]
+[[ANCHOR={"id":"1784e688-a34b-4463-a70e-df3d8a2aa07d","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+|Name                     |Type                |Default                  |Description                                                                                                                                                                                                                                                                                                                                                               |
+|stackName                |[[REF=,MDN_string]] |                         |Name of the Server Stack.                                                                                                                                                                                                                                                                                                                                                 |
+|options                  |[[REF=,MDN_object]] |                         |Object with options                                                                                                                                                                                                                                                                                                                                                       |
+|\- srvIndex              |[[REF=,MDN_number]] |0                        |Index of the srv column from the Actor table. If the srv column is a [[REF=,MDN_string]], the name of the destination address, the value must be 0. If the srv column is an Array [[REF=,MDN_strings]], the value must be an existing index in the Array.                                                                                                                 |
+|\-&nbsp;networkType      |[[REF=,MDN_number]] |[determined by the Stack]|Number defining the network type. Implementations of stacks separate the data sent and the transport layer to be used. The stack determines the default value. See the help description for the stack whose name is used in the first parameter stackName.<br/>TCP, StackApi.NetworkType.TCP=0<br/>UDP, StackApi.NetworkType.UDP=1<br/>TCP, StackApi.NetworkType.MC=2<br/>|
+|\- reuse                 |[[REF=,MDN_boolean]]|false                    |`ToDo:`                                                                                                                                                                                                                                                                                                                                                                   |
+|\- share                 |[[REF=,MDN_boolean]]|false                    |`ToDo:`                                                                                                                                                                                                                                                                                                                                                                   |
+|\-&nbsp;connectionOptions|[[REF=,MDN_object]] |                         |connectionOptions is a connection-specific object. See the help description for the stack you used to find out which methods are supported.                                                                                                                                                                                                                               |
+```
+
+[[NOTE={"guid":"a35f4891-fb2f-4550-b588-100f3a9b293b"}]]
+[[ANCHOR={"id":"5058d149-3759-4bae-9936-6664bbb75027","visible":true}]]
+```table
+Config(classHeading: )
+
+|Returns                                                                                                                                                                                         |
+|Type               |Description                                                                                                                                                                 |
+|[[REF=,MDN_object]]|The returned value is an object that inherits from ***StackApi.ServerConnection***. See the help description for the stack you used to find out which methods are supported.|
+```
+
+[[NOTE={"guid":"c6118eb0-e62a-49df-a048-b4bcba24def3"}]]
+[[ANCHOR={"id":"9841e6ce-11db-42ee-a65d-4a08f7d7335f","visible":true}]]
+```table
+Config(classHeading: )
+
+|Async                                                                                 |
+|type |Description                                                                     |
+|yield|Naming convention generated. If regexp ***/this.(.\*)Connection/*** is fulfilled|
+```
+
+
+[[NOTE={"guid":"bd9cc25e-3de9-4670-ad28-fec1564c41f4"}]]
+[[ANCHOR={"id":"52831e82-a631-449e-9b1c-552606b8e374","visible":true}]]
+#### **Example using createServer - 1**
+Normal usage of the Server Stack API
+
+```tc
+|Actor                                                                                   |
+|name              |node|type|phase|execution|src     |dst     |srv|testData|verification|
+|SocketExample1Orig|    |orig|exec |         |testSrv1|        |   |        |            |
+|SocketExample1Term|    |term|exec |         |        |testSrv1|   |        |            |
+|                  |    |    |     |         |        |        |   |        |            |
+```
+
+[[NOTE={"guid":"f27e316c-ba32-4117-a09b-2a59429243cf"}]]
+[[ANCHOR={"id":"1f43ef25-9cfb-404b-8f15-5c5a99b68f05","visible":true}]]
+```javascript
+
+class SocketExample1Term extends ActorTerminating {
+  constructor() {
+    super();
+    this.socketConnection = this.create();
+  }
+
+  *initServer() {
+    this.createServer('socket', this.socketConnection);
+  }
+
+  *exit() {
+    this.closeConnection(this.socketConnection);
+  }
+}
+
+```
+[[NOTE={"guid":"fe2d6c80-8578-48ed-928e-5a1c71a345e1"}]]
+[[ANCHOR={"id":"15616995-ffdc-4f2b-a340-a8a5984cbb3e","visible":true}]]
+#### **Example using createServer - 2**
+Changing the networkType
+
+```tc
+|Actor                                                                                   |
+|name              |node|type|phase|execution|src     |dst     |srv|testData|verification|
+|SocketExample2Orig|    |orig|exec |testSrc1 |testSrv1|        |   |        |            |
+|SocketExample2Term|    |term|exec |         |        |testSrv1|   |        |            |
+|                  |    |    |     |         |        |        |   |        |            |
+
+|TestDataTestCase           |
+|key      |value|description|
+|transport|udp  |           |
+|         |     |           |
+```
+
+[[NOTE={"guid":"31f69662-7a09-4134-b124-0b90020ca8d3"}]]
+[[ANCHOR={"id":"4a740908-d8be-4c89-b768-e3083e7a8b85","visible":true}]]
+```javascript
+
+class SocketExample2Term extends ActorTerminating {
+  constructor() {
+    super();
+    this.socketConnection = this.create();
+    this.networkType = 0;
+  }
+
+  *data() {
+    this.networkType = this.getTestDataNumber('transport', 'tcp', {
+      tcp: NetworkType.TCP,
+      udp: NetworkType.UDP
+    });
+  }
+
+  *initServer() {
+    this.createServer('socket', this.socketConnection, {
+      networkType: this.networkType
+    });
+  }
+
+  *exit() {
+    this.closeConnection(this.socketConnection);
+  }
+}
+
+```
+
+[[NOTE={"guid":"5ed6b29e-f25b-4c02-a61c-8d7178ae2839"}]]
+[[ANCHOR={"id":"a4f76d72-f272-4a2d-b94a-aa2d355b6837","visible":true}]]
+#### **Example using createServer - 3**
+Creating two servers
+
+```tc
+|Actor                                                                                                                                  |
+|name              |node|type|phase|execution               |src                     |dst                     |srv|testData|verification|
+|SocketExample3Orig|    |orig|exec |["testSrc1", "testSrc2"]|["testSrv1", "testSrv2"]|                        |   |        |            |
+|SocketExample3Term|    |term|exec |                        |                        |["testSrv1", "testSrv2"]|   |        |            |
+|                  |    |    |     |                        |                        |                        |   |        |            |
+```
+
+[[NOTE={"guid":"c9fd4699-773c-4336-94b8-8e6db7dca59b"}]]
+[[ANCHOR={"id":"ddbd52ba-4946-4d68-a3ae-98f8531fcb23","visible":true}]]
+```javascript
+
+class SocketExample3Term extends ActorTerminating {
+  constructor() {
+    super();
+    this.socketConnection1 = this.create();
+    this.socketConnection2 = this.create();
+  }
+
+  *initServer() {
+    this.createServer('socket', this.socketConnection1);
+    this.createServer('socket', this.socketConnection2, {
+      srvIndex: 1
+    });
+  }
+
+  *exit() {
+    this.closeConnection(this.socketConnection1);
+    this.closeConnection(this.socketConnection2);
+  }
+}
+
+```
+
+[[NOTE={"guid":"fc93b7b1-cd51-4616-857e-ef263f10809a"}]]
+[[ANCHOR={"id":"f1abb1ce-a23d-47d5-be06-390649e636a7","visible":true}]]
+#### **Test Cases using createServer**
++ [DocActorApiClientStackCreateConnectionSingle](/../test-cases/Actor/Doc/DocActorApiClientStackCreateConnectionSingle)
++ [DocActorApiClientStackCreateConnectionSingleUdp](/../test-cases/Actor/Doc/DocActorApiClientStackCreateConnectionSingleUdp)
++ [DocActorApiClientStackCreateConnectionDouble](/../test-cases/Actor/Doc/DocActorApiClientStackCreateConnectionDouble)
+
+***
+
+[[NOTE={"guid":"59767f08-eb3b-47c4-85b1-6929de9c7bc5"}]]
+[[ANCHOR={"id":"server-stack-api-switch-protocol","visible":true}]]
+### **switchProtocol**
+
+``` js
+this.switchProtocol(stackName, currentConnection)
+```
+
+#### **Method Description**