E-MailRelay
Classes | Public Member Functions | List of all members
GNet::DatagramSocket Class Reference

A derivation of GNet::Socket for a datagram socket. More...

#include <gsocket.h>

+ Inheritance diagram for GNet::DatagramSocket:
+ Collaboration diagram for GNet::DatagramSocket:

Classes

struct  Config
 A configuration structure for GNet::DatagramSocket. More...
 

Public Member Functions

 DatagramSocket (Address::Family, int protocol, const Config &config)
 Constructor. More...
 
ssize_type read (char *buffer, size_type len) override
 Override from ReadWrite::read(). More...
 
ssize_type write (const char *buffer, size_type len) override
 Override from Socket::write(). More...
 
ssize_type readfrom (char *buffer, size_type len, Address &src)
 Reads a datagram and returns the sender's address by reference. More...
 
ssize_type writeto (const char *buffer, size_type len, const Address &dst)
 Sends a datagram to the given address. More...
 
ssize_type writeto (const std::vector< std::string_view > &, const Address &dst)
 Sends a datagram to the given address, overloaded for scatter-gather data chunks. More...
 
void disconnect ()
 Releases the association between two datagram endpoints reversing the effect of the previous Socket::connect(). More...
 
std::size_t limit (std::size_t default_=1024U) const
 Returns the systems's maximum datagram size if the value is known and greater than the given default value. More...
 
 DatagramSocket (const DatagramSocket &)=delete
 
 DatagramSocket (DatagramSocket &&)=delete
 
DatagramSocketoperator= (const DatagramSocket &)=delete
 
DatagramSocketoperator= (DatagramSocket &&)=delete
 
- Public Member Functions inherited from GNet::Socket
Address getLocalAddress () const
 Retrieves the local address of the socket. More...
 
std::pair< bool, AddressgetPeerAddress () const
 Retrieves address of socket's peer. More...
 
void bind (const Address &)
 Binds the socket with the given address. More...
 
bool bind (const Address &, std::nothrow_t)
 No-throw overload. Returns false on error. More...
 
unsigned long getBoundScopeId () const
 Returns the scope-id of the address last successfully bind()ed. More...
 
bool connect (const Address &addr, bool *done=nullptr)
 Initiates a connection to (or association with) the given address. More...
 
void listen ()
 Starts the socket listening on the bound address for incoming connections or incoming datagrams. More...
 
void shutdown (int how=1)
 Modifies the local socket state so that new sends (1 or 2) and/or receives (0 or 2) will fail. More...
 
 Socket (const Socket &)=delete
 
 Socket (Socket &&)=delete
 
Socketoperator= (const Socket &)=delete
 
Socketoperator= (Socket &&)=delete
 
- Public Member Functions inherited from GNet::SocketBase
 ~SocketBase () override
 Destructor. More...
 
SOCKET fd () const noexcept override
 Returns the socket file descriptor. More...
 
Descriptor fdd () const noexcept
 Returns the socket descriptor. More...
 
bool eWouldBlock () const override
 Returns true if the previous socket operation failed because the socket would have blocked. More...
 
bool eInProgress () const
 Returns true if the previous socket operation failed with the EINPROGRESS error status. More...
 
bool eInUse () const
 Returns true if the previous socket bind operation failed because the socket was already in use. More...
 
bool eMsgSize () const
 Returns true if the previous socket operation failed with the EMSGSIZE error status. More...
 
bool eTooMany () const
 Returns true if the previous socket operation failed with the EMFILE error status, or similar. More...
 
bool eNotConn () const
 Returns true if the previous socket operation failed with the ENOTCONN error status, or similar. More...
 
void addReadHandler (EventHandler &, EventState)
 Adds this socket to the event source list so that the given handler receives read events. More...
 
void dropReadHandler () noexcept
 Reverses addReadHandler(). More...
 
void addWriteHandler (EventHandler &, EventState)
 Adds this socket to the event source list so that the given handler receives write events when flow control is released. More...
 
void dropWriteHandler () noexcept
 Reverses addWriteHandler(). More...
 
void addOtherHandler (EventHandler &, EventState)
 Adds this socket to the event source list so that the given handler receives exception events. More...
 
void dropOtherHandler () noexcept
 Reverses addOtherHandler(). More...
 
std::string asString () const
 Returns the socket handle as a string. More...
 
std::string reason () const
 Returns the reason for the previous error. More...
 
 SocketBase (const SocketBase &)=delete
 
 SocketBase (SocketBase &&)=delete
 
SocketBaseoperator= (const SocketBase &)=delete
 
SocketBaseoperator= (SocketBase &&)=delete
 
- Public Member Functions inherited from G::ReadWrite
virtual ssize_type read (char *buffer, size_type buffer_length)=0
 Reads data. More...
 
virtual ssize_type write (const char *buf, size_type len)=0
 Sends data. More...
 
