SFML - Simple and Fast Multimedia Library

SFML 3.0.1

- Main Page
- Topics
- Namespaces
- Classes
- Files

- File List
- File Members

Loading...
Searching...
No Matches
SocketSelector.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2025 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#pragma once
26
28// Headers
30#include <SFML/Network/Export.hpp>
31
32#include <SFML/System/Time.hpp>
33
34#include <memory>
35
36
37namespace sf
38{
39class Socket;
40
45 class SFML_NETWORK_API SocketSelector
46{
47public:
52 SocketSelector();
53
58 ~SocketSelector();
59
66 SocketSelector(const SocketSelector& copy);
67
76 SocketSelector& operator=(const SocketSelector& right);
77
82 SocketSelector(SocketSelector&&) noexcept;
83
88 SocketSelector& operator=(SocketSelector&&) noexcept;
89
103 void add(Socket& socket);
104
116 void remove(Socket& socket);
117
128 void clear();
129
146 [[nodiscard]] bool wait(Time timeout = Time::Zero);
147
165 [[nodiscard]] bool isReady(Socket& socket) const;
166
167private:
168 struct SocketSelectorImpl;
169
171 // Member data
173 std::unique_ptr<SocketSelectorImpl> m_impl;
174};
175
176} // namespace sf
177
178
Export.hpp
SFML_NETWORK_API
#define SFML_NETWORK_API
Definition Network/Export.hpp:42
Time.hpp
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(SocketSelector &&) noexcept
Move constructor.
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::SocketSelector::operator=
SocketSelector & operator=(const SocketSelector &right)
Overload of assignment operator.
sf::Socket
Base class for all the socket types.
Definition Socket.hpp:42
sf::Time
Represents a time value.
Definition Time.hpp:42
sf
Definition AudioResource.hpp:36
sf::StencilUpdateOperation::Zero
@ Zero
If the stencil test passes, the value in the stencil buffer is set to zero.
Definition StencilMode.hpp:63