diff options
| author | drebs <drebs@leap.se> | 2013-07-24 17:51:03 -0300 |
|---|---|---|
| committer | drebs <drebs@leap.se> | 2013-07-24 18:08:36 -0300 |
| commit | e7fa419f13e0afbb3f2653a4b0d8330dd45bbfd0 (patch) | |
| tree | 62626661cf063af8bf4143e981c489f3e73a2b2f /src/leap/common/events/server.py | |
| parent | b7c74e4f293d0e611ea038e04022fbe700a8cb42 (diff) | |
Add doc and tests about events sync/async behaviour.
* Also fix docstrings identation so sphynx doesn't complain.
Diffstat (limited to 'src/leap/common/events/server.py')
| -rw-r--r-- | src/leap/common/events/server.py | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/src/leap/common/events/server.py b/src/leap/common/events/server.py index daccc61..a7d4da9 100644 --- a/src/leap/common/events/server.py +++ b/src/leap/common/events/server.py @@ -69,7 +69,7 @@ def ensure_server(port=SERVER_PORT): :rtype: EventsServerDaemon or None :raise PortAlreadyTaken: Raised if C{port} is already taken by something - that is not an events server. + that is not an events server. """ try: # check if port is available @@ -97,11 +97,14 @@ def ping(port=SERVER_PORT, reqcbk=None, timeout=1000): :param port: the port in which server should be listening :type port: int :param reqcbk: a callback to be called when a response from server is - received - :type reqcbk: function - callback(leap.common.events.events_pb2.EventResponse) + received + :type reqcbk: function(leap.common.events.events_pb2.EventResponse) :param timeout: the timeout for synch calls :type timeout: int + + :return: the response from server for synch calls or nothing for asynch + calls. + :rtype: leap.common.events.events_pb2.EventsResponse or None """ request = proto.PingRequest() service = RpcService( |