SFML 2.5.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

SocketSelector.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2018 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 SFML_SOCKETSELECTOR_HPP
26#define SFML_SOCKETSELECTOR_HPP
27
29// Headers
31#include <SFML/Network/Export.hpp>
32#include <SFML/System/Time.hpp>
33
34
35 namespace sf
36{
37 class Socket;
38
43 class SFML_NETWORK_API SocketSelector
44{
45 public:
46
51 SocketSelector();
52
59 SocketSelector(const SocketSelector& copy);
60
65 ~SocketSelector();
66
80 void add(Socket& socket);
81
93 void remove(Socket& socket);
94
105 void clear();
106
123 bool wait(Time timeout = Time::Zero);
124
142 bool isReady(Socket& socket) const;
143
152 SocketSelector& operator =(const SocketSelector& right);
153
154 private:
155
156 struct SocketSelectorImpl;
157
159 // Member data
161 SocketSelectorImpl* m_impl;
162};
163
164} // namespace sf
165
166
167#endif // SFML_SOCKETSELECTOR_HPP
168
169
sf::SocketSelector
Multiplexer that allows to read from multiple sockets.
Definition: SocketSelector.hpp:44
sf::SocketSelector::SocketSelector
SocketSelector(const SocketSelector &copy)
Copy constructor.
sf::SocketSelector::SocketSelector
SocketSelector()
Default constructor.
sf::SocketSelector::clear
void clear()
Remove all the sockets stored in the selector.
sf::SocketSelector::~SocketSelector
~SocketSelector()
Destructor.
sf::SocketSelector::isReady
bool isReady(Socket &socket) const
Test a socket to know if it is ready to receive data.
sf::SocketSelector::remove
void remove(Socket &socket)
Remove a socket from the selector.
sf::SocketSelector::wait
bool wait(Time timeout=Time::Zero)
Wait until one or more sockets are ready to receive.
sf::SocketSelector::add
void add(Socket &socket)
Add a new socket to the selector.
sf::Socket
Base class for all the socket types.
Definition: Socket.hpp:46
sf::Time
Represents a time value.
Definition: Time.hpp:41
sf::Time::Zero
static const Time Zero
Predefined "zero" time value.
Definition: Time.hpp:85