Implementation of TCP listener sockets based on IPv4 and IPv6. More...

#include <TCPListenSocket.hxx>

Inheritance diagram for cosmos::TCPListenSocketT< family >:

Public Types
using	IPAddress = typename FamilyTraits<FAMILY>::Address

using	Connection = TCPConnectionT<FAMILY>

Public Types inherited from cosmos::Socket
enum class	Direction : int { READ = SHUT_RD , WRITE = SHUT_WR , READ_WRITE = SHUT_RDWR }
	Type used in Socket::shutdown(). More...

using	AddressFilledIn = NamedBool<struct addr_filled_in_t, false>
	Boolean flag used in receiveFrom() to signify if a peer address could be provided.

Public Types inherited from cosmos::StreamIO
enum class	SeekType : int { SET = SEEK_SET , CUR = SEEK_CUR , END = SEEK_END , DATA = SEEK_DATA , HOLE = SEEK_HOLE }
	Different methods for changing the file read/write position. More...

Public Member Functions
	TCPListenSocketT (const SocketFlags flags=SocketFlags{SocketFlag::CLOEXEC})

auto	ipOptions ()

auto	ipOptions () const

auto	tcpOptions ()

auto	tcpOptions () const

void	getSockName (IPAddress &addr)
	Returns the current address that the socket is bound to, if any.

void	bind (const IPAddress &addr)

TCPConnectionT< FAMILY >	accept (IPAddress *addr=nullptr)

void	listen (const size_t backlog)
	Enter into a passive listen state, allowing new connections.

Public Member Functions inherited from cosmos::ListenSocket
void	listen (const size_t backlog)
	Enter into a passive listen state, allowing new connections.

Public Member Functions inherited from cosmos::Socket
auto	sockOptions ()

auto	sockOptions () const

void	getSockName (SocketAddress &addr)
	Returns the current address that the socket is bound to, if any.

void	shutdown (const Direction dir)
	Shutdown part or all of the connection on protocol level.

Public Member Functions inherited from cosmos::FDFile
	FDFile (const FileDescriptor fd, const AutoCloseFD auto_close)
	Wrap the given file descriptor applying the specified auto-close behaviour.

	FDFile (FDFile &&other) noexcept

FDFile &	operator= (FDFile &&other) noexcept

void	open (const FileDescriptor fd, const AutoCloseFD auto_close)
	Takes the already open file descriptor fd and operates on it.

void	close () override
	Close the current file object.

Public Member Functions inherited from cosmos::FileBase
	FileBase (const FileBase &)=delete

FileBase &	operator= (const FileBase &)=delete

bool	isOpen () const
	Returns whether currently a FileDescriptor is opened.

FileDescriptor	fd () const
	Allows access to the underlying fd with const semantics.

void	truncate (const off_t length)

Public Member Functions inherited from cosmos::StreamIO
	StreamIO (FileDescriptor &fd)

	StreamIO (const StreamIO &)=delete

StreamIO &	operator= (const StreamIO &)=delete

StreamIO &	operator= (StreamIO &&) noexcept

size_t	read (void *buf, size_t length)
	Read up to `length` bytes from the file into `buf`.

size_t	write (const void *buf, size_t length)
	Write up to `length` bytes from `buf` into the underlying file.

size_t	write (const std::string_view data)
	string_view wrapper around write(const void*, size_t).

void	readAll (void *buf, size_t length)
	Read all `length` bytes from the underlying file.

void	readAll (std::string &s, size_t length)
	Like readAll(void*, size_t) using an STL string.

void	writeAll (const void *buf, size_t length)
	Write all `length` bytes into the underlying file.

void	writeAll (const std::string_view data)
	string_view wrapper around writeAll(const void*, size_t).

bool	read (ReadIOVector &iovec)
	Read data from file into a vector of data regions.

bool	write (WriteIOVector &iovec)
	Write data to file from a vector of data regions.

void	readAll (ReadIOVector &iovec)
	Read into all data regions specified in `iovec`.

void	writeAll (WriteIOVector &iovec)
	Write all data regions specified in `iovec`.

off_t	seek (const SeekType type, off_t off)
	Seek to the given offset based on the given offset `type`.

off_t	seekFromStart (off_t off)
	Seek to the given offset relative to the start of the file.

off_t	seekFromCurrent (off_t off)
	Seek to the given offset relative to the current file position.

off_t	seekFromEnd (off_t off)
	Seek to the given offset relative to the end of the file.

