commit 37a0f5a1a4c466f0030dcebfd0168e82e5139036 Author: David Fifield <david@bamsoftware.com> Date: Wed Oct 16 21:28:00 2013 -0700 Update documentation of get_reg. --- facilitator/fac.py | 12 ++++++------ facilitator/facilitator | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/facilitator/fac.py b/facilitator/fac.py index 88365e5..842668d 100644 --- a/facilitator/fac.py +++ b/facilitator/fac.py @@ -295,13 +295,13 @@ def put_reg(facilitator_addr, client_addr, transport): def get_reg(facilitator_addr, proxy_addr, proxy_transport_list): """ - Get a client registration for proxy 'proxy_addr' from the - facilitator at 'facilitator_addr' using a one-time - socket. 'transports' is a list containing the transport names that + Get a client registration for proxy proxy_addr from the + facilitator at facilitator_addr using a one-time + socket. proxy_transport_list is a list containing the transport names that the flashproxy supports. - Returns a dict with keys "client-<transport>" and - "relay-<transport>" if successful, or a dict with the key "client" + Returns a dict with keys "client" and + "relay" if successful, or a dict with the key "client" mapped to the value "" if there are no registrations available for proxy_addr. Raises an exception otherwise.""" f = fac_socket(facilitator_addr) @@ -309,7 +309,7 @@ def get_reg(facilitator_addr, proxy_addr, proxy_transport_list): # Form a list (in transact() format) with the transports that we # should send to the facilitator. Then pass that list to the # transact() function. - # For example, TRANSPORT=obfs2 TRANSPORT=obfs3. + # For example, PROXY_TRANSPORT=obfs2 PROXY_TRANSPORT=obfs3. transports = [("PROXY_TRANSPORT", tp) for tp in proxy_transport_list] try: diff --git a/facilitator/facilitator b/facilitator/facilitator index 71d0293..670a01d 100755 --- a/facilitator/facilitator +++ b/facilitator/facilitator @@ -287,7 +287,7 @@ class Handler(SocketServer.StreamRequestHandler): return False # Handle a GET request (got flashproxy poll; need to return a proper client registration) - # Example: GET FROM="3.3.3.3:3333" TRANSPORT="websocket" TRANSPORT="webrtc" + # Example: GET FROM="3.3.3.3:3333" PROXY_TRANSPORT="websocket" PROXY_TRANSPORT="webrtc" def do_GET(self, params): proxy_spec = fac.param_first("FROM", params) if proxy_spec is None: