Skip to content

Commit 1f6bfcc

Browse files
committed
Updated the documentation
1 parent a0bc5ff commit 1f6bfcc

6 files changed

Lines changed: 33 additions & 6 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.aliases

README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ WebSocket service actor enqueuer.
8181

8282
## Abstract messages
8383

84+
Two abstract messages must be subclassed to allow the interaction of either a WebSocket Server, a WebSocket Service or a WebSocket Client to interact with the corresponding subscriber actor.
85+
8486
### WebSocket Connection Handler Msg.lvclass
8587

8688
This abstract message is sent by either the WebSocket Client or by the
@@ -271,8 +273,34 @@ alt="A computer screen shot of a message Description automatically generated" />
271273
**Message Enqueuer in** specifies the enqueuer of the WebSocket Client
272274
actor.
273275

274-
**Data Format (Text)** Specifies an Enum allwing top specify if the data
275-
format is either “Text” or “Binary”.
276+
**Data Format (Text)** Specifies an Enum allowing to specify if the data format is either “Text” or “Binary”.
276277

277-
**Timeout ms** (5000) is the timeout to establish the connection to the
278-
server. A value of –1 indicates to wait indefinitely.
278+
**Timeout ms (5000)** is the timeout to establish the connection to the server. A value of –1 indicates to wait indefinitely.
279+
280+
## Abstract Messages
281+
Abstract messages have private properties that carry useful information to be used when the subscriber actor implementing the Do.vi method to act on the subscriber actor
282+
283+
### WebSocket Server-Service Enqueuer Msg
284+
285+
![WebSocket Server-Service Enqueuer Msg](media/WebSocket%20Server-Service%20Enqueuer%20Msg.png)
286+
287+
**Error** Carries the error resulting from either launching a server, or adding a service to a server or connecting to a client
288+
289+
**Service Name** String detailing the name of the service corresponding to the service that is being started and to which we are subscribing
290+
291+
**WebSocket Server-Service Enqueuer** the enqueuer of the server/service that was just started and to which we are subscribing
292+
293+
### WebSocket Connection Handler Msg
294+
![WebSocket Connection Handler Msg](media/WebSocket%20Connection%20Handler%20Msg.png)
295+
296+
**Client/Service Enqueuer** The enqueuer of the Client/Service to which we subscribed that triggered the event
297+
298+
**Connection Event** Enum specifying the type of event being triggered. Can take values "On Connect", "On Message", "On Close", and "On Drop"
299+
300+
**Data** String containing the data being received if the event triggered is of type "On Message"
301+
302+
**Data Format** Enum specifying the type of data being received in case of a "On Message" event. It can take values "Binary" and "Text"
303+
304+
**Peer ID** String specifying the Peer ID from which the event is being triggered if the event is originating from a client
305+
306+
**Service Name** String specifying the service name from which the event is being triggered

WebSocket Actor.aliases

Lines changed: 0 additions & 2 deletions
This file was deleted.
6.58 KB
Loading
11.1 KB
Loading
12.8 KB
Loading

0 commit comments

Comments
 (0)