openstack/deb-python-autobahn
Code Issues Proposed changes

update docs, bump version

Browse Source
This commit is contained in:
Tobias Oberstein
2012-07-23 13:47:02 +02:00
parent 0736101386
commit 1fdb4446ec
8 changed files with 24 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
autobahn/autobahn/resource.py
View File

@@ -35,6 +35,8 @@ class HTTPChannelHixie76Aware(HTTPChannel):
set content-length header. This hacked HTTPChannel injects the missing set content-length header. This hacked HTTPChannel injects the missing
HTTP header upon detecting Hixie-76. We need this since otherwise HTTP header upon detecting Hixie-76. We need this since otherwise
Twisted Web will silently ignore the body. Twisted Web will silently ignore the body.
To use this, set twisted.web.server.Site.protocol = HTTPChannelHixie76Aware
""" """
def headerReceived(self, line): def headerReceived(self, line):

5
autobahn/autobahn/wamp.py
View File

@@ -1478,6 +1478,7 @@ class WampCraClientProtocol(WampClientProtocol, WampCraProtocol):
:type authExtra: dict :type authExtra: dict
:param authSecret: The secret of the authentication credentials, something like the user password or application secret key. :param authSecret: The secret of the authentication credentials, something like the user password or application secret key.
:type authsecret: str :type authsecret: str
:returns Deferred -- Deferred that fires upon authentication success (with permissions) or failure.
""" """
def _onAuthChallenge(challenge): def _onAuthChallenge(challenge):
@@ -1617,7 +1618,7 @@ class WampCraServerProtocol(WampServerProtocol, WampCraProtocol):
@exportRpc("authreq") @exportRpc("authreq")
def authRequest(self, appkey = None, extra = None): 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. :param appkey: Authentication key, such as user name or application name.
:type appkey: str :type appkey: str
@@ -1700,7 +1701,7 @@ class WampCraServerProtocol(WampServerProtocol, WampCraProtocol):
@exportRpc("auth") @exportRpc("auth")
def auth(self, signature = None): 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. a signature from the authentication challenge.
:param signature: Authenticatin signature computed by the client. :param signature: Authenticatin signature computed by the client.

2
autobahn/setup.py
View File

@@ -40,7 +40,7 @@ Source Code:
setup ( setup (
name = 'autobahn', name = 'autobahn',
version = '0.5.4', version = '0.5.5',
description = 'AutobahnPython - WebSocket/WAMP implementation for Python/Twisted.', description = 'AutobahnPython - WebSocket/WAMP implementation for Python/Twisted.',
long_description = LONGSDESC, long_description = LONGSDESC,
license = 'Apache License 2.0', license = 'Apache License 2.0',

2
doc/conf.py
View File

@@ -50,7 +50,7 @@ copyright = u'2011,2012 Tavendo GmbH'
# The short X.Y version. # The short X.Y version.
version = '0.5' version = '0.5'
# The full version, including alpha/beta/rc tags. # 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 # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.

3
doc/wampbase.rst
View File

@@ -25,4 +25,5 @@ Protocol
:members: URI_WAMP_BASE, :members: URI_WAMP_BASE,
URI_WAMP_ERROR, URI_WAMP_ERROR,
URI_WAMP_RPC, URI_WAMP_RPC,
URI_WAMP_EVENT URI_WAMP_EVENT,
authSignature

3
doc/wampclient.rst
View File

@@ -29,5 +29,4 @@ Protocol
.. autoclass:: autobahn.wamp.WampCraClientProtocol .. autoclass:: autobahn.wamp.WampCraClientProtocol
:members: authenticate, :members: authenticate
authSignature

2
doc/wampserver.rst
View File

@@ -27,6 +27,8 @@ Protocol
registerForRpc, registerForRpc,
registerMethodForRpc, registerMethodForRpc,
registerProcedureForRpc, registerProcedureForRpc,
registerHandlerMethodForRpc,
registerHandlerProcedureForRpc,
registerForPubSub, registerForPubSub,
registerHandlerForPubSub, registerHandlerForPubSub,
registerHandlerForSub, registerHandlerForSub,

12
doc/websocketaux.rst
View File

@@ -32,3 +32,15 @@ Opening Handshake
.. autoclass:: autobahn.websocket.HttpException .. autoclass:: autobahn.websocket.HttpException
:members: __init__ :members: __init__
Web Resource
------------
.. autoclass:: autobahn.resource.WebSocketResource
:members: __init__,
getChildWithDefault,
putChild,
render
.. autoclass:: autobahn.resource.HTTPChannelHixie76Aware