A bound socket used to listen for inbound socket connections. More...
#include <socket.h>
Inheritance diagram for ucommon::ListenSocket:
Collaboration diagram for ucommon::ListenSocket:
Public Member Functions | |
| socket_t | accept (struct sockaddr_storage *address=((void *) 0)) |
| Accept a socket connection. | |
| socket_t | getsocket (void) |
| Get the socket descriptor of the listener. | |
| ListenSocket (char *address, char *service, unsigned backlog=5, int family=0, int type=0, int protocol=0) | |
| Create and bind a listener socket. | |
| operator socket_t () | |
| Get the socket descriptor of the listener. | |
| socket_t | operator* () |
| Get the socket descriptor of the listener by pointer reference. | |
| bool | waitConnection (timeout_t timeout=Timer::inf) |
| Wait for a pending connection. | |
Static Public Member Functions | |
| static socket_t | create (char *address, char *service, unsigned backlog=5, int family=0, int type=0, int protocol=0) |
| Create a listen socket directly. | |
Detailed Description
A bound socket used to listen for inbound socket connections.
This class is commonly used for TCP and DCCP listener sockets.
Constructor & Destructor Documentation
| ucommon::ListenSocket::ListenSocket | ( | char * | address, |
| char * | service, | ||
| unsigned | backlog = 5, |
||
| int | family = 0, |
||
| int | type = 0, |
||
| int | protocol = 0 |
||
| ) |
Create and bind a listener socket.
- Parameters:
-
address to bind on or "*" for all. service port to bind listener. backlog size for buffering pending connections. family of socket. type of socket. protocol for socket if not TCPIP.
Member Function Documentation
| socket_t ucommon::ListenSocket::accept | ( | struct sockaddr_storage * | address = ((void *) 0) | ) |
Accept a socket connection.
- Parameters:
-
address to save peer connecting.
- Returns:
- socket descriptor of connected socket.
| static socket_t ucommon::ListenSocket::create | ( | char * | address, |
| char * | service, | ||
| unsigned | backlog = 5, |
||
| int | family = 0, |
||
| int | type = 0, |
||
| int | protocol = 0 |
||
| ) | [static] |
Create a listen socket directly.
- Parameters:
-
address to bind on or "*" for all. service port to bind listener. backlog size for buffering pending connections. family of socket. type of socket. protocol for socket if not TCPIP.
- Returns:
- bound and listened to socket.
| socket_t ucommon::ListenSocket::getsocket | ( | void | ) | [inline] |
| ucommon::ListenSocket::operator socket_t | ( | ) | [inline] |
Get the socket descriptor of the listener.
- Returns:
- socket descriptor.
Reimplemented from ucommon::Socket.
| socket_t ucommon::ListenSocket::operator* | ( | ) | [inline] |
Get the socket descriptor of the listener by pointer reference.
- Returns:
- socket descriptor.
Reimplemented from ucommon::Socket.
| bool ucommon::ListenSocket::waitConnection | ( | timeout_t | timeout = Timer::inf | ) | [inline] |
The documentation for this class was generated from the following file:
- ucommon/socket.h
