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

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

@@ -0,0 +1,215 @@
+# **Client Stack API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=PARTLY, ]]
+
+[[NOTE={"guid":"a7d58e7a-42f3-4dba-be60-eda935ba02af"}]]
+[[ANCHOR={"id":"f9e275c5-83e0-4b0c-9a2e-d1055630de0b","visible":true}]]
+## **Description**
+
+By definition, a client is an [[REF=, ABS_Actor]] that connects to another part called a server. When the [[REF=, ABS_Actor]] is connected, it will get a [[REF=, ABS_Stack_Client_Connection]] for sending and receiving data. A [[REF=, ABS_Stack_Client_Connection]] implements the [[REF=, ABS_Stack]] part of a protocol and contains an Encoder and a Decoder. The [[REF=, ABS_Stack_Client_Connection]] does not handle any of the timing in the [[REF=, ABS_Stack]]. This timing must be handled by the [[REF=, ABS_Actor]] itself. The transport layer is separated from the [[REF=, ABS_Stack]] in the [[REF=, ABS_Stack_Client_Connection]], which makes it possible to use all implemented transports on [[REF=, ABS_Stack]]s.
+
+The following Actor types have client capability:
++ **[[REF=, ABS_Actor_Originating]]**
++ **[[REF=, ABS_Actor_Terminating]]**
++ **[[REF=, ABS_Actor_Proxy]]**
+
+In the [[REF=, ABS_Actor_State_Execution]] ***initClient** and ***run**, an [[REF=, ABS_Actor]] can create a [[REF=, ABS_Stack_Client_Connection]].
+
+The implementation of the Client Stack API starts in [[REF=, CODE_Stack_Client]].
+
+[[NOTE={"guid":"8eae0a2c-64ff-4ec5-bd3d-4b4f207f9a0d"}]]
+[[ANCHOR={"id":"client-stack-methods","visible":true}]]
+## **API Methods**
+* **[*createConnection](#client-stack-api-create-connection)**
+* **[switchProtocol](#client-stack-api-switch-protocol)** `ToDo`
+
+***
+
+[[NOTE={"guid":"766e7e0e-92c6-4159-bd40-e1b78427f92e"}]]
+[[ANCHOR={"id":"client-stack-api-create-connection","visible":true}]]
+### ***createConnection**
+
+``` js
+this.createConnection(stackName, options)
+```
+
+#### **Method Description**
+Connects to a server and returns a [[REF=, ABS_Stack_Client_Connection]].
+
+[[NOTE={"guid":"c9866d80-523a-4503-9b11-d6e8562e8f6f"}]]
+[[ANCHOR={"id":"60403e89-5133-42ed-9855-14c74b9f8376","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                                                                                                                                         |
+|Name                     |Type                |Default                  |Description                                                                                                                                                                                                                                                               |
+|stackName                |[[REF=,MDN_string]] |                         |Name of the Client Stack.                                                                                                                                                                                                                                                 |
+|options                  |[[REF=,MDN_object]] |                         |Object with options                                                                                                                                                                                                                                                       |
+|\- dstIndex              |[[REF=,MDN_number]] |0                        |Index of the dst column from the Actor table. If the dst column is a [[REF=,MDN_string]], the name of the destination address, the value must be 0. If the dst column is an Array [[REF=,MDN_strings]], the value must be an existing index in the Array.                 |
+|\- srcIndex              |[[REF=,MDN_number]] |0                        |Index of the src column from the Actor table. If the src column is a [[REF=,MDN_string]], the name of the source address, the value must be 0. If the src column is an Array [[REF=,MDN_strings]], the value must be an existing index in the Array.                      |
+|\- networkType      |[[REF=,MDN_number]] |[determined by the Stack]|0: TCP, 1: UDP. 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.|
+|\- reuse                 |[[REF=,MDN_boolean]]|false                    |`ToDo:`                                                                                                                                                                                                                                                                   |
+|\- share                 |[[REF=,MDN_boolean]]|false                    |`ToDo:`                                                                                                                                                                                                                                                                   |
+|\- 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":"b366cd91-ac45-4a3d-a020-b5a5e0b9f396"}]]
+[[ANCHOR={"id":"776aa71e-6458-4e4a-8ee0-da3d6c93705f","visible":true}]]
+```table
+Config(classHeading: )
+
+|Returns                                                                                                                                                                                         |
+|Type               |Description                                                                                                                                                                 |
+|[[REF=,MDN_object]]|The returned value is an object that inherits from ***StackApi.ClientConnection***. See the help description for the stack you used to find out which methods are supported.|
+```
+
+[[NOTE={"guid":"4cc6ae06-00e9-4f7e-8797-43e54d55948f"}]]
+[[ANCHOR={"id":"a00383af-e971-46fd-83f8-f5f027b72571","visible":true}]]
+```table
+Config(classHeading: )
+
+|Async                                                                                 |
+|type |Description                                                                     |
+|yield|Naming convention generated. If regexp ***/this.(.\*)Connection/*** is fulfilled|
+```
+
+[[NOTE={"guid":"22dd27b5-d983-48be-8844-ec0627f2da2e"}]]
+[[ANCHOR={"id":"2a4ab3aa-8d7b-4126-9d0b-004c12d04bd5","visible":true}]]
+#### **Example using createConnection - 1**
+Normal usage of the Client Stack API
+
+```tc
+|Actor                                                                                   |
+|name              |node|type|phase|execution|src|dst     |srv     |testData|verification|
+|SocketExample1Orig|    |orig|exec |         |   |testSrv1|        |        |            |
+|SocketExample1Term|    |term|exec |         |   |        |testSrv1|        |            |
+|                  |    |    |     |         |   |        |        |        |            |
+```
+
+[[NOTE={"guid":"04205ae3-720f-474a-aaa2-bd49105d2c69"}]]
+[[ANCHOR={"id":"0159bdb7-bad2-4178-88ff-4745fbde02ed","visible":true}]]
+```javascript
+
+class SocketExample1Orig extends ActorApi.ActorOriginating {
+  constructor() {
+    super();
+    this.socketConnection = this.create();
+  }
+
+  *initClient() {
+    this.createConnection('socket', this.socketConnection);
+  }
+
+  *exit() {
+    this.closeConnection(this.socketConnection);
+  }
+}
+
+```
+
+[[NOTE={"guid":"824d1e6e-0161-4a49-81a9-1da67700a5df"}]]
+[[ANCHOR={"id":"88a1e36a-175a-4655-bf73-32af2bec82ac","visible":true}]]
+#### **Example using createConnection - 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":"7eebabe3-75e7-49aa-baac-4eaaa0b6b70e"}]]
+[[ANCHOR={"id":"7a2ebc6c-2a52-4840-a236-62d419d42f3c","visible":true}]]
+```javascript
+
+class SocketExample2Orig extends ActorApi.ActorOriginating {
+  constructor() {
+    super();
+    this.socketConnection = this.create();
+    this.networkType = 0;
+  }
+
+  *data() {
+    this.networkType = this.getTestDataNumber('transport', 'tcp', {
+      tcp: NetworkType.TCP,
+      udp: NetworkType.UDP
+    });
+  }
+
+  *initClient() {
+    this.createConnection('socket', this.socketConnection, {
+      networkType: this.networkType
+    });
+  }
+
+  *exit() {
+    this.closeConnection(this.socketConnection);
+  }
+}
+
+```
+
+[[NOTE={"guid":"1b672332-b5a5-448f-8835-a8d77c838235"}]]
+[[ANCHOR={"id":"a5208edd-41b2-4d58-9d95-732d1dcfd9eb","visible":true}]]
+#### **Example using createConnection - 3**
+Creating two connections
+```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":"a65aacd9-8a1c-4646-8c23-ccceb3de828e"}]]
+[[ANCHOR={"id":"791f70c8-580c-4022-beef-a6d2e2de0a52","visible":true}]]
+```javascript
+
+class SocketExample3Orig extends ActorApi.ActorOriginating {
+  constructor() {
+    super();
+    this.socketConnection1 = this.create();
+    this.socketConnection2 = this.create();
+  }
+
+  *initClient() {
+    this.createConnection('socket', this.socketConnection1);
+    this.createConnection('socket', this.socketConnection2, {
+      dstIndex: 1,
+      srcIndex: 1
+    });
+  }
+
+  *exit() {
+    this.closeConnection(this.socketConnection1);
+    this.closeConnection(this.socketConnection2);
+  }
+}
+
+```
+
+[[NOTE={"guid":"2cf17a9c-885d-4716-8d9a-260f7cd617b5"}]]
+[[ANCHOR={"id":"38e73cd6-d584-408e-8b06-1c0fe3944e0a","visible":true}]]
+#### **Test Cases using createConnection**
++ [DocActorApiClientStackCreateConnectionSingle](/../test-cases/Actor/Doc/DocActorApiClientStackCreateConnectionSingle)
++ [DocActorApiClientStackCreateConnectionSingleUdp](/../test-cases/Actor/Doc/DocActorApiClientStackCreateConnectionSingleUdp)
++ [DocActorApiClientStackCreateConnectionDouble](/../test-cases/Actor/Doc/DocActorApiClientStackCreateConnectionDouble)
+
+***
+
+[[NOTE={"guid":"9e5096e8-7880-4d69-afd8-388ea1aa95d9"}]]
+[[ANCHOR={"id":"client-stack-api-switch-protocol","visible":true}]]
+### **switchProtocol** `ToDo`
+
+``` js
+this.switchProtocol(stackName, currentConnection)
+```
+
+#### **Method Description**

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

@@ -0,0 +1,106 @@
+# **Content API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=FULLY, ]]
+
+[[NOTE={"guid":"35cb5300-6085-4708-b79a-bb1fd467599e"}]]
+[[ANCHOR={"id":"1f2aa3ed-64ea-44cb-bf5b-9d049963834a","visible":true}]]
+## **Description**
+
+An [[REF=, ABS_Actor]] can read [[REF=, ABS_Content]] in the [[REF=Execution State, ABS_Actor_State_Execution]] ***data**. Content is used by the [[REF=, ABS_Actor]] usually to send and receive over a protocol. 
+
+Content API implementation starts in [[REF=, CODE_Content]].
+
+[[NOTE={"guid":"8b7f326a-373b-4c9f-85da-c182f315b92e"}]]
+[[ANCHOR={"id":"content-api-methods","visible":true}]]
+## **API Methods**
+* **[*getContent](#content-api-getcontent)**
+* **[*getContentByName](#content-api-getcontentbyname)**
+
+***
+
+[[ANCHOR={"id":"content-api-getcontent","visible":true}]]
+
+### ***getContent**
+```
+this.getContent(name[, hint])
+```
+
+[[NOTE={"guid":"f77ec2f9-cacb-489c-92b4-f290e67a1733"}]]
+[[ANCHOR={"id":"31542910-66d2-4bfb-9189-3bf6a6f5b92d","visible":true}]]#### **Method Description**
+Returning the requested content. The name is used to get the content name from Test Data.
+
+[[NOTE={"guid":"30a6554f-d85f-49b7-9a4d-f89848fe1560"}]]
+[[ANCHOR={"id":"57d7232a-f5de-4ba9-8943-e5c00021ab04","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                     |
+|Name|Type               |Description                                                                                                           |
+|name|[[REF=,MDN_string]]|The name of the [[REF=,ABS_Test_Data]] key containing the [[REF=,ABS_Content]] name.                                  |
+|hint|[[REF=,MDN_string]]|Name of the [[REF=,ABS_Content]] type to be able to find the [[REF=,ABS_Content]] faster. **Supported types**: `image`|
+```
+
+[[NOTE={"guid":"e6f12767-0ac6-4a64-91e4-8879d4773ea4"}]]
+[[ANCHOR={"id":"eb0175be-b5a6-4ef8-bd08-4b7db4b093d3","visible":true}]]
+#### **Example**
+```tc
+|TestDataTestCase                  |
+|key       |value      |description|
+|image_name|flag_sweden|           |
+|          |           |           |
+```
+
+```javascript
+
+*data() {
+  const image = this.getContent('image_name', 'image');             // image will be => the image 'flag_sweden'
+}
+
+```
+
+[[NOTE={"guid":"c26d65ba-2565-4a7d-bbd0-f3902c2b93d5"}]]
+[[ANCHOR={"id":"34cd7670-b79e-4ebc-9690-8f3b9da94ce1","visible":true}]]
+#### **Test Cases using getContent**
++ [ContentImageJpeg](/test-cases/Actor/Content/ContentImageJpeg)
++ [DemoMobileBrowsingImageJpg](/test-cases/Actor/Demo/DemoMobileBrowsingImageJpg)
+
+***
+
+[[NOTE={"guid":"5024dc24-4da6-4ba7-a369-a708e32c9a9d"}]]
+[[ANCHOR={"id":"content-api-getcontentbyname","visible":true}]]
+### ***getContentByName**
+```
+this.getContentByName(name[, hint])
+```
+
+[[NOTE={"guid":"5bffa8cd-a689-46ed-9b25-391f0f003154"}]]
+[[ANCHOR={"id":"d96ed33f-73ad-45a6-8a5d-c095be634155","visible":true}]]
+#### **Method Description**
+Returning the requested content. The name is the content name.
+
+[[NOTE={"guid":"9ce623d0-fec5-4298-9e87-a9f9d2b03494"}]]
+[[ANCHOR={"id":"5067d8b0-3808-4ab1-8729-4620853fefe7","visible":true}]]
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                     |
+|Name|Type               |Description                                                                                                           |
+|name|[[REF=,MDN_string]]|The name of the [[REF=,ABS_Content]].                                                                                 |
+|hint|[[REF=,MDN_string]]|Name of the [[REF=,ABS_Content]] type to be able to find the [[REF=,ABS_Content]] faster. **Supported types**: `image`|
+```
+
+[[NOTE={"guid":"321ffec2-247b-4e5d-beec-0b0eabba8491"}]]
+[[ANCHOR={"id":"08f5741a-d66b-4dad-ab25-a449173ff7e1","visible":true}]]
+#### **Example**
+```javascript
+
+*data() {
+  const image = this.getContentByName('flag_sweden', 'image');       // image will be => the image 'flag_sweden'
+}
+
+```
+
+[[NOTE={"guid":"a3d22751-13d8-41b7-a824-9e7054214b31"}]]
+[[ANCHOR={"id":"1e8272be-a14a-4f69-b8b0-2e4c208858d0","visible":true}]]
+#### **Test Cases using getContentByName**
++ [ContentByNameImageJpeg](/test-cases/Actor/Content/ContentByNameImageJpeg)