mxnetwork::Socket Class Reference

C++ wrapper around the MXNetwork socket API. More...

#include <MXNetwork/include/mxnetwork/socket.hpp>

Public Member Functions
std::optional< Socket >	accept ()
	Accept an incoming connection.
bool	bind (std::string_view port)
	Bind an Internet socket to a local port.
bool	bind_unix (std::string_view path)
	Bind a UNIX-domain socket to a local path.
void	close ()
	Close the socket if it is open.
bool	connect (const std::string_view host, const std::string_view port)
	Connect to a remote Internet endpoint.
bool	connect_unix (const std::string_view path)
	Connect to a UNIX-domain endpoint.
bool	is_open () const
	Return true when the socket is open.
bool	listen (std::string_view port, int backlog)
	Start listening on an Internet port.
bool	listen_unix (std::string_view path, int backlog)
	Start listening on a UNIX-domain socket path.
Socket &	operator= (const Socket &s)=delete
Socket &	operator= (Socket &&s) noexcept
	Move-assign from another socket wrapper.
ssize_t	read (void *buf, size_t bytes, int flags)
	Read bytes from the socket.
ssize_t	read_all (void *buf, size_t bytes)
	Read exactly the requested number of bytes.
bool	readline (char **buffer, size_t *len)
	Read a line of text from the socket.
ssize_t	recvfrom (void *buf, size_t bytes)
	Receive a datagram using the configured socket type.
ssize_t	recvfrom (void *buf, size_t bytes, SocketAddress &address)
ssize_t	sendto (const void *buf, size_t bytes)
	Send a datagram using the configured socket type.
ssize_t	sendto (const void *buf, size_t bytes, const SocketAddress &address)
bool	setblocking (bool block)
	Toggle blocking mode.
	Socket () noexcept
	Construct an invalid socket wrapper.
	Socket (const MXSocket &s, SocketType type) noexcept
	Copy socket state from a C API structure.
	Socket (const Socket &s)=delete
	Socket (mx_socket_fd sockfd, SocketType type)
	Adopt an existing socket handle.
	Socket (Socket &&s) noexcept
	Move-construct from another socket wrapper.
	Socket (SocketType type) noexcept
	Construct a socket wrapper for the given type.
SocketType	socket_type () const
	Return the socket family and transport type.
mx_socket_fd	sockfd () const
	Return the underlying socket handle.
bool	valid () const
	Return true when the socket handle is valid.
ssize_t	write (const void *buf, size_t bytes, int flags)
	Write bytes to the socket.
ssize_t	write_all (const void *buf, size_t bytes)
	Write exactly the requested number of bytes.
	~Socket () noexcept
	Destroy the socket wrapper and close the socket if needed.

Protected Attributes
MXSocket	sock
SocketType	type = SocketType::TYPE_INVALID

Detailed Description

C++ wrapper around the MXNetwork socket API.

Definition at line 57 of file socket.hpp.

Constructor & Destructor Documentation

Socket() [1/6]

mxnetwork::Socket::Socket ( )

noexcept

Construct an invalid socket wrapper.

Definition at line 31 of file socket.cpp.

: Socket(SocketType::TYPE_INVALID) {}

Socket() [2/6]

mxnetwork::Socket::Socket ( SocketType type )

noexcept

Construct a socket wrapper for the given type.

Parameters

type	Socket family and transport type.

Definition at line 33 of file socket.cpp.

                                            {
        type = stype;
        if (mx_socket_init(&sock))
            return;
        else
            type = SocketType::TYPE_INVALID;
        sock.sockfd = NULL_SOCKET;
    }

~Socket()

mxnetwork::Socket::~Socket ( )

noexcept

Destroy the socket wrapper and close the socket if needed.

Definition at line 42 of file socket.cpp.

                             {
        if (mx_socket_valid(&sock)) {
            close();
        }
    }

Socket() [3/6]

mxnetwork::Socket::Socket	(	mx_socket_fd	sockfd,
		SocketType	type )

Adopt an existing socket handle.

Parameters

sockfd	Socket handle to wrap.
type	Socket family and transport type.

Definition at line 48 of file socket.cpp.

                                                        {
        if (!mx_socket_init(&sock))
            throw Exception("Error on socket init.\n");
 
        sock.sockfd = sockfd;
        sock.addrlen = 0;
        sock.blocking = false;
        type = stype;
    }

Socket() [4/6]

