Browse code

websocket Document dependency on the TM module

Olle E. Johansson authored on 07/02/2015 13:21:42
Showing 2 changed files
... ...
@@ -4,7 +4,7 @@ Peter Dunkley
4 4
 
5 5
    Crocodile RCS Ltd
6 6
 
7
-   Copyright © 2012-2013 Crocodile RCS Ltd
7
+   Copyright � 2012-2013 Crocodile RCS Ltd
8 8
      __________________________________________________________________
9 9
 
10 10
    Table of Contents
... ...
@@ -129,11 +129,11 @@ Chapter 1. Admin Guide
129 129
 2.1. Initiating a connection
130 130
 
131 131
    A WebSocket connection is initiated with an HTTP GET. The xhttp module
132
-   is used to handle this GET and call the Section 5.1, “
133
-   ws_handle_handshake() ” exported function.
132
+   is used to handle this GET and call the Section 5.1, "
133
+   ws_handle_handshake() " exported function.
134 134
 
135 135
    event_route[xhttp:request] should perform some validation of the HTTP
136
-   headers before calling Section 5.1, “ ws_handle_handshake() ”. The
136
+   headers before calling Section 5.1, " ws_handle_handshake() ". The
137 137
    event_route can also be used to make sure the HTTP GET has the correct
138 138
    URI, perform HTTP authentication on the WebSocket connection, and check
139 139
    the Origin header (RFC 6454) to ensure a browser-based SIP UA or MSRP
... ...
@@ -299,6 +299,7 @@ onreply_route[WS_REPLY] {
299 299
 
300 300
    The following module must be loaded before this module:
301 301
      * sl.
302
+     * tm.
302 303
 
303 304
    The following modules are required to make proper use of this module:
304 305
      * nathelper or outbound.
... ...
@@ -436,7 +437,7 @@ modparam("websocket", "cors_mode", 2)
436 437
    5.1. ws_handle_handshake()
437 438
    5.2. ws_close([status, reason[, connection_id]])
438 439
 
439
-5.1.  ws_handle_handshake()
440
+5.1. ws_handle_handshake()
440 441
 
441 442
    This function checks an HTTP GET request for the required headers and
442 443
    values, and (if successful) upgrades the connection from HTTP to
... ...
@@ -455,7 +456,7 @@ Note
455 456
 ws_handle_handshake();
456 457
 ...
457 458
 
458
-5.2.  ws_close([status, reason[, connection_id]])
459
+5.2. ws_close([status, reason[, connection_id]])
459 460
 
460 461
    This function closes a WebSocket connection.
461 462
 
... ...
@@ -496,7 +497,7 @@ ws_close(4000, "Because I say so");
496 497
    Name: ws.dump
497 498
 
498 499
    Parameters:
499
-     * order (optional) - “id_hash”, “used_desc”, or “used_asc”.
500
+     * order (optional) - "id_hash", "used_desc", or "used_asc".
500 501
 
501 502
 Note
502 503
 
... ...
@@ -581,7 +582,7 @@ Note
581 582
 
582 583
    7.1. websocket:closed
583 584
 
584
-7.1.  websocket:closed
585
+7.1. websocket:closed
585 586
 
586 587
    When defined, the module calls event_route[websocket:closed] when a
587 588
    connection closes. The connection may be identified using the the $si
... ...
@@ -218,6 +218,9 @@ onreply_route[WS_REPLY] {
218 218
 		<listitem>
219 219
 		<para><emphasis>sl</emphasis>.</para>
220 220
 		</listitem>
221
+		<listitem>
222
+		<para><emphasis>tm</emphasis>.</para>
223
+		</listitem>
221 224
 		</itemizedlist>
222 225
 		</para>
223 226
 		<para>