l.a.longpoll : package documentation

Part of lp.app

Long-poll infrastructure.
Package tests No package docstring; 1/1 modules documented

From the __init__.py module:

Function emit Convenience method to emit a message for an event.
Function subscribe Convenience method to subscribe the current request.
def subscribe(target, event_name=u'', request=None):
Convenience method to subscribe the current request.
ParameterstargetSomething that can be adapted to ILongPollEvent.
event_nameThe name of the event to subscribe to. This is used to look up a named adapter from target to ILongPollEvent.
requestThe request for which to get an ILongPollSubscriber. It a request is not specified the currently active request is used.
ReturnsThe ILongPollEvent that has been subscribed to.
def emit(source, event_name=u'', **data):
Convenience method to emit a message for an event.
ParameterssourceSomething that can be adapted to ILongPollEvent.
event_nameThe name of the event to subscribe to. This is used to look up a named adapter from target to ILongPollEvent.
dataSee ILongPollEvent.emit.
ReturnsThe ILongPollEvent that has been emitted.
API Documentation for Launchpad, generated by pydoctor at 2018-11-19 00:00:14.