wze::tcp_socket Class Reference

TCP socket. More...

#include <tcp_socket.hpp>

Public Member Functions
	tcp_socket (wze::ipv4 ipv4)
	Explicit constructor.
wze::ipv4	ipv4 () const
	Gets the wze::ipv4 address of the server.
template<typename packet >
void	send (packet const &buffer)
	Receives data from the server.
template<typename packet >
int32_t	receive (packet &buffer)
	Sends data to the server.

Detailed Description

TCP socket.

Template Parameters

incoming	Type of the incoming data.
outgoing	Type of the outgoing data.

See also

net

udp_socket

tcp_socket

Definition at line 47 of file tcp_socket.hpp.

Constructor & Destructor Documentation

tcp_socket()

wze::tcp_socket::tcp_socket ( wze::ipv4 ipv4 )

inlineexplicit

Explicit constructor.

Parameters

ipv4	IPv4 address of the server.

Exceptions

wze::exception

tcp_socket cannot be opened.

See also

net::resolve(std::string const& hostname, uint16_t port = 0)

Definition at line 55 of file tcp_socket.hpp.

                                      {
        if (ipv4.host == INADDR_ANY || ipv4.host == INADDR_NONE) {
            throw exception<socket_error>{{"Invalid IPv4 address"}};
        }
        _socket_set = {SDLNet_AllocSocketSet(1), SDLNet_FreeSocketSet};
        if (!_socket_set) {
            throw exception<socket_error>{{SDLNet_GetError()}};
        }
        _socket = {SDLNet_TCP_Open(&ipv4), SDLNet_TCP_Close};
        if (!_socket) {
            throw exception<socket_error>{{SDLNet_GetError()}};
        }
        if (SDLNet_TCP_AddSocket(_socket_set.get(), _socket.get()) != 1) {
            throw exception<socket_error>{{SDLNet_GetError()}};
        }
    }

Member Function Documentation

ipv4()

wze::ipv4 wze::tcp_socket::ipv4 ( ) const

inlinenodiscard

Gets the wze::ipv4 address of the server.

Returns

wze::ipv4 address of the server.

Definition at line 76 of file tcp_socket.hpp.

                                       {
        return *SDLNet_TCP_GetPeerAddress(_socket.get());
    }

send()

template<typename packet >

void wze::tcp_socket::send ( packet const & buffer )

inline

Receives data from the server.

Parameters

buffer

Data buffer.

Returns

Integrity of the received data.

Return values

true	Received appropriate data.
false	Received invalid data.

Exceptions

wze::exception

Data cannot be received properly.

See also

send(outgoing const& buffer)

Definition at line 89 of file tcp_socket.hpp.

                                                               {
        static_assert(sizeof(buffer) <= std::numeric_limits<int32_t>::max());
        if (SDLNet_TCP_Send(_socket.get(), &buffer, sizeof(buffer)) !=
            sizeof(buffer)) {
            throw exception<socket_error>{{SDLNet_GetError()}};
        }
    }

receive()

template<typename packet >

int32_t wze::tcp_socket::receive ( packet & buffer )

inlinenodiscard

Sends data to the server.

Parameters

buffer

Data buffer.

Exceptions

wze::exception

Data cannot be sent properly.

See also

receive(incoming& buffer)

Definition at line 103 of file tcp_socket.hpp.

                                                                             {
        static_assert(sizeof(buffer) <= std::numeric_limits<int32_t>::max());
        if (!static_cast<bool>(SDLNet_CheckSockets(_socket_set.get(), 0)) ||
            // NOLINTNEXTLINE(cppcoreguidelines-pro-type-cstyle-cast)
            !static_cast<bool>(SDLNet_SocketReady(_socket.get()))) {
            return 0;
        }
        int32_t size{SDLNet_TCP_Recv(_socket.get(), &buffer, sizeof(buffer))};
        if (size <= 0) {
            throw exception<socket_error>{{SDLNet_GetError()}};
        }
        return size;
    }

---

The documentation for this class was generated from the following file:

• include/wizard_engine/tcp_socket.hpp