sardanaevent

This module is part of the Python Pool libray. It defines the base classes for pool event mechanism

Classes

EventGenerator

EventReceiver

EventType

EventGenerator

class EventGenerator(max_queue_len=10, listeners=None)

A class capable of generating events to their listeners

add_listener(listener)

Adds a new listener for this object.

Parameters:

listener – a listener

remove_listener(listener)

Removes an existing listener for this object.

Parameters:

listener – the listener to be removed

Returns:

True is succeeded or False otherwise

has_listeners()

Returns True if anybody is listening to events from this object

Returns:

True is at least one listener is listening or False otherwise

get_listeners()

fire_event(event_type, event_value, listeners=None)

queue_event(event_type, event_value, listeners=None)

flush_queue()

EventReceiver

class EventReceiver

A simple class that implements useful features for a class which is an event receiver. The actual class may inherit from this EventReceiver class and may choose to use just a part of the API provided by this class, the whole API or none of the API.

block_events()

unblock_events()

are_events_blocked()

EventType

class EventType(name, priority=0)

Definition of an event type

get_name()

Returns this event name

Returns:

this event name

Return type:

str

get_priority()

Returns this event priority

Returns:

this event priority

Return type:

str