documentation/3.0.0/SocketSelector_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)

//

// This software is provided 'as-is', without any express or implied warranty.

// In no event will the authors be held liable for any damages arising from the use of this software.

//

// Permission is granted to anyone to use this software for any purpose,

// including commercial applications, and to alter it and redistribute it freely,

// subject to the following restrictions:

//

// 1. The origin of this software must not be misrepresented;

//    you must not claim that you wrote the original software.

//    If you use this software in a product, an acknowledgment

//    in the product documentation would be appreciated but is not required.

//

// 2. Altered source versions must be plainly marked as such,

//    and must not be misrepresented as being the original software.

//

// 3. This notice may not be removed or altered from any source distribution.

//


#pragma once


// Headers

#include <SFML/Network/Export.hpp>


#include <SFML/System/Time.hpp>


#include <memory>


namespace sf

{

class Socket;


class SFML_NETWORK_API SocketSelector

{

public:

    SocketSelector();


    ~SocketSelector();


    SocketSelector(const SocketSelector& copy);


    SocketSelector& operator=(const SocketSelector& right);


    SocketSelector(SocketSelector&&) noexcept;


    SocketSelector& operator=(SocketSelector&&) noexcept;


    void add(Socket& socket);


    void remove(Socket& socket);


    void clear();


    [[nodiscard]] bool wait(Time timeout = Time::Zero);


    [[nodiscard]] bool isReady(Socket& socket) const;


private:

    struct SocketSelectorImpl;


    // Member data

    std::unique_ptr<SocketSelectorImpl> m_impl;

};


} // namespace sf


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