Skip to content

Commit 4df290c

Browse files
committed
Small documentation edits
1 parent 768f2e2 commit 4df290c

1 file changed

Lines changed: 16 additions & 8 deletions

File tree

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,22 @@ Authors: Andrea Vaccaro - David Grollier
77

88
A library implementing a high-level actor-based WebSocket communication. An actor can subscribe to a WebSocket Actor (either server or client) to facilitate WebSocket-based communication.
99

10-
Please note that within this library **resource names** as defined in
11-
the WebSocket protocol specification are referred to as **services.**
10+
## Main Features
11+
12+
* Fully Actor Framework Based
13+
* Full WebSocket Compatibility
14+
* Support for WebSocket resources
15+
* Keepalive infrastructure
16+
* Secure connection capabilities
17+
18+
## Example Code
19+
20+
Look in the example folder for a comprehensive set of code examples covering the full functionality of the library.
21+
22+
## Note About Nomenclature
23+
24+
Please note that within this library **resource names**, as defined in
25+
the WebSocket protocol specification, are referred to as **services**.
1226

1327
# Library
1428

@@ -89,21 +103,15 @@ This abstract message is sent by either the WebSocket Client or by the
89103
WebSocket Service to the subscriber Actor on four events:
90104

91105
- Connect
92-
93106
- Disconnect
94-
95107
- Message
96-
97108
- Drop
98109

99110
For each subscriber Actor a concrete subclass of the message should be created by overriding the methods:
100111

101112
- "On Connect.vi"
102-
103113
- "On Disconnect.vi"
104-
105114
- "On Message.vi"
106-
107115
- "On Drop.vi"
108116

109117
The subscriber actor can program the required action for the

0 commit comments

Comments
 (0)