src/base/socket.hh

   1 /*
   2  * Copyright (c) 2002-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef __SOCKET_HH__
  30 #define __SOCKET_HH__
  31
  32 class ListenSocket
  33 {
  34   protected:
  35     /**
  36      * The following variables are only used by socket unit tests:
  37      * listeningDisabled, anyListening, bindToLoopback.
  38      */
  39     static bool listeningDisabled;
  40     static bool anyListening;
  41
  42     static bool bindToLoopback;
  43
  44   public:
  45     static void disableAll();
  46     static bool allDisabled();
  47
  48     static void loopbackOnly();
  49
  50   protected:
  51     bool listening;
  52     int fd;
  53
  54     /*
  55      * cleanup resets the static variables back to their default values.
  56      */
  57     static void cleanup();
  58
  59
  60   public:
  61     /**
  62      * @ingroup api_socket
  63      * @{
  64      */
  65     ListenSocket();
  66     virtual ~ListenSocket();
  67
  68     virtual int accept(bool nodelay = false);
  69
  70     virtual bool listen(int port, bool reuse = true);
  71
  72     int getfd() const { return fd; }
  73     bool islistening() const { return listening; }
  74     /** @} */ // end of api_socket
  75 };
  76
  77 #endif //__SOCKET_HH__