include/event.h

Go to the documentation of this file.

/*
 Copyright (C) 2011 Georgia Institute of Technology, University of Utah, Weill Cornell Medical College

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.

 */

#ifndef EVENT_H
#define EVENT_H

#include <fifo.h>
#include <list>
#include <map>
#include <pthread.h>
#include <rt.h>
#include <string>

/*
 * Objects contained within this namespace are responsible
 *   for dispatching signals.
 */
namespace Event {

    extern const char *RT_PERIOD_EVENT;
    extern const char *RT_PREPERIOD_EVENT;
    extern const char *RT_POSTPERIOD_EVENT;

    extern const char *RT_THREAD_INSERT_EVENT;
    extern const char *RT_THREAD_REMOVE_EVENT;
    extern const char *RT_DEVICE_INSERT_EVENT;
    extern const char *RT_DEVICE_REMOVE_EVENT;

    extern const char *IO_BLOCK_INSERT_EVENT;
    extern const char *IO_BLOCK_REMOVE_EVENT;

    extern const char *IO_LINK_INSERT_EVENT;
    extern const char *IO_LINK_REMOVE_EVENT;

    extern const char *WORKSPACE_PARAMETER_CHANGE_EVENT;

    extern const char *PLUGIN_INSERT_EVENT;
    extern const char *PLUGIN_REMOVE_EVENT;

    extern const char *SETTINGS_OBJECT_INSERT_EVENT;
    extern const char *SETTINGS_OBJECT_REMOVE_EVENT;

    extern const char *OPEN_FILE_EVENT;
    extern const char *START_RECORDING_EVENT;
    extern const char *STOP_RECORDING_EVENT;
    extern const char *ASYNC_DATA_EVENT;

    extern const char *THRESHOLD_CROSSING_EVENT;

    class Object {

    public:

        Object(const char *);
        ~Object(void);

        const char *getName(void) const { return name; };

        void *getParam(const char *) const;
        void setParam(const char *,void *);

        const static size_t MAX_PARAMS = 8;

    private:

        const char *name;
        size_t nparams;
        struct { const char *name; void *value; } params[MAX_PARAMS];

    }; // class Object

    class Handler;
    class RTHandler;

    /*
     * Managaes the collection of all objects waiting to
     *   receive signals from events.
     */
    class Manager {

        friend class Handler;
        friend class RTHandler;

    public:

        static Manager *getInstance(void);

        void postEvent(const Object *event);

        void postEventRT(const Object *event);

    private:

        Manager(void);
        ~Manager(void);
        Manager(const Manager &) {};
        Manager &operator=(const Manager &) { return *getInstance(); };

        static Manager *instance;

        void registerHandler(Handler *);
        void unregisterHandler(Handler *);

        void registerRTHandler(RTHandler *);
        void unregisterRTHandler(RTHandler *);

        Mutex mutex;
        std::list<Handler *> handlerList;
        RT::List<RTHandler> rthandlerList;

    }; // class Manager

    class Handler {

    public:

        Handler(void);
        virtual ~Handler(void);

        virtual void receiveEvent(const Object *event);

    }; // class Handler

    class RTHandler : public RT::List<RTHandler>::Node {

    public:

        RTHandler(void);
        virtual ~RTHandler(void);

        virtual void receiveEventRT(const Object *event);

    }; // class RTHandler

}; // namespace Event

#endif // EVENT_H