Poll.hxx

Go to the documentation of this file.

#if !defined(RESIP_POLL_HXX)
#define RESIP_POLL_HXX

// One of the following macros must be defined:
//#define RESIP_POLL_IMPL_POLL
#define RESIP_POLL_IMPL_SELECT
//#define RESIP_POLL_IMPL_EPOLL  // Not yet implemented.

/*
  Define this macro to support applications that must call system call "poll"
  or its ilk themselves rather than calling method "Poll::wait".
*/
#define RESIP_POLL_EXTERN

#include <vector>

#ifdef RESIP_POLL_IMPL_POLL
#  include <sys/poll.h>
#endif

#ifdef RESIP_POLL_IMPL_SELECT
# ifdef WIN32
#  include <winsock2.h>
# else
#  include <sys/time.h>
#  include <sys/types.h>
#  include <unistd.h>
# endif // WIN32
#endif // RESIP_POLL_IMPL_SELECT

#ifdef RESIP_POLL_EXTERN
# include <map>
#endif // RESI

namespace resip {


class Poll {

   public:

      class FDEntry {

            friend class Poll;

         public:

            typedef unsigned short StateBitMask; // FDStateBitMask | ResipStateBitMask.
            enum FDStateBitMaskEnum {
               fdsbmReadable       = 0x0001, // (POLLIN)
               fdsbmWritable       = 0x0004, // (POLLOUT)
               fdsbmError          = 0x0008, // (POLLERR)
               fdsbmAll            = Poll::FDEntry::fdsbmReadable |
               Poll::FDEntry::fdsbmWritable |
               Poll::FDEntry::fdsbmError
            };
            typedef StateBitMask FDStateBitMask;
            enum ResipStateBitMaskEnum {
               rsbmIsTransport    = 0x0040,
               rsbmIsWritePending = 0x0080
            };
            typedef StateBitMask ResipStateBitMask;

         private:

            static
            int
            compare(const Poll::FDEntry * leftFDEntry,
                    const Poll::FDEntry * rightFDEntry);

            // Fields:
            Poll *                       _poll;
            int/*FD*/                    _fd;
            Poll::FDEntry::StateBitMask  _stateBitMask;
            unsigned short               _index; // Within "_poll->_fdEntryVector".

         public:

            //constructor
            FDEntry(Poll *     poll,
                    bool       isTransport,
                    int/*FD*/  fd);

            //destructor
            virtual ~FDEntry();

            inline
            int//FD
            getFD() const
            {
               return _fd;
            }

            inline
            Poll::FDEntry::StateBitMask
            getStateBitMask() const
            {
               return _stateBitMask;
            }

            void
            clearFDState();
            
         protected:

            void
            setIsWritePending(bool isWritePending);
            
            virtual void doRead() {};
            virtual void doWrite() {};
            virtual void doError() {};
            
         private:

            // Copy constructor: declared but not defined
            FDEntry(const Poll::FDEntry &  from);

            // Assignment: declared but not defined
            Poll::FDEntry &
            operator=(const Poll::FDEntry &  from);

      };
      friend class Poll::FDEntry;

   private:

      // Fields:
      std::vector<Poll::FDEntry *>          _fdEntryVector;
#ifdef RESIP_POLL_IMPL_POLL
      std::vector<pollfd>                   _pollFDVector;
#endif
#ifdef RESIP_POLL_IMPL_SELECT
      int/*FD*/                        _maxFDPlus1;
      fd_set                           _readFDSet;
      fd_set                           _writeFDSet;
#endif
#ifdef RESIP_POLL_EXTERN
      std::map<int/*FD*/, Poll::FDEntry *>  _fdEntryMap;
#endif
      std::vector<Poll::FDEntry *>          _waitResult;

   public:

      /*
        "waitResult" is the result of method "wait" or "afterExternWait".
        Returns the index of the entry with the smallest file descriptor >= "fd" in
        "waitResult", or "waitResult.size()" if none exists.
      */
      static
      int
      findFDInWaitResult(int/*FD*/                        fd,
                         const std::vector<Poll::FDEntry *> &  waitResult);

      //constructor
      Poll();

      //destructor
      ~Poll();

#ifdef RESIP_POLL_EXTERN  // {

      // The result is the set of entries in this poll object.
      const std::vector<Poll::FDEntry *> &
      beforeExternWait();

      /*
        If "fd" has no entry in this poll object, ignore it and return false.
        Otherwise, set the entry's FD state from "fdStateBitMask" and return true.
        If the same "fd" is passed in multiple times, the "fdStateBitMask" are
        or-ed together.
      */
      bool
      setEntryFDStateForExternWait(int/*FD*/                    fd,
                                   Poll::FDEntry::StateBitMask  fdStateBitMask);

      // The result is identical to that of method "wait".
      const std::vector<Poll::FDEntry *> &
      afterExternWait();

#else //!defined(RESIP_POLL_EXTERN)  } {

      /*
        Wait for I/O on any of this poll object's entry's file descriptors.
        More precisely, wait for the file descriptor of any entry with a pending
        write to be writable or for any entry's file descriptor to have readable
        input or an error.
        If "timeoutMilliSeconds" is negative, it means wait indefinitely, otherwise
        it indicates the maximum period to wait.
        The result is an array of the entries for the file descriptors that are
        readable, writable, or error, as specified by each entry's FD state.
        The result contains no duplicates and is sorted by file descriptor.
        (To service file descriptors with round-robin prioritization, remember the
        last file descriptor serviced and use method "Poll::findFDInWaitResult" to
        find the index in the result array of the highest priority entry.)
        The result is valid until the next call to this method, method
        "beforeExternWait", or the destructor.
        At some point before then, for each entry in the result, method
        "Poll::FDEntry::clearFDState" must be called.
      */
      const std::vector<Poll::FDEntry *> &
      wait(int timeoutMilliSeconds);

#endif //!defined(RESIP_POLL_EXTERN)  }

   private:

      // Copy constructor: declared but not defined
      Poll(const Poll &  from);

      // Assignment: declared but not defined
      Poll &
      operator=(const Poll &  from);

};


} // namespace resip

#endif //!defined(RESIP_POLL_HXX)

/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2000-2005 Jacob Butcher
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 * 
 */