diff --git a/autobahn/autobahn/resource.py b/autobahn/autobahn/resource.py index e4eada9e..fa472916 100644 --- a/autobahn/autobahn/resource.py +++ b/autobahn/autobahn/resource.py @@ -35,6 +35,8 @@ class HTTPChannelHixie76Aware(HTTPChannel): set content-length header. This hacked HTTPChannel injects the missing HTTP header upon detecting Hixie-76. We need this since otherwise Twisted Web will silently ignore the body. + + To use this, set twisted.web.server.Site.protocol = HTTPChannelHixie76Aware """ def headerReceived(self, line): diff --git a/autobahn/autobahn/wamp.py b/autobahn/autobahn/wamp.py index 1523406c..d7e78cd0 100644 --- a/autobahn/autobahn/wamp.py +++ b/autobahn/autobahn/wamp.py @@ -1478,6 +1478,7 @@ class WampCraClientProtocol(WampClientProtocol, WampCraProtocol): :type authExtra: dict :param authSecret: The secret of the authentication credentials, something like the user password or application secret key. :type authsecret: str + :returns Deferred -- Deferred that fires upon authentication success (with permissions) or failure. """ def _onAuthChallenge(challenge): @@ -1617,7 +1618,7 @@ class WampCraServerProtocol(WampServerProtocol, WampCraProtocol): @exportRpc("authreq") def authRequest(self, appkey = None, extra = None): """ - RPC for clients to initiate the authentication handshake. + RPC endpoint for clients to initiate the authentication handshake. :param appkey: Authentication key, such as user name or application name. :type appkey: str @@ -1700,7 +1701,7 @@ class WampCraServerProtocol(WampServerProtocol, WampCraProtocol): @exportRpc("auth") def auth(self, signature = None): """ - RPC for clients to actually authenticate after requesting authentication and computing + RPC endpoint for clients to actually authenticate after requesting authentication and computing a signature from the authentication challenge. :param signature: Authenticatin signature computed by the client. diff --git a/autobahn/setup.py b/autobahn/setup.py index ca3e6372..c24c4df7 100644 --- a/autobahn/setup.py +++ b/autobahn/setup.py @@ -40,7 +40,7 @@ Source Code: setup ( name = 'autobahn', - version = '0.5.4', + version = '0.5.5', description = 'AutobahnPython - WebSocket/WAMP implementation for Python/Twisted.', long_description = LONGSDESC, license = 'Apache License 2.0', diff --git a/doc/conf.py b/doc/conf.py index 5d256f3e..715d78f0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -50,7 +50,7 @@ copyright = u'2011,2012 Tavendo GmbH' # The short X.Y version. version = '0.5' # The full version, including alpha/beta/rc tags. -release = '0.5.2' +release = '0.5.5' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/doc/wampbase.rst b/doc/wampbase.rst index 0c9b1208..60c7c3a5 100644 --- a/doc/wampbase.rst +++ b/doc/wampbase.rst @@ -25,4 +25,5 @@ Protocol :members: URI_WAMP_BASE, URI_WAMP_ERROR, URI_WAMP_RPC, - URI_WAMP_EVENT + URI_WAMP_EVENT, + authSignature diff --git a/doc/wampclient.rst b/doc/wampclient.rst index 3f1ff66c..c371a8a8 100644 --- a/doc/wampclient.rst +++ b/doc/wampclient.rst @@ -29,5 +29,4 @@ Protocol .. autoclass:: autobahn.wamp.WampCraClientProtocol - :members: authenticate, - authSignature + :members: authenticate diff --git a/doc/wampserver.rst b/doc/wampserver.rst index 87843a71..71b3e706 100644 --- a/doc/wampserver.rst +++ b/doc/wampserver.rst @@ -27,6 +27,8 @@ Protocol registerForRpc, registerMethodForRpc, registerProcedureForRpc, + registerHandlerMethodForRpc, + registerHandlerProcedureForRpc, registerForPubSub, registerHandlerForPubSub, registerHandlerForSub, diff --git a/doc/websocketaux.rst b/doc/websocketaux.rst index 6cd679e1..f281f381 100644 --- a/doc/websocketaux.rst +++ b/doc/websocketaux.rst @@ -32,3 +32,15 @@ Opening Handshake .. autoclass:: autobahn.websocket.HttpException :members: __init__ + + +Web Resource +------------ + +.. autoclass:: autobahn.resource.WebSocketResource + :members: __init__, + getChildWithDefault, + putChild, + render + +.. autoclass:: autobahn.resource.HTTPChannelHixie76Aware