2009-11-25 Yuzo Fujishima <yuzo@google.com>
[WebKit-https.git] / WebKitTools / pywebsocket / mod_pywebsocket / __init__.py
index 8acd13340151dc67fcabc634b0d5eb359ec5f859..05e80e8b37f83d7697ace30976e3ead0136dd974 100644 (file)
@@ -51,6 +51,14 @@ Installation:
        PythonOption mod_pywebsocket.handler_root <websock_handlers>
        PythonHeaderParserHandler mod_pywebsocket.headerparserhandler
 
+   To limit the search for Web Socket handlers to a directory <scan_dir>
+   under <websock_handlers>, configure as follows:
+   
+       PythonOption mod_pywebsocket.handler_scan <scan_dir>
+       
+   <scan_dir> is useful in saving scan time when <websock_handlers>
+   contains many non-Web Socket handler files.
+
    Example snippet of httpd.conf:
    (mod_pywebsocket is in /websock_lib, Web Socket handlers are in
    /websock_handlers, port is 80 for ws, 443 for wss.)
@@ -88,6 +96,9 @@ web_socket_transfer_data is called after the handshake completed
 successfully. A handler can receive/send messages from/to the client
 using request. mod_pywebsocket.msgutil module provides utilities
 for data transfer.
+
+A Web Socket handler must be thread-safe if the server (Apache or
+standalone.py) is configured to use threads.
 """