wze::udp_socket Class Reference

UDP socket. More...

#include <udp_socket.hpp>

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

Detailed Description

UDP 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 udp_socket.hpp.

Constructor & Destructor Documentation

udp_socket()

wze::udp_socket::udp_socket ( wze::ipv4 const & ipv4 )

inlineexplicit

Explicit constructor.

Parameters

ipv4	IPv4 address of the server.

Exceptions

wze::exception

<socket_error> udp_socket cannot be opened.

See also

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

Definition at line 55 of file udp_socket.hpp.

        : _incoming{-1, nullptr, 0, 0, 0, {INADDR_NONE, 0}},
          _outgoing{-1, nullptr, 0, 0, 0, {ipv4}} {
        if (this->ipv4().host == INADDR_ANY ||
            this->ipv4().host == INADDR_NONE) {
            throw exception<socket_error>{{"Invalid IPv4 address"}};
        }
        _socket = {SDLNet_UDP_Open(0), SDLNet_UDP_Close};
        if (!_socket) {
            throw exception<socket_error>{{SDLNet_GetError()}};
        }
    }

Member Function Documentation

ipv4()

wze::ipv4 const & wze::udp_socket::ipv4 ( ) const

inlinenodiscard

Gets the wze::ipv4 address of the server.

Returns

wze::ipv4 address of the server.

Definition at line 72 of file udp_socket.hpp.

                                              {
        return _outgoing.address;
    }

receive()

template<typename packet >

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

inlinenodiscard

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

<socket_error> Data cannot be received properly.

See also

send(outgoing const& buffer)

Definition at line 86 of file udp_socket.hpp.

                                                                             {
        static_assert(sizeof(buffer) <= std::numeric_limits<int32_t>::max());
        _incoming.data = static_cast<uint8_t*>(&buffer);
        _incoming.len = 0;
        _incoming.maxlen = sizeof(buffer);
        switch (SDLNet_UDP_Recv(_socket.get(), &_incoming)) {
        case 1:
            if (_incoming.address.host == ipv4().host &&
                _incoming.address.port == ipv4().port) {
                return _incoming.len;
            }
        case 0:
            return 0;
        default:
            throw exception<socket_error>{{SDLNet_GetError()}};
        }
    }

send()

template<typename packet >

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

inline

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 110 of file udp_socket.hpp.

                                                               {
        static_assert(sizeof(buffer) <= std::numeric_limits<int32_t>::max());
        _outgoing.data = static_cast<uint8_t*>(&buffer);
        _outgoing.len = sizeof(buffer);
        _outgoing.maxlen = sizeof(buffer);
        if (!static_cast<bool>(
                SDLNet_UDP_Send(_socket.get(), -1, &_outgoing))) {
            throw exception<socket_error>{{SDLNet_GetError()}};
        }
    }

---

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

• include/wizard_engine/udp_socket.hpp