Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
sf::SocketHelper Class Reference

This class defines helper functions to do all the non-portable socket stuff. More...

#include <SFML/Network/Win32/SocketHelper.hpp>

Public Types

typedef SOCKET SocketType
typedef int LengthType

Static Public Member Functions

static SocketType InvalidSocket ()
 Return the value of the invalid socket.
static bool Close (SocketType Socket)
 Close / destroy a socket.
static void SetBlocking (SocketType Socket, bool Block)
 Set a socket as blocking or non-blocking.
static Socket::Status GetErrorStatus ()
 Get the last socket error status.

Detailed Description

This class defines helper functions to do all the non-portable socket stuff.

This class is meant for internal use only

Definition at line 41 of file Win32/SocketHelper.hpp.

Member Typedef Documentation

◆ LengthType

typedef int sf::SocketHelper::LengthType

Definition at line 49 of file Win32/SocketHelper.hpp.

◆ SocketType

typedef SOCKET sf::SocketHelper::SocketType

Definition at line 48 of file Win32/SocketHelper.hpp.

Member Function Documentation

◆ Close()

bool sf::SocketHelper::Close ( SocketType Socket)
static

Close / destroy a socket.

Parameters
Socket: Socket to close
Returns
True on success

◆ GetErrorStatus()

Socket::Status sf::SocketHelper::GetErrorStatus ( )
static

Get the last socket error status.

Returns
Status corresponding to the last socket error

◆ InvalidSocket()

SocketType sf::SocketHelper::InvalidSocket ( )
static

Return the value of the invalid socket.

Returns
Unique value of the invalid socket

◆ SetBlocking()

void sf::SocketHelper::SetBlocking ( SocketType Socket,
bool Block )
static

Set a socket as blocking or non-blocking.

Parameters
Socket: Socket to modify
Block: New blocking state of the socket
The documentation for this class was generated from the following file: