Observable.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
namespace DataProvider {
class Observable {
 
public:
protected:
        hash<string, hash<ObserverEventInfo>> observer_map;
 
public:
 
 
    registerObserver(Observer observer, ...);
 
 
 
    registerObserver(object observer, ...);
 
 
 
    registerObserverArgs(Observer observer, *list<auto> event_ids);
 
 
 
    registerObserverArgs(object observer, *list<auto> event_ids);
 
 
 
    registerObserverWithFilter(Observer observer, AbstractEventFilter filter, ...);
 
 
 
    registerObserverWithFilter(object observer, AbstractEventFilter filter, ...);
 
 
 
    registerObserverWithFilterArgs(Observer observer, AbstractEventFilter filter, *list<auto> event_ids);
 
 
 
    registerObserverWithFilter(object observer, AbstractEventFilter filter, list<auto> event_ids);
 
 
 
    bool deregisterObserver(Observer observer);
 
 
 
    bool deregisterObserver(object observer);
 
 
 
    notifyObservers(string event_id, hash<auto> data_);
 
 
 
    log(int level, string fmt, ...);
 
 
 
    bool isActive();
 
 
 
    handoverObservers(Observable other);
 
 
protected:
     hash<ObserverEventInfo> registerObserverEventsArgs(hash<ObserverEventInfo> info, list<auto> events);
public:
 
};
 
class DelayedObservable : public Observable {
 
public:
 
    abstract observersReady();
 
 
    stopEvents();
 
};
 
class AbstractEventFilter : public Qore::Serializable {
 
public:
    abstract bool filter(string event_id, hash<auto> event);
};
};
 
// private namespace; not exported
namespace Priv {
// Stores an observer with any subscribed events
hashdecl ObserverEventInfo {
    // Observer
    Observer observer;
 
    // event filter object
    *AbstractEventFilter filter;
 
    // Map of subscribed event IDs; if the map is empty, then all events are registered
    hash<string, bool> event_map;
}
 
// wraps a foreign observer object as an Observer
class ObserverWrapper : public Observer {
 
public:
protected:
        object obj;
 
public:
 
    // creates the wrapper object
    constructor(object obj);
 
 
    // calls the wrapped object's update method
    update(string event_id, hash<auto> data_);
 
};
}