Socket.hpp

Go to the documentation of this file.

//
// 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/Network/SocketHandle.hpp>
 
 
namespace sf
{
class SFML_NETWORK_API Socket
{
public:
    enum class Status
    {
        Done,         
        NotReady,     
        Partial,      
        Disconnected, 
        Error         
    };

    // NOLINTNEXTLINE(readability-identifier-naming)
    static constexpr unsigned short AnyPort{0}; 

    virtual ~Socket();

    Socket(const Socket&) = delete;

    Socket& operator=(const Socket&) = delete;

    Socket(Socket&& socket) noexcept;

    Socket& operator=(Socket&& socket) noexcept;

    void setBlocking(bool blocking);

    [[nodiscard]] bool isBlocking() const;
 
protected:
    enum class Type
    {
        Tcp, 
        Udp  
    };

    Socket(Type type);

    [[nodiscard]] SocketHandle getNativeHandle() const;

    void create();

    void create(SocketHandle handle);

    void close();
 
private:
    friend class SocketSelector;

    // Member data
    Type         m_type;             
    SocketHandle m_socket;           
    bool         m_isBlocking{true}; 
};
 
} // namespace sf