mxnetwork::Socket::Socket ( const MXSocket & s, SocketType type )

noexcept

Copy socket state from a C API structure.

Parameters

s	Source socket state.
type	Socket family and transport type.

Definition at line 58 of file socket.cpp.

                                                               {
        type = stype;
        setsocket(s);
    }

Socket() [5/6]

mxnetwork::Socket::Socket ( const Socket & s )

delete

Socket() [6/6]

mxnetwork::Socket::Socket ( Socket && s )

noexcept

Move-construct from another socket wrapper.

Definition at line 63 of file socket.cpp.

                                      {
        type = s.type;
        setsocket(s.sock);
        s.sock.sockfd = NULL_SOCKET;
    }

Member Function Documentation

accept()

std::optional< Socket > mxnetwork::Socket::accept ( )

nodiscard

Accept an incoming connection.

Returns

Accepted socket on success.

Definition at line 120 of file socket.cpp.

                                                     {
        MXSocket newsocket;
        if (!mx_socket_init(&newsocket))
            return std::nullopt;
 
        if (mx_socket_accept(&sock, &newsocket)) {
            return Socket(newsocket, type);
        }
 
        if (!mx_socket_valid(&sock))
            return std::nullopt;
 
        if (SOCK_ERRNO == SOCK_EINTR || SOCK_ERRNO == SOCK_EAGAIN || SOCK_ERRNO == SOCK_EWOULDBLOCK || SOCK_ERRNO == SOCK_ECONNABORTED || SOCK_ERRNO == SOCK_EINVAL || SOCK_ERRNO == SOCK_EBADF || SOCK_ERRNO == SOCK_ENOTSOCK || SOCK_ERRNO == SOCK_ESHUTDOWN || SOCK_ERRNO == SOCK_ECONNRESET)
            return std::nullopt;
 
        throw Exception("Error accept socket failed.\n");
    }

bind()

bool mxnetwork::Socket::bind

(

std::string_view

port

)

Bind an Internet socket to a local port.

Parameters

port	Service or port name.

Returns

True on success.

Definition at line 138 of file socket.cpp.

                                         {
        bool bound = false;
        if (type == SocketType::TYPE_INET || type == SocketType::TYPE_INET_DGRAM)
            bound = mx_socket_bind(&sock, std::string(port).c_str());
        else if (type == SocketType::TYPE_INET6 || type == SocketType::TYPE_INET6_DGRAM)
            bound = mx_socket_ipv6_bind(&sock, std::string(port).c_str());
        else
            bound = mx_socket_bind(&sock, std::string(port).c_str());
 
        if (!bound) {
            throw Exception("Could not bind UDP socket.");
        }
        return true;
    }

bind_unix()

bool mxnetwork::Socket::bind_unix

(

std::string_view

path

)

Bind a UNIX-domain socket to a local path.

Parameters

path	Filesystem path for the socket.

Returns

True on success.

Definition at line 153 of file socket.cpp.

                                              {
        if (!mx_socket_unix_bind(&sock, std::string(path).c_str()))
            return false;
        return true;
    }

close()

void mxnetwork::Socket::close

(

)

Close the socket if it is open.

Definition at line 171 of file socket.cpp.

                       {
        if (mx_socket_valid(&sock)) {
            std::cout << "Socket: " << sock.sockfd << " closed.\n";
            mx_socket_close(&sock);
        }
        type = SocketType::TYPE_INVALID;
    }

connect()

bool mxnetwork::Socket::connect	(	const std::string_view	host,
		const std::string_view	port )

Connect to a remote Internet endpoint.

Parameters

host	Remote host name or address.
port	Remote service or port name.

Returns

True on success.

Definition at line 80 of file socket.cpp.

                                                                             {
        if (type == SocketType::TYPE_INET)
            return mx_socket_connect(&sock, std::string(host).c_str(), std::string(port).c_str(), SOCK_STREAM);
        else if (type == SocketType::TYPE_INET6)
            return mx_socket_ipv6_connect(&sock, std::string(host).c_str(), std::string(port).c_str(), SOCK_STREAM);
        else if (type == SocketType::TYPE_INET_DGRAM)
            return mx_socket_connect(&sock, std::string(host).c_str(), std::string(port).c_str(), SOCK_DGRAM);
        else if (type == SocketType::TYPE_INET6_DGRAM)
            return mx_socket_ipv6_connect(&sock, std::string(host).c_str(), std::string(port).c_str(), SOCK_DGRAM);
        return false;
    }

