activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chir...@apache.org
Subject svn commit: r1239093 - /activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md
Date Wed, 01 Feb 2012 11:50:02 GMT
Author: chirino
Date: Wed Feb  1 11:50:02 2012
New Revision: 1239093

URL: http://svn.apache.org/viewvc?rev=1239093&view=rev
Log:
Document the WebSocket transport.

Modified:
    activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md

Modified: activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md?rev=1239093&r1=1239092&r2=1239093&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md Wed Feb
 1 11:50:02 2012
@@ -195,6 +195,29 @@ Example which uses a couple of options:
 Note that `&` was used to separate the option values instead of just `&` since
the 
 URI being written within an XML file.
 
+##### WebSocket Transports
+
+The WebSocket transport uses the `ws://` URI scheme and the
+secure WebSocket transport uses the `wss://` URI scheme.  Like
+the TCP transport, the use the URI host
+and port to determine to which local interfaces to bind.  For example:
+
+* `ws://0.0.0.0:61623` binds to all IPv4 interfaces on port 61623
+* `ws://[::]:61623` binds to all IPv4 and IPv6 interfaces on port 61623
+* `wss://127.0.0.1:0` binds to the loopback interface on a dynamic port
+
+The WebSocket URI also supports the following query parameters to fine tune the
+settings used on the socket:
+
+* `binary_transfers` : Should data be sent to the client as binary blobs. Currently
+  not all browsers support binary WebSocket data.  Defaults to false.
+  
+Example usage:
+
+{pygmentize:: xml}
+<connector id="ws" bind="ws://0.0.0.0:61623?binary_transfers=true"/>
+{pygmentize}
+
 #### Virtual Hosts
 
 A virtual hosts allows ${project_name} to support multi tenant style



Mime
View raw message