CentralDispatch#
- class scqubits.core.central_dispatch.CentralDispatch[source]#
Primary class managing the central dispatch system.
Methods
CentralDispatch.__init__
()For given event, return the dict mapping each registered client to their callback routine
CentralDispatch.listen
(caller, event, **kwargs)Receive message from client caller for event event.
CentralDispatch.register
(event, who[, callback])Register object who for event event.
CentralDispatch.unregister
(event, who)Unregister object who from event event.
Unregister object who from all events.
- get_clients_dict(event)[source]#
For given event, return the dict mapping each registered client to their callback routine
- Parameters:
event (str) – event name from EVENTS
- Return type:
dict
- listen(caller, event, **kwargs)[source]#
Receive message from client caller for event event. If dispatch is globally enabled, trigger a dispatch to all clients registered for event.
- Parameters:
caller (DispatchClient) – object requesting the dispatch
event (str) – event name from EVENTS
**kwargs –
- Return type:
None
- register(event, who, callback=None)[source]#
Register object who for event event. (This modifies clients_dict.)
- Parameters:
event (str) – event name from EVENTS
who (DispatchClient) – object to be registered
callback (method, optional) – custom callback method other than .receive()
- Return type:
None
- unregister(event, who)[source]#
Unregister object who from event event. (This modifies clients_dict.)
- Parameters:
event (str) – event name from EVENTS
who (DispatchClient) – object to be unregistered
- Return type:
None
- unregister_object(who)[source]#
Unregister object who from all events. (This modifies clients_dict.)
- Parameters:
who (DispatchClient) – object to be unregistered
- Return type:
None