connect_unix()

bool mxnetwork::Socket::connect_unix

(

const std::string_view

path

)

Connect to a UNIX-domain endpoint.

Parameters

path	Filesystem path for the socket.

Returns

True on success.

Definition at line 92 of file socket.cpp.

                                                       {
        if (type == SocketType::TYPE_UNIX)
            return mx_socket_unix_connect(&sock, std::string(path).c_str(), SOCK_STREAM);
        else if (type == SocketType::TYPE_UNIX_DGRAM)
            return mx_socket_unix_connect(&sock, std::string(path).c_str(), SOCK_DGRAM);
        return false;
    }

is_open()

bool mxnetwork::Socket::is_open ( ) const

nodiscard

Return true when the socket is open.

Definition at line 167 of file socket.cpp.

                                             {
        return mx_socket_is_open(&sock);
    }

listen()

bool mxnetwork::Socket::listen	(	std::string_view	port,
		int	backlog )

Start listening on an Internet port.

Parameters

port	Service or port name.
backlog	Maximum pending connection queue length.

Returns

True on success.

Definition at line 100 of file socket.cpp.

                                                        {
        if (type == SocketType::TYPE_INET)
            return mx_socket_listen(&sock, std::string(port).c_str(), backlog, SOCK_STREAM);
        else if (type == SocketType::TYPE_INET6)
            return mx_socket_ipv6_listen(&sock, std::string(port).c_str(), backlog, SOCK_STREAM);
        else if (type == SocketType::TYPE_INET_DGRAM)
            return mx_socket_listen(&sock, std::string(port).c_str(), backlog, SOCK_DGRAM);
        else if (type == SocketType::TYPE_INET6_DGRAM)
            return mx_socket_ipv6_listen(&sock, std::string(port).c_str(), backlog, SOCK_DGRAM);
        return false;
    }

listen_unix()

bool mxnetwork::Socket::listen_unix	(	std::string_view	path,
		int	backlog )

Start listening on a UNIX-domain socket path.

Parameters

path	Filesystem path for the socket.
backlog	Maximum pending connection queue length.

Returns

True on success.

Definition at line 112 of file socket.cpp.

                                                             {
        if (type == SocketType::TYPE_UNIX)
            return mx_socket_unix_listen(&sock, std::string(path).c_str(), backlog, SOCK_STREAM);
        else if (type == SocketType::TYPE_UNIX_DGRAM)
            return mx_socket_unix_listen(&sock, std::string(path).c_str(), backlog, SOCK_DGRAM);
        return false;
    }

operator=() [1/2]

Socket & mxnetwork::Socket::operator= ( const Socket & s )

delete

operator=() [2/2]

Socket & mxnetwork::Socket::operator= ( Socket && s )

noexcept

Move-assign from another socket wrapper.

Definition at line 69 of file socket.cpp.

                                               {
        if (this != &s) {
            type = s.type;
            if (mx_socket_valid(&sock))
                ::mx_close_socket(sock.sockfd);
            setsocket(s.sock);
            s.sock.sockfd = NULL_SOCKET;
        }
        return *this;
    }

read()

ssize_t mxnetwork::Socket::read	(	void *	buf,
		size_t	bytes,
		int	flags )

Read bytes from the socket.

Parameters

buf	Output buffer.
bytes	Number of bytes to read.
flags	Platform socket flags.

Returns

Number of bytes read, or a negative error value.

Definition at line 187 of file socket.cpp.

                                                           {
        return mx_socket_read(&sock, buf, bytes, flags);
    }

read_all()

ssize_t mxnetwork::Socket::read_all	(	void *	buf,
		size_t	bytes )

Read exactly the requested number of bytes.

Parameters

buf	Output buffer.
bytes	Number of bytes to read.

Returns

Number of bytes read, or a negative error value.

Definition at line 199 of file socket.cpp.

                                                    {
        return mx_socket_read_all(&sock, buf, bytes);
    }

readline()

bool mxnetwork::Socket::readline	(	char **	buffer,
		size_t *	len )

Read a line of text from the socket.

Parameters

buffer	Output buffer pointer.
len	Output length.

Returns

True on success.

Definition at line 191 of file socket.cpp.

                                                    {
        return mx_socket_readline(&sock, buffer, len);
    }