Static Public Attributes
static constexpr auto	TYPE = SocketType::STREAM

Additional Inherited Members
Protected Member Functions inherited from cosmos::ListenSocket
	Socket (const SocketFamily family, const SocketType type, const SocketFlags flags=SocketFlags{SocketFlag::CLOEXEC}, const SocketProtocol protocol=SocketProtocol::DEFAULT)
	Creates a new socket using the given properties.

	Socket (FileDescriptor fd, const AutoCloseFD auto_close)
	Creates a new socket from the given existing file descriptor.

size_t	read (void *buf, size_t length)
	Read up to `length` bytes from the file into `buf`.

bool	read (ReadIOVector &iovec)
	Read data from file into a vector of data regions.

void	readAll (void *buf, size_t length)
	Read all `length` bytes from the underlying file.

void	readAll (std::string &s, size_t length)
	Like readAll(void*, size_t) using an STL string.

void	readAll (ReadIOVector &iovec)
	Read into all data regions specified in `iovec`.

size_t	write (const void *buf, size_t length)
	Write up to `length` bytes from `buf` into the underlying file.

size_t	write (const std::string_view data)
	string_view wrapper around write(const void*, size_t).

bool	write (WriteIOVector &iovec)
	Write data to file from a vector of data regions.

void	writeAll (const void *buf, size_t length)
	Write all `length` bytes into the underlying file.

void	writeAll (const std::string_view data)
	string_view wrapper around writeAll(const void*, size_t).

void	writeAll (WriteIOVector &iovec)
	Write all data regions specified in `iovec`.

Protected Member Functions inherited from cosmos::Socket
	Socket (const SocketFamily family, const SocketType type, const SocketFlags flags=SocketFlags{SocketFlag::CLOEXEC}, const SocketProtocol protocol=SocketProtocol::DEFAULT)
	Creates a new socket using the given properties.

	Socket (FileDescriptor fd, const AutoCloseFD auto_close)
	Creates a new socket from the given existing file descriptor.

void	bind (const SocketAddress &addr)
	Bind the socket to the given local address.

void	connect (const SocketAddress &addr)
	Establish a new connection using the given destination address.

void	listen (const size_t backlog)
	Enter into a passive listen state, allowing new connections.

FileDescriptor	accept (SocketAddress *addr)
	Accept a new connection on the socket.

size_t	send (const void *buf, size_t length, const MessageFlags flags=MessageFlags{})
	Send the given data over the socket, using specific send flags.

size_t	send (const std::string_view data, const MessageFlags flags=MessageFlags{})
	Variant of send() that takes a std::string_view container instead of a raw input buffer.

size_t	sendTo (const void *buf, size_t length, const SocketAddress &addr, const MessageFlags flags=MessageFlags{})
	Send a packet to a specific destination address.

size_t	sendTo (const std::string_view data, const SocketAddress &addr, const MessageFlags flags=MessageFlags{})
	Variant of sendTo() that takes a std::string_view container instead of a raw input buffer.

void	sendMessage (SendMessageHeader &header, const SocketAddress *addr=nullptr)
	Sends a message over the socket using extended SendMessageHeader data.

size_t	receive (void *buf, size_t length, const MessageFlags flags=MessageFlags{})
	Receive data from the socket, using specific receive flags.

std::pair< size_t, AddressFilledIn >	receiveFrom (void *buf, size_t length, SocketAddress &addr, const MessageFlags flags=MessageFlags{})
	Receive a packet, filling in the sender's address.

AddressFilledIn	receiveMessage (ReceiveMessageHeader &header, SocketAddress *addr=nullptr)
	Receives a message from the socket using extended ReceiveMessageHeader data.

Protected Member Functions inherited from cosmos::FileBase
	FileBase (const FileDescriptor fd=FileDescriptor{})

	FileBase (FileBase &&other) noexcept

FileBase &	operator= (FileBase &&other) noexcept

Protected Attributes inherited from cosmos::FDFile
AutoCloseFD	m_auto_close

Protected Attributes inherited from cosmos::FileBase
FileDescriptor	m_fd

Protected Attributes inherited from cosmos::StreamIO
FileDescriptor &	m_stream_fd

Detailed Description

template<SocketFamily family>
class cosmos::TCPListenSocketT< family >

Implementation of TCP listener sockets based on IPv4 and IPv6.

This class is templated to allow its use for both IPv4 and IPv6 based operation. Use TCP4ListenSocket and TCP6ListenSocket for the concrete types.

