rad.core.dispatcher.Dispatcher Class Reference

Simple class that dispatches events to registered handlers. More...

Public Member Functions
def	__init__
def	register_handler
	Registers a handler for an event id. More...
def	unregister_handler
	Unregisters a handler for an event id. More...
def	dispatch
	Dispatch event to all registered handlers. More...
def	__init__
def	register_handler
	Registers a handler for an event id. More...
def	unregister_handler
	Unregisters a handler for an event id. More...
def	dispatch
	Dispatch event to all registered handlers. More...

Detailed Description

Simple class that dispatches events to registered handlers.

Usage::

def handler(event):
    # Do something with event
    pass

dispatcher = Dispatcher()
dispatcher.register_handler('myevent', handler)

# Dispatch an event
dispatcher.dispatch(Event('myevent', payload=None))

Constructor & Destructor Documentation

def rad.core.dispatcher.Dispatcher.__init__

(

self

)

def rad.core.dispatcher.Dispatcher.__init__

(

self

)

Member Function Documentation

def rad.core.dispatcher.Dispatcher.dispatch	(		self,
			event
	)

Dispatch event to all registered handlers.

def rad.core.dispatcher.Dispatcher.dispatch	(		self,
			event
	)

Dispatch event to all registered handlers.

def rad.core.dispatcher.Dispatcher.register_handler	(		self,
			event_id
	)

Registers a handler for an event id.

Params

event_id The event identifier. handler A callable object that takes the event as argument.

Returns

A registration token that must be used to unregister the handler with unregister_handler.

def rad.core.dispatcher.Dispatcher.register_handler	(		self,
			event_id
	)

Registers a handler for an event id.

Params

event_id The event identifier. handler A callable object that takes the event as argument.

Returns

A registration token that must be used to unregister the handler with unregister_handler.

def rad.core.dispatcher.Dispatcher.unregister_handler	(		self,
			token
	)

Unregisters a handler for an event id.

Params

token Token received when registering the handler.

def rad.core.dispatcher.Dispatcher.unregister_handler	(		self,
			token
	)

Unregisters a handler for an event id.

Params

token Token received when registering the handler.

---

The documentation for this class was generated from the following files:

• INTROOT/lib/python3.7/site-packages/rad/core/dispatcher.py
• rad/py/rad/src/rad/core/dispatcher.py