Fawkes API  Fawkes Development Version
fawkes::DatagramSocket Class Reference

#include <netcomm/socket/datagram.h>

Inheritance diagram for fawkes::DatagramSocket:

Public Member Functions

 DatagramSocket (AddrType addr_type, float timeout=0.f)
 Constructor. More...
 
 DatagramSocket (DatagramSocket &s)
 Copy constructor. More...
 
DatagramSocketoperator= (DatagramSocket &s)
 Assingment operator. More...
 
virtual Socketclone ()
 Clone socket. More...
 
- Public Member Functions inherited from fawkes::Socket
 Socket (AddrType addr_type, SocketType sock_type, float timeout=0.f)
 Constructor similar to syscall. More...
 
 Socket (Socket &socket)
 Copy constructor. More...
 
virtual ~Socket ()
 Destructor. More...
 
Socketoperator= (Socket &socket)
 Copy constructor. More...
 
virtual void connect (const char *hostname, const unsigned short int port)
 Connect socket. More...
 
virtual void connect (const struct ::sockaddr_storage &addr_port)
 Connect socket. More...
 
virtual void connect (const struct sockaddr *addr_port, socklen_t struct_size)
 Connect socket. More...
 
virtual void bind (const unsigned short int port)
 Bind socket. More...
 
virtual void bind (const unsigned short int port, const char *ipaddr)
 Bind socket to a specific address. More...
 
virtual void listen (int backlog=1)
 Listen on socket. More...
 
virtual Socketaccept ()
 Accept connection. More...
 
virtual void close ()
 Close socket. More...
 
virtual bool available ()
 Check if data is available. More...
 
virtual size_t read (void *buf, size_t count, bool read_all=true)
 Read from socket. More...
 
virtual void write (const void *buf, size_t count)
 Write to the socket. More...
 
virtual void send (void *buf, size_t buf_len)
 Write to the socket. More...
 
virtual void send (void *buf, size_t buf_len, const struct sockaddr *to_addr, socklen_t addr_len)
 Send message. More...
 
virtual size_t recv (void *buf, size_t buf_len)
 Read from socket. More...
 
virtual size_t recv (void *buf, size_t buf_len, struct sockaddr *from_addr, socklen_t *addr_len)
 Receive data. More...
 
virtual short poll (int timeout=-1, short what=POLL_IN|POLL_HUP|POLL_PRI|POLL_RDHUP)
 Wait for some event on socket. More...
 
virtual bool listening ()
 Is socket listening for connections? More...
 
virtual unsigned int mtu ()
 Maximum Transfer Unit (MTU) of socket. More...
 
template<class SocketTypeC >
SocketTypeC * accept ()
 Accept connection. More...
 

Additional Inherited Members

- Public Types inherited from fawkes::Socket
enum  AddrType { UNSPECIFIED, IPv4, IPv6 }
 Address type specification. More...
 
enum  SocketType { TCP, UDP }
 Socket type. More...
 
- Static Public Attributes inherited from fawkes::Socket
static const short POLL_IN = POLLIN
 Data can be read. More...
 
static const short POLL_OUT = POLLOUT
 Writing will not block. More...
 
static const short POLL_PRI = POLLPRI
 There is urgent data to read (e.g., out-of-band data on TCP socket; pseudo-terminal master in packet mode has seen state change in slave). More...
 
static const short POLL_RDHUP = 0
 Stream socket peer closed connection, or shut down writing half of connection. More...
 
static const short POLL_ERR = POLLERR
 Error condition. More...
 
static const short POLL_HUP = POLLHUP
 Hang up. More...
 
static const short POLL_NVAL = POLLNVAL
 Invalid request. More...
 
- Protected Member Functions inherited from fawkes::Socket
 Socket (SocketType sock_type, float timeout=0.f)
 IPv4 Constructor. More...
 
 Socket ()
 Constructor. More...
 
- Protected Attributes inherited from fawkes::Socket
AddrType addr_type
 
int sock_fd
 
float timeout
 
struct ::sockaddr_storage * client_addr
 
unsigned int client_addr_len
 

Detailed Description

Datagram socket. A UDP socket on top of IP.

Author
Tim Niemueller

Definition at line 35 of file datagram.h.

Constructor & Destructor Documentation

◆ DatagramSocket() [1/2]

fawkes::DatagramSocket::DatagramSocket ( AddrType  addr_type,
float  timeout = 0.f 
)

Constructor.

Parameters
addr_typeSpecify IPv4 or IPv6
timeouttimeout, if 0 all operationsare blocking, otherwise it is tried for timeout seconds.

Definition at line 45 of file datagram.cpp.

◆ DatagramSocket() [2/2]

fawkes::DatagramSocket::DatagramSocket ( DatagramSocket datagram_socket)

Copy constructor.

Parameters
datagram_socketsocket to copy.

Definition at line 52 of file datagram.cpp.

References fawkes::Socket::operator=().

Member Function Documentation

◆ clone()

Socket * fawkes::DatagramSocket::clone ( )
virtual

Clone socket.

Returns
a copied instance of DatagramSocket.

Implements fawkes::Socket.

Definition at line 71 of file datagram.cpp.

◆ operator=()

DatagramSocket & fawkes::DatagramSocket::operator= ( DatagramSocket s)

Assingment operator.

Parameters
ssocket to copy from
Returns
reference to this

Definition at line 61 of file datagram.cpp.


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