ucc::ListenSocket Class Reference

A bound socket used to listen for inbound socket connections. More...

#include <socket.h>

Inheritance diagram for ucc::ListenSocket:

[legend]

Collaboration diagram for ucc::ListenSocket:

[legend]

Public Member Functions
socket_t	accept (struct sockaddr_storage *address=NULL)
	Accept a socket connection.
socket_t	getsocket (void) const
	Get the socket descriptor of the listener.
	ListenSocket (const char *address, const char *service, unsigned backlog=5, int protocol=0)
	Create and bind a listener socket.
	operator socket_t () const
	Get the socket descriptor of the listener.
socket_t	operator* () const
	Get the socket descriptor of the listener by pointer reference.
bool	waitConnection (timeout_t timeout=Timer::inf) const
	Wait for a pending connection.

---

Detailed Description

A bound socket used to listen for inbound socket connections.

This class is commonly used for TCP and DCCP listener sockets.

Author:

David Sugar <dyfet@gnutelephony.org>

Definition at line 1669 of file socket.h.

---

Constructor & Destructor Documentation

ucc::ListenSocket::ListenSocket	(	const char *	address,
		const char *	service,
		unsigned	backlog = 5,
		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.
	protocol	for socket if not TCPIP.

---

Member Function Documentation

socket_t ucc::ListenSocket::accept

(

struct sockaddr_storage *

address = NULL

)

Accept a socket connection.

Parameters:

address

to save peer connecting.

Returns:

socket descriptor of connected socket.

socket_t ucc::ListenSocket::getsocket

(

void

)

const [inline]

Get the socket descriptor of the listener.

Returns:

socket descriptor.

Definition at line 1714 of file socket.h.

ucc::ListenSocket::operator socket_t

(

)

const [inline]

Get the socket descriptor of the listener.

Returns:

socket descriptor.

Reimplemented from ucc::Socket.

Definition at line 1700 of file socket.h.

socket_t ucc::ListenSocket::operator*

(

)

const [inline]

Get the socket descriptor of the listener by pointer reference.

Returns:

socket descriptor.

Reimplemented from ucc::Socket.

Definition at line 1707 of file socket.h.

bool ucc::ListenSocket::waitConnection

(

timeout_t

timeout = Timer::inf

)

const [inline]

Wait for a pending connection.

Parameters:

timeout

to wait.

Returns:

true when acceptable connection is pending.

Definition at line 1693 of file socket.h.

---

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

• ucommon/socket.h