git.sesse.net Git - casparcg/blob - SFML-1.6/include/SFML/Network/SelectorBase.hpp

   1 ////////////////////////////////////////////////////////////\r
   2 //\r
   3 // SFML - Simple and Fast Multimedia Library\r
   4 // Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)\r
   5 //\r
   6 // This software is provided 'as-is', without any express or implied warranty.\r
   7 // In no event will the authors be held liable for any damages arising from the use of this software.\r
   8 //\r
   9 // Permission is granted to anyone to use this software for any purpose,\r
  10 // including commercial applications, and to alter it and redistribute it freely,\r
  11 // subject to the following restrictions:\r
  12 //\r
  13 // 1. The origin of this software must not be misrepresented;\r
  14 //    you must not claim that you wrote the original software.\r
  15 //    If you use this software in a product, an acknowledgment\r
  16 //    in the product documentation would be appreciated but is not required.\r
  17 //\r
  18 // 2. Altered source versions must be plainly marked as such,\r
  19 //    and must not be misrepresented as being the original software.\r
  20 //\r
  21 // 3. This notice may not be removed or altered from any source distribution.\r
  22 //\r
  23 ////////////////////////////////////////////////////////////\r
  24 \r
  25 #ifndef SFML_SELECTORBASE_HPP\r
  26 #define SFML_SELECTORBASE_HPP\r
  27 \r
  28 ////////////////////////////////////////////////////////////\r
  29 // Headers\r
  30 ////////////////////////////////////////////////////////////\r
  31 #include <SFML/Config.hpp>\r
  32 #include <SFML/Network/SocketHelper.hpp>\r
  33 #include <map>\r
  34 \r
  35 \r
  36 namespace sf\r
  37 {\r
  38 ////////////////////////////////////////////////////////////\r
  39 /// Private base class for selectors.\r
  40 /// As Selector is a template class, this base is needed so that\r
  41 /// every system call get compiled in SFML (not inlined)\r
  42 ////////////////////////////////////////////////////////////\r
  43 class SFML_API SelectorBase\r
  44 {\r
  45 public :\r
  46 \r
  47     ////////////////////////////////////////////////////////////\r
  48     /// Default constructor\r
  49     ///\r
  50     ////////////////////////////////////////////////////////////\r
  51     SelectorBase();\r
  52 \r
  53     ////////////////////////////////////////////////////////////\r
  54     /// Add a socket to watch\r
  55     ///\r
  56     /// \param Socket : Socket to add\r
  57     ///\r
  58     ////////////////////////////////////////////////////////////\r
  59     void Add(SocketHelper::SocketType Socket);\r
  60 \r
  61     ////////////////////////////////////////////////////////////\r
  62     /// Remove a socket\r
  63     ///\r
  64     /// \param Socket : Socket to remove\r
  65     ///\r
  66     ////////////////////////////////////////////////////////////\r
  67     void Remove(SocketHelper::SocketType Socket);\r
  68 \r
  69     ////////////////////////////////////////////////////////////\r
  70     /// Remove all sockets\r
  71     ///\r
  72     ////////////////////////////////////////////////////////////\r
  73     void Clear();\r
  74 \r
  75     ////////////////////////////////////////////////////////////\r
  76     /// Wait and collect sockets which are ready for reading.\r
  77     /// This functions will return either when at least one socket\r
  78     /// is ready, or when the given time is out\r
  79     ///\r
  80     /// \param Timeout : Timeout, in seconds (0 by default : no timeout)\r
  81     ///\r
  82     /// \return Number of sockets ready to be read\r
  83     ///\r
  84     ////////////////////////////////////////////////////////////\r
  85     unsigned int Wait(float Timeout = 0.f);\r
  86 \r
  87     ////////////////////////////////////////////////////////////\r
  88     /// After a call to Wait(), get the Index-th socket which is\r
  89     /// ready for reading. The total number of sockets ready\r
  90     /// is the integer returned by the previous call to Wait()\r
  91     ///\r
  92     /// \param Index : Index of the socket to get\r
  93     ///\r
  94     /// \return The Index-th socket\r
  95     ///\r
  96     ////////////////////////////////////////////////////////////\r
  97     SocketHelper::SocketType GetSocketReady(unsigned int Index);\r
  98 \r
  99 private :\r
 100 \r
 101     ////////////////////////////////////////////////////////////\r
 102     // Member data\r
 103     ////////////////////////////////////////////////////////////\r
 104     fd_set mySet;       ///< Set of socket to watch\r
 105     fd_set mySetReady;  ///< Set of socket which are ready for reading\r
 106     int    myMaxSocket; ///< Maximum socket index\r
 107 };\r
 108 \r
 109 } // namespace sf\r
 110 \r
 111 \r
 112 #endif // SFML_SELECTORBASE_HPP\r