PollInterface.h

Go to the documentation of this file.

// -*- C++ -*-
//  Copyright (c) 2005-2010, 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.
 
 
// 
//
//
// @VERSION@
 
#ifndef _POLLINTERFACE_H_
#define _POLLINTERFACE_H_
 
/* For endpoint_t and possibly poll.h */
#include <isode/compat/manifest.h>
 
#include "EventSvc.h"
#include "Syncmsg.h"
 
namespace Poll {
 
    // If poll.h is available, might as well make these match the
    // values from that file.
    enum PollEventTypes {
#ifdef POLLIN
        Event_In        = POLLIN,
#else
        Event_In        = 0x01, 
#endif
 
#ifdef POLLPRI
        Event_Pri       = POLLPRI,
#else
        Event_Pri       = 0x02, 
#endif
 
#ifdef POLLOUT
        Event_Out       = POLLOUT,
#else
        Event_Out       = 0x04, 
#endif
 
#ifdef POLLERR
        Event_Err       = POLLERR,
#else
        Event_Err       = 0x08, 
#endif
 
#ifdef POLLHUP
        Event_Hup       = POLLHUP,
#else
        Event_Hup       = 0x10, 
#endif
 
#ifdef POLLNVAL
        Event_Nval      = POLLNVAL,
#else
        Event_Nval      = 0x20, 
#endif
 
        Event_Terminate = 0x20000 
    };
 
    struct pollmsg {
        unsigned    events;
 
        pollmsg (unsigned ev = 0) : events(ev) {}
    };
 
    // Forward declarations
    class Provider;
    class User;
 
    typedef SyncEvent<pollmsg, User>  UserEvent;
 
    // This needs to be an Event::Receiver so that we can deliver
    // the user events to it.
    class User : public Event::Receiver {
    public:
        UserEvent     _event;     
        endpoint_t    _fd;        
        unsigned      _pevents;   
        unsigned      _uevents;   
 
    public:
        User () : _fd(INVALID_ENDPOINT), _pevents(0), _uevents(0) {
            _event.Init (this);
        }
 
        virtual ~User () { }
 
        virtual void Deliver (pollmsg *msg) = 0;
 
        virtual void actualDeliver (pollmsg *msg) = 0;
    };
 
    struct pollAction {
        bool            terminate;
    };
 
 
    class Provider {
    private:
        static EVENTSVC_DLL Provider *instance;
 
    public:
        static Provider *GetPollService() {
            return instance;
        }
 
        virtual ~Provider () {}
 
        virtual int Register (User *user) = 0;
 
        virtual void Deregister (User *user) = 0;
 
        virtual void Control (User *user) = 0;
 
        virtual void Deliver (pollAction *msg) = 0;
 
        //
        static int ProviderFactory (const char *type,
                                    MSGstruct *msg);
    };
 
    typedef ::Event::AsyncEventAux<Provider,pollAction>  ProviderEvent;
}
 
#endif /* _POLLINTERFACE_H_ */