Package arvados :: Module events
[hide private]
[frames] | no frames]

Module events

source code

Classes [hide private]
  _EventClient
  EventClient
  PollClient
Functions [hide private]
 
_subscribe_websocket(api, filters, on_event, last_log_id=None) source code
 
subscribe(api, filters, on_event, poll_fallback=15, last_log_id=None)
:api: a client object retrieved from arvados.api().
source code
Variables [hide private]
  _logger = logging.getLogger('arvados.events')
Function Details [hide private]

subscribe(api, filters, on_event, poll_fallback=15, last_log_id=None)

source code 

:api:
  a client object retrieved from arvados.api(). The caller should not use this client object for anything else after calling subscribe().
:filters:
  Initial subscription filters.
:on_event:
  The callback when a message is received.
:poll_fallback:
  If websockets are not available, fall back to polling every N seconds.  If poll_fallback=False, this will return None if websockets are not available.
:last_log_id:
  Log rows that are newer than the log id