recvfrom() [1/2]

ssize_t mxnetwork::Socket::recvfrom	(	void *	buf,
		size_t	bytes )

Receive a datagram using the configured socket type.

Parameters

buf	Output buffer.
bytes	Maximum number of bytes to receive.

Returns

Number of bytes received, or a negative error value.

Definition at line 216 of file socket.cpp.

                                                    {
        if (type == SocketType::TYPE_INET_DGRAM)
            return mx_socket_recvfrom(&sock, buf, bytes);
        else if (type == SocketType::TYPE_INET6_DGRAM)
            return mx_socket_ipv6_recvfrom(&sock, buf, bytes);
        else if (type == SocketType::TYPE_UNIX_DGRAM)
            return mx_socket_unix_recvfrom(&sock, buf, bytes);
        return 0;
    }

recvfrom() [2/2]

ssize_t mxnetwork::Socket::recvfrom	(	void *	buf,
		size_t	bytes,
		SocketAddress &	address )

Definition at line 226 of file socket.cpp.

                                                                            {
        return mx_socket_recvfrom_address(&sock, buf, bytes, &address.value);
    }

sendto() [1/2]

ssize_t mxnetwork::Socket::sendto	(	const void *	buf,
		size_t	bytes )

Send a datagram using the configured socket type.

Parameters

buf	Input buffer.
bytes	Number of bytes to send.

Returns

Number of bytes sent, or a negative error value.

Definition at line 207 of file socket.cpp.

                                                        {
        if (type == SocketType::TYPE_INET_DGRAM)
            return mx_socket_sendto(&sock, buf, bytes);
        else if (type == SocketType::TYPE_INET6_DGRAM)
            return mx_socket_ipv6_sendto(&sock, buf, bytes);
        else if (type == SocketType::TYPE_UNIX_DGRAM)
            return mx_socket_unix_sendto(&sock, buf, bytes);
        return 0;
    }

sendto() [2/2]

ssize_t mxnetwork::Socket::sendto	(	const void *	buf,
		size_t	bytes,
		const SocketAddress &	address )

Definition at line 230 of file socket.cpp.

                                                                                      {
        return mx_socket_sendto_address(&sock, buf, bytes, &address.value);
    }

setblocking()

bool mxnetwork::Socket::setblocking

(

bool

block

)

Toggle blocking mode.

Parameters

block

True to enable blocking I/O.

Returns

True on success.

Definition at line 159 of file socket.cpp.

                                       {
        return mx_socket_set_blocking(&sock, block);
    }

socket_type()

SocketType mxnetwork::Socket::socket_type ( ) const

nodiscard

Return the socket family and transport type.

Definition at line 179 of file socket.cpp.

                                                       {
        return type;
    }

sockfd()

mx_socket_fd mxnetwork::Socket::sockfd ( ) const

nodiscard

Return the underlying socket handle.

Definition at line 183 of file socket.cpp.

                                                    {
        return sock.sockfd;
    }

valid()

bool mxnetwork::Socket::valid ( ) const

nodiscard

Return true when the socket handle is valid.

Definition at line 163 of file socket.cpp.

                                           {
        return mx_socket_valid(&sock);
    }

write()

ssize_t mxnetwork::Socket::write	(	const void *	buf,
		size_t	bytes,
		int	flags )

Write bytes to the socket.

Parameters

buf	Input buffer.
bytes	Number of bytes to write.
flags	Platform socket flags.

Returns

Number of bytes written, or a negative error value.

Definition at line 195 of file socket.cpp.

                                                                  {
        return mx_socket_send(&sock, buf, bytes, flags);
    }

write_all()

ssize_t mxnetwork::Socket::write_all	(	const void *	buf,
		size_t	bytes )

Write exactly the requested number of bytes.

Parameters

buf	Input buffer.
bytes	Number of bytes to write.

Returns

Number of bytes written, or a negative error value.

Definition at line 203 of file socket.cpp.

                                                           {
        return mx_socket_write_all(&sock, buf, bytes);
    }

Member Data Documentation

sock

MXSocket mxnetwork::Socket::sock

protected

Definition at line 203 of file socket.hpp.

type

SocketType mxnetwork::Socket::type = SocketType::TYPE_INVALID

protected

Definition at line 204 of file socket.hpp.

---

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

• MXNetwork/include/mxnetwork/socket.hpp
• MXNetwork/src/socket.cpp