aboutsummaryrefslogtreecommitdiff
path: root/docs/web-socket.md
diff options
context:
space:
mode:
authort-harvey <t-harvey@ti.com>2018-07-13 10:20:24 -0500
committerGeoff Gustafson <geoff@linux.intel.com>2018-07-13 08:20:24 -0700
commit6d21e1710076b3b67759aaa7d88ecbd84e8ac68a (patch)
treeb38ac32bdd5a7c32dede940349df93406985cf6f /docs/web-socket.md
parent3a701fbe2f17982ea696d86a83e7ba775e9587d7 (diff)
[docs] Update WebIDL and modify docs to fit new "node.js-like" style, Part 2 (#1893)
Reinserted WebIDL for buffer.md; changed the WebIDL in aio and ble to be syntactically correct and to follow the new style of buffer.md. Added a new file that explains some of the differences between WebIDL and Javascript. Signed-off-by: Timothy Harvey <t-harvey@ti.com>
Diffstat (limited to 'docs/web-socket.md')
-rw-r--r--docs/web-socket.md98
1 files changed, 55 insertions, 43 deletions
diff --git a/docs/web-socket.md b/docs/web-socket.md
index f3fc58c..806a7d9 100644
--- a/docs/web-socket.md
+++ b/docs/web-socket.md
@@ -3,47 +3,61 @@ ZJS API for Web Sockets
* [Introduction](#introduction)
* [Web IDL](#web-idl)
-* [API Documentation](#api-documentation)
+* [WebSocket API](#websocket-api)
+ * [ws.Server(options)](#wsserveroptions)
+* [WebSocketServer API](#websocketserver-api)
+ * [Event: 'connection'](#event-connection)
+* [WebSocket API](#websocket-api)
+ * [Event: 'close'](#event-close)
+ * [Event: 'error'](#event-error)
+ * [Event: 'message'](#event-message)
+ * [Event: 'ping'](#event-ping)
+ * [Event: 'pong'](#event-pong)
+* [WebSocketConnection API](#websocketconnection-api)
+ * [webSocketConnection.send(data, mask)](#websocketconnectionsenddata-mask)
+ * [webSocketConnection.ping(data, mask)](#websocketconnectionpingdata-mask)
+ * [webSocketConnection.pong(data, mask)](#websocketconnectionpongdata-mask)
* [Sample Apps](#sample-apps)
Introduction
------------
The Web Socket API is modeled after Node.js' 'ws' module. This module only
-supports the Web Socket server portion of the API.
+supports the Web Socket server portion of that API.
Web IDL
-------
-This IDL provides an overview of the interface; see below for documentation of
-specific API functions.
+This IDL provides an overview of the interface; see below for
+documentation of specific API functions. We have a short document
+explaining [ZJS WebIDL conventions](Notes_on_WebIDL.md).
-```javascript
-// require returns a WebSocket object
+<details>
+<summary>Click to show WebIDL</summary>
+<pre>// require returns a WebSocket object
// var ws = require('ws');
-
+[ReturnFromRequire]
interface WebSocket {
- WebSocketServer Server(Object options);
-};
-
-interface WebSocketServer: EventEmitter;
-
+ WebSocketServer Server(object options);
+};<p>
+[ExternalInterface=(EventEmitter)]
+interface WebSocketServer: EventEmitter{};<p>[ExternalInterface=(Buffer),]
interface WebSocketConnection: EventEmitter {
- // WebSocketConnection methods
- void send(Buffer data, Boolean mask);
- void ping(Buffer data, Boolean mask);
- void pong(Buffer data, Boolean mask);
-};
-```
+ void send(Buffer data, boolean mask);
+ void ping(Buffer data, boolean mask);
+ void pong(Buffer data, boolean mask);
+};</pre>
+</details>
-WebSocket API Documentation
----------------------------
+WebSocket API
+-------------
-### WebSocket.Server
-`WebSocketServer Server(Object options)`
+### ws.Server(options)
+* `options` *Object*
+* Returns: a WebSocketServer object.
Create a Web Socket server object. Options object may contain:
-WebSocketServer API Documentation
----------------------------------
+WebSocketServer API
+-------------------
WebSocketServer is [EventEmitter](./events.md) with the following events:
@@ -70,10 +84,10 @@ strings from the handler.
Returns a `WebSocketServer` object.
-WebSocketConnection API Documentation
--------------------------------------
+WebSocket API
+-------------
-WebSocketServer is [EventEmitter](./events.md) with the following events:
+WebSocketServer is an [EventEmitter](./events.md) with the following events:
### Event: 'close'
@@ -107,29 +121,27 @@ the `data` argument.
Emitted when the socket has received a pong. The pong's payload is contained in
the `data` argument.
-### WebSocketConnection.send
-
-`void send(Buffer data, Boolean mask)`
-Send data to the other end of the web socket connection. The `data` parameter
-should contain the data payload to send. The `mask` parameter says whether the
-data payload should be masked.
+WebSocketConnection API
+-----------------------
-### WebSocketConnection.ping
+### webSocketConnection.send(data, mask)
+* `data` *Buffer* The data payload to send.
+* `mask` *boolean* Describes whether the data payload should be masked.
-`void ping(Buffer data, Boolean mask)`
+Send data to the other end of the web socket connection.
-Send a ping to the other end of the web socket connection. The `data` parameter
-should contain the data payload to send. The `mask` parameter says whether the
-data payload should be masked.
+### webSocketConnection.ping(data, mask)
+* `data` *Buffer* Contains the data payload to send.
+* `mask` *boolean* Describes whether the data payload should be masked.
-### WebSocketConnection.pong
+Send a ping to the other end of the web socket connection.
-`void pong(Buffer data, Boolean mask)`
+### webSocketConnection.pong(data, mask)
+* `data` *Buffer* The data payload to send.
+* `mask` *boolean* Describes whether the data payload should be masked.
-Send a pong to the other end of the web socket connection. The `data` parameter
-should contain the data payload to send. The `mask` parameter says whether the
-data payload should be masked.
+Send a pong to the other end of the web socket connection.
Sample Apps
-----------