SocketSelector.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef CPP3DS_SOCKETSELECTOR_HPP
26 #define CPP3DS_SOCKETSELECTOR_HPP
27 
29 // Headers
31 #include <cpp3ds/System/Time.hpp>
32 
33 
34 namespace cpp3ds
35 {
36 class Socket;
37 
43 {
44 public:
45 
51 
58  SocketSelector(const SocketSelector& copy);
59 
65 
79  void add(Socket& socket);
80 
92  void remove(Socket& socket);
93 
104  void clear();
105 
122  bool wait(Time timeout = Time::Zero);
123 
141  bool isReady(Socket& socket) const;
142 
152 
153 private:
154 
155  struct SocketSelectorImpl;
156 
158  // Member data
160  SocketSelectorImpl* m_impl;
161 };
162 
163 } // namespace cpp3ds
164 
165 
166 #endif // CPP3DS_SOCKETSELECTOR_HPP
167 
168 
void add(Socket &socket)
Add a new socket to the selector.
bool wait(Time timeout=Time::Zero)
Wait until one or more sockets are ready to receive.
Base class for all the socket types.
Definition: Socket.hpp:44
void clear()
Remove all the sockets stored in the selector.
~SocketSelector()
Destructor.
Represents a time value.
Definition: Time.hpp:37
SocketSelector & operator=(const SocketSelector &right)
Overload of assignment operator.
bool isReady(Socket &socket) const
Test a socket to know if it is ready to receive data.
SocketSelector()
Default constructor.
Multiplexer that allows to read from multiple sockets.
static const Time Zero
Predefined "zero" time value.
Definition: Time.hpp:82