virtual bool eWouldBlock () const =0
 See read() and write(). More...
 
virtual SOCKET fd () const noexcept=0
 Returns the file descriptor. More...
 
virtual ~ReadWrite ()=default
 Destructor.
 

Additional Inherited Members

- Public Types inherited from GNet::SocketBase
using size_type = G::ReadWrite::size_type
 
using ssize_type = G::ReadWrite::ssize_type
 
- Public Types inherited from G::ReadWrite
using size_type = std::size_t
 
using ssize_type = ssize_t
 
- Static Public Member Functions inherited from GNet::Socket
static std::string canBindHint (const Address &address, bool stream_socket, const Config &)
 Returns the empty string if a socket could probably be bound with the given address or a failure reason. More...
 
- Static Public Member Functions inherited from GNet::SocketBase
static bool supports (Address::Family, int type, int protocol)
 Returns true if sockets can be created with the given parameters. More...
 
- Protected Member Functions inherited from GNet::Socket
 Socket (Address::Family, int type, int protocol, const Config &)
 
 Socket (Address::Family, Descriptor s, const Accepted &, const Config &)
 
 Socket (Address::Family, Descriptor s, const Adopted &, const Config &)
 
void setOptionLinger (int onoff, int time)
 
void setOptionKeepAlive ()
 
void setOptionFreeBind ()
 
- Protected Member Functions inherited from GNet::SocketBase
 SocketBase (Address::Family, int type, int protocol)
 Constructor used by derived classes. More...
 
 SocketBase (Address::Family, Descriptor s)
 Constructor used by derived classes. More...
 
 SocketBase (Address::Family, Descriptor s, const Accepted &)
 Constructor used by StreamSocket::accept() to create a socket object from a newly accept()ed socket handle. More...
 
 SocketBase (const Raw &, int domain, int type, int protocol)
 Constructor for a raw socket. More...
 
void clearReason ()
 Clears the saved errno. More...
 
void saveReason ()
 Saves the current errno following error()/sizeError(). More...
 
void saveReason () const
 Saves the current errno following error()/sizeError(). More...
 
bool isFamily (Address::Family) const
 Returns true if the socket family is as given. More...
 
- Static Protected Member Functions inherited from GNet::Socket
static Address getLocalAddress (Descriptor)
 
- Static Protected Member Functions inherited from GNet::SocketBase
static bool error (int rc)
 Returns true if the given return code indicates an error. More...
 
static bool sizeError (ssize_type size)
 Returns true if the given write() return value indicates an error. More...
 

Detailed Description

A derivation of GNet::Socket for a datagram socket.

Definition at line 429 of file gsocket.h.

Constructor & Destructor Documentation

◆ DatagramSocket()

GNet::DatagramSocket::DatagramSocket ( Address::Family  af,
int  protocol,
const Config config 
)
explicit

Constructor.

Definition at line 589 of file gsocket.cpp.

Member Function Documentation

◆ disconnect()

void GNet::DatagramSocket::disconnect ( )

Releases the association between two datagram endpoints reversing the effect of the previous Socket::connect().

Definition at line 595 of file gsocket.cpp.

◆ limit()

std::size_t GNet::DatagramSocket::limit ( std::size_t  default_ = 1024U) const

Returns the systems's maximum datagram size if the value is known and greater than the given default value.

Returns the given default value if the system limit is not known.

See also
SO_SNDBUF, /proc/sys/net/core/wmem_default

Definition at line 245 of file gsocket_unix.cpp.

◆ read()

GNet::Socket::ssize_type GNet::DatagramSocket::read ( char *  buffer,
size_type  len 
)
overridevirtual

Override from ReadWrite::read().

Implements G::ReadWrite.

Definition at line 603 of file gsocket.cpp.

◆ readfrom()

GNet::Socket::ssize_type GNet::DatagramSocket::readfrom ( char *  buffer,
size_type  len,
Address src 
)

Reads a datagram and returns the sender's address by reference.

If connect() has been used then only datagrams from the address specified in the connect() call will be received.

Definition at line 617 of file gsocket.cpp.

◆ write()

GNet::Socket::ssize_type GNet::DatagramSocket::write ( const char *  buffer,
size_type  len 
)
overridevirtual

Override from Socket::write().

Implements G::ReadWrite.

Definition at line 644 of file gsocket.cpp.

◆ writeto() [1/2]

GNet::Socket::ssize_type GNet::DatagramSocket::writeto ( const char *  buffer,
size_type  len,
const Address dst 
)

Sends a datagram to the given address.

This should be used if there is no connect() assocation in effect.

Definition at line 632 of file gsocket.cpp.

◆ writeto() [2/2]

GNet::Socket::ssize_type GNet::DatagramSocket::writeto ( const std::vector< std::string_view > &  data,
const Address dst 
)

Sends a datagram to the given address, overloaded for scatter-gather data chunks.

Definition at line 258 of file gsocket_unix.cpp.


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