l.s.l.a.e.LongPollEvent : class documentation

Part of lp.services.longpoll.adapters.event View In Hierarchy

Known subclasses: lp.services.longpoll.adapters.storm.LongPollStormCreationEvent, lp.services.longpoll.adapters.storm.LongPollStormEvent, lp.services.longpoll.adapters.tests.test_event.FakeEvent

Base-class for event adapters.

Sub-classes need to define the event_key property and declare something along the lines of:

@adapter(IAwesomeThing)
@implementer(ILongPollEvent)
class LongPollAwesomeThingEvent(LongPollEvent):
    ...

Alternatively, use the long_poll_event class decorator:

@long_poll_event(IAwesomeThing)
class LongPollAwesomeThingEvent(LongPollEvent):
    ...

In both cases the adapter should be registered in a configure.zcml somewhere sensible:

<adapter factory=".adapters.LongPollAwesomeThingEvent" />
Method __init__ Undocumented
Method event_key See ILongPollEvent.
Method emit See ILongPollEvent.
def __init__(self, source):
Undocumented
@property
def event_key(self):
See ILongPollEvent.
def emit(self, **data):
See ILongPollEvent.

The data will be updated with event_key, a copy of self.event_key.

API Documentation for Launchpad, generated by pydoctor at 2019-04-23 00:00:05.