This type makes the listen(), bind() and accept() functions available to operate a server side TCP socket. accept() Will return a TCPConnectionT instance that represents an open connection and also offers corresponding I/O methods.

Definition at line 14 of file TCPOptions.hxx.

Member Typedef Documentation

◆ Connection

template<SocketFamily family>

using cosmos::TCPListenSocketT< family >::Connection = TCPConnectionT<FAMILY>

Definition at line 28 of file TCPListenSocket.hxx.

◆ IPAddress

template<SocketFamily family>

using cosmos::TCPListenSocketT< family >::IPAddress = typename FamilyTraits<FAMILY>::Address

Definition at line 27 of file TCPListenSocket.hxx.

Constructor & Destructor Documentation

◆ TCPListenSocketT()

template<SocketFamily family>

cosmos::TCPListenSocketT< family >::TCPListenSocketT ( const SocketFlags flags = SocketFlags{SocketFlag::CLOEXEC} )

inlineexplicit

Definition at line 33 of file TCPListenSocket.hxx.

                                                                       {SocketFlag::CLOEXEC}) :
                        ListenSocket{FAMILY, TYPE, flags} {
        }

Member Function Documentation

◆ accept()

template<SocketFamily family>

TCPConnectionT< FAMILY > cosmos::TCPListenSocketT< family >::accept ( IPAddress * addr = nullptr )

inline

Definition at line 64 of file TCPListenSocket.hxx.

                                                                 {
                auto fd = Socket::accept(addr);
                return TCPConnectionT<FAMILY>{fd};
        }

◆ bind()

template<SocketFamily family>

void cosmos::TCPListenSocketT< family >::bind ( const IPAddress & addr )

inline

Definition at line 60 of file TCPListenSocket.hxx.

                                         {
                return Socket::bind(addr);
        }

◆ getSockName()

template<SocketFamily family>

void cosmos::TCPListenSocketT< family >::getSockName ( IPAddress & addr )

inline

Returns the current address that the socket is bound to, if any.

Definition at line 54 of file TCPListenSocket.hxx.

                                          {
                Socket::getSockName(addr);
        }

◆ ipOptions() [1/2]

template<SocketFamily family>

auto cosmos::TCPListenSocketT< family >::ipOptions ( )

inline

Definition at line 37 of file TCPListenSocket.hxx.

                         {
                return typename FamilyTraits<FAMILY>::Options{m_fd};
        }

◆ ipOptions() [2/2]

template<SocketFamily family>

auto cosmos::TCPListenSocketT< family >::ipOptions ( ) const

inline

Definition at line 41 of file TCPListenSocket.hxx.

                               {
                return typename FamilyTraits<FAMILY>::Options{m_fd};
        }

◆ listen()

template<SocketFamily family>

void cosmos::Socket::listen ( const size_t backlog )

Enter into a passive listen state, allowing new connections.

This is only possible for connection mode socket types, when you want to accept new connections. For client side sockets this is not necessary.

Parameters

[in] backlog The number of pending connections that may be queued in the kernel.

Definition at line 127 of file Socket.cxx.

                                        {
        if (::listen(to_integral(m_fd.raw()), backlog) != 0) {
                cosmos_throw (ApiError("listen()"));
        }
}

◆ tcpOptions() [1/2]

template<SocketFamily family>

auto cosmos::TCPListenSocketT< family >::tcpOptions ( )

inline

Definition at line 45 of file TCPListenSocket.hxx.

                          {
                return TCPOptions{m_fd};
        }

◆ tcpOptions() [2/2]

template<SocketFamily family>

auto cosmos::TCPListenSocketT< family >::tcpOptions ( ) const

inline

Definition at line 49 of file TCPListenSocket.hxx.

                                {
                return TCPOptions{m_fd};
        }

Member Data Documentation

◆ TYPE

template<SocketFamily family>

auto cosmos::TCPListenSocketT< family >::TYPE = SocketType::STREAM

inlinestaticconstexpr

Definition at line 29 of file TCPListenSocket.hxx.

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

include/net/TCPListenSocket.hxx
include/net/TCPOptions.hxx

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Connection

◆ IPAddress

Constructor & Destructor Documentation

◆ TCPListenSocketT()

Member Function Documentation

◆ accept()

◆ bind()

◆ getSockName()

◆ ipOptions() [1/2]

◆ ipOptions() [2/2]

◆ listen()

◆ tcpOptions() [1/2]

◆ tcpOptions() [2/2]

Member Data Documentation

◆ TYPE