Socket_SocketPool Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	__construct ()
	Creates sockets.
	__destruct ()
	Closes all connections.
	countSockets ()
	Returns the amount of active sockets.
	addSocket ($add_socket)
	Adds a socket to the pool.
	removeSocket ($remove_socket)
	Removes the given socket from the pool.
	createTcpSocket ($IPv6=FALSE)
	Creates a new TcpSocket and adds it to the pool.
	select ($read, $write, $except, $timeout=NULL)
	Returns an array of sockets one can read from.
Geschützte Attribute
	$sockets

---

Ausführliche Beschreibung

Definiert in Zeile 8 der Datei SocketPool.php.

---

Beschreibung der Konstruktoren und Destruktoren

Socket_SocketPool.__construct

(

)

Creates sockets.

Rückgabe:

void

Definiert in Zeile 20 der Datei SocketPool.php.

Socket_SocketPool.__destruct

(

)

Closes all connections.

Rückgabe:

void

Definiert in Zeile 28 der Datei SocketPool.php.

---

Dokumentation der Elementfunktionen

Socket_SocketPool.addSocket

(

$

add_socket

)

Adds a socket to the pool.

Parameter:

ressource

$add_socket

Rückgabe:

void

Definiert in Zeile 45 der Datei SocketPool.php.

Wird benutzt von createTcpSocket().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Socket_SocketPool.countSockets

(

)

Returns the amount of active sockets.

Rückgabe:

int

Definiert in Zeile 36 der Datei SocketPool.php.

Socket_SocketPool.createTcpSocket

(

$

IPv6 = FALSE

)

Creates a new TcpSocket and adds it to the pool.

Ausnahmebehandlung:

Exception_SocketException

Parameter:

boolean

$IPv6 will determine whether the socket uses IPv4 or IPv6.

Rückgabe:

ressource

Definiert in Zeile 73 der Datei SocketPool.php.

Benutzt addSocket().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Socket_SocketPool.removeSocket

(

$

remove_socket

)

Removes the given socket from the pool.

The socket will be shutdown.

Parameter:

ressource

$remove_socket

Rückgabe:

void

Definiert in Zeile 55 der Datei SocketPool.php.

Socket_SocketPool.select	(	$	read,
		$	write,
		$	except,
		$	timeout = NULL
	)

Returns an array of sockets one can read from.

Parameter:

	array	$read
	array	$write
	array	$except
	int	$timeout

Ausnahmebehandlung:

Exception_SocketException

Rückgabe:

array

Definiert in Zeile 91 der Datei SocketPool.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• Classes/Socket/SocketPool.php