SocketMux.h

/*
** libutil++
** $Id: SocketMux.h 1653 2016-02-28 19:54:59Z sella $
** Copyright (c) 2011-2016 Digital Genesis, LLC. All Rights Reserved.
** Released under the LGPL Version 2.1 License.
** http://www.digitalgenesis.com
*/

#ifndef __libutilxx__sella__net__SocketMux_H__
#define __libutilxx__sella__net__SocketMux_H__

#include "../../common.h"
#include "Socket.h"
#include "SocketException.h"

#include <sys/select.h>
#include <sys/epoll.h>

#include <map>
#include <forward_list>

/* NOTE: Current implementation limited to FD_SETSIZE(1024) for select and epoll. */

/* NOTE: EPOLL_MAXEVENTS_DEF
        Max events that will be returned per epoll_wait() call.
        This does not limit the total number of sockets epoll will monitor.
*/
#define EPOLL_MAXEVENTS_DEF 128

namespace sella {
        namespace net {
                class SocketMux;
        }
}

/* NOTE: When using epoll(), it is recommended to set socket->setBlock(false) to
   handle false positives. This may also happen with select().
*/

class sella::net::SocketMux {
        public:
                typedef std::shared_ptr<SocketMux> shared;
                typedef SocketMux *ptr;
                typedef std::map<int, Socket::shared> int_shared_map;
                typedef std::forward_list<Socket::shared> shared_flist;

        public:
                SocketMux(ssize_t epollMaxEvents = EPOLL_MAXEVENTS_DEF, bool pthread_cancel = true) throw (SocketException);
                virtual ~SocketMux();

                int epoll(struct timeval *tv = NULL) throw (SocketException);
                int epoll(uint64_t usec) throw (SocketException);

                int select(struct timeval *tv = NULL) throw (SocketException);
                int select(uint64_t usec) throw (SocketException);
                int rselect(struct timeval *tv = NULL) throw (SocketException);
                int rselect(uint64_t usec) throw (SocketException);
                int wselect(struct timeval *tv = NULL) throw (SocketException);
                int wselect(uint64_t usec) throw (SocketException);
                int eselect(struct timeval *tv = NULL) throw (SocketException);
                int eselect(uint64_t usec) throw (SocketException);
                int rwselect(struct timeval *tv = NULL) throw (SocketException);
                int rwselect(uint64_t usec) throw (SocketException);

                void clear(void) throw (SocketException);
                size_t size(void) const;

                const shared_flist& getReadList(void);
                const shared_flist& getWriteList(void);
                const shared_flist& getExceptList(void);

                bool insertRead(Socket::shared socket) throw (SocketException);
                bool removeRead(Socket::shared socket) throw (SocketException);

                bool insertWrite(Socket::shared socket) throw (SocketException);
                bool removeWrite(Socket::shared socket) throw (SocketException);

                bool insertExcept(Socket::shared socket) throw (SocketException);
                bool removeExcept(Socket::shared socket) throw (SocketException);

                static const SocketMux::shared shared_ptr(ssize_t epollMaxEvents = EPOLL_MAXEVENTS_DEF, bool pthread_cancel = true) throw (SocketException);

        protected:

        private:
                bool insert(Socket::shared socket, fd_set *set, int_shared_map *map, uint32_t events) throw (SocketException);
                bool remove(Socket::shared socket, fd_set *set, int_shared_map *map, uint32_t events) throw (SocketException);

                void clearLists(void);

                int e;
                int fdmax;
                bool cancel;

                fd_set rfdset;
                fd_set wfdset;
                fd_set efdset;

                int_shared_map rMap;
                int_shared_map wMap;
                int_shared_map eMap;

                shared_flist rList;
                shared_flist wList;
                shared_flist eList;

                ssize_t epollMaxEvents;
                struct epoll_event *events;
};

#endif

/*
** vim: noet ts=3 sw=3
*/