AsyncObject.h

/* -*- C++ -*-
 *  Copyright (c) 2006-2009, Isode Limited, London, England.
 *  All rights reserved.
 *                                                                       
 *  Acquisition and use of this software and related materials for any      
 *  purpose requires a written licence agreement from Isode Limited,
 *  or a written licence from an organisation licenced by Isode Limited
 *  to grant such a licence.
 */
 
/* 
 *
 * \file AsyncObj.h
 *
 * \brief Enabler for facilitating submission of events to event manager
 *
 * @VERSION@
 */
 
#ifndef _ASYNCOBJ_H_
#define _ASYNCOBJ_H_
 
#include "EventSvc.h"
 
#ifdef __cplusplus
 
namespace Event {
 
 
    class AsyncObject : public AsyncEvent {
    public:
        typedef void (*FuncPtr) (void *);
 
    private:
        FuncPtr       func;       
        void         *farg;       
 
        AsyncObject () : func (0),  farg(0) {}
 
    public:
        virtual ~AsyncObject() {}
 
        virtual void Deliver () {
            if ( func ) (*func)(farg);
            delete this;
        }
 
        inline static void Invoke (FuncPtr fnx, void *arg) {
            AsyncObject *obj = new AsyncObject;
            obj->func = fnx;
            obj->farg = arg;
            Event::Manager::GetManager()->Queue (obj, 0);
        }
 
        inline static void Invoke (FuncPtr fnx, void *arg, unsigned msecs) {
            AsyncObject *obj = new AsyncObject;
            obj->func = fnx;
            obj->farg = arg;
            Event::Manager::GetManager()->QueueAt (obj, msecs);
        }
 
        inline static void Invoke (FuncPtr fnx, void *arg,
                                   const struct timespec *abstime) {
            AsyncObject *obj = new AsyncObject;
            obj->func = fnx;
            obj->farg = arg;
            Event::Manager::GetManager()->QueueAt (obj, abstime);
        }
    };
 
    // to be invoked on the object. No arguments are passed to the method
 
    template <class C> class AsyncMethod : public AsyncEvent {
        typedef void (C::*MethodPtr) ();
 
        MethodPtr     method;     
        C            *object;     
 
        AsyncMethod () : method (0) {}
 
    public:
        virtual ~AsyncMethod() {}
 
        virtual void Deliver () {
            if ( method && object ) (object->*method)();
            delete this;
        }
 
        inline static void Invoke (C *obj, MethodPtr fnx) {
            AsyncMethod *aobj = new AsyncMethod;
            aobj->object = obj;
            aobj->method = fnx;
            Event::Manager::GetManager()->Queue (aobj, 0);
        }
    };
 
    // to be invoked on the object. One argument is passed to the method
 
    template <class C, class A> class AsyncMethodArg : public AsyncEvent {
        typedef void (C::*MethodPtr) (A argument);
 
        MethodPtr     method;     
        C            *object;     
        A             marg;       
 
        AsyncMethodArg () : method (0), marg(0) {}
 
    public:
        virtual ~AsyncMethodArg() {}
 
        virtual void Deliver () {
            if ( method && object ) (object->*method)(marg);
            delete this;
        }
 
        inline static void Invoke (C *obj, MethodPtr fnx, A arg) {
            AsyncMethodArg *aobj = new AsyncMethodArg;
            aobj->object = obj;
            aobj->method = fnx;
            aobj->marg   = arg;
            Event::Manager::GetManager()->Queue (aobj, 0);
        }
    };
}
 
#endif /* __cplusplus */
 
IC_CDECL EVENTSVC_DLL void EventAsyncDispatch (
    void (*func)(void *), 
    void *param           
);
 
#endif  /* _ASYNCOBJ_H_ */