socket_listen

Listens for a connection on a socket (PHP 4 >= 4.0.7, PHP 5)
bool socket_listen ( resource socket [, int backlog] )

After the socket socket has been created using socket_create() and bound to a name with socket_bind(), it may be told to listen for incoming connections on socket.

socket_listen() is applicable only to sockets of type SOCK_STREAM or SOCK_SEQPACKET.

Parameters

socket

A valid socket resource created with socket_create().

backlog

A maximum of backlog incoming connections will be queued for processing. If a connection request arrives with the queue full the client may receive an error with an indication of ECONNREFUSED, or, if the underlying protocol supports retransmission, the request may be ignored so that retries may succeed.

Note:

The maximum number passed to the backlog parameter highly depends on the underlying platform. On Linux, it is silently truncated to SOMAXCONN. On win32, if passed SOMAXCONN, the underlying service provider responsible for the socket will set the backlog to a maximum reasonable value. There is no standard provision to find out the actual backlog value on this platform.

Return Values

Returns TRUE on success or FALSE on failure. The error code can be retrieved with socket_last_error(). This code may be passed to socket_strerror() to get a textual explanation of the error.

See Also

socket_accept()

socket_bind()

socket_connect()

socket_create()

socket_strerror()

Examples ( Source code ) » socket_listen


<?php

$socket = socket_create(AF_INET,SOCK_STREAM,SOL_TCP);

socket_bind($socket,$address,$port);

socket_listen($socket);

echo "Waiting for a connection\n";

$conn = false;

switch(@socket_select($r = array($socket), $w = array($socket), $e = array($socket), 60)) {

   case 2:

       echo "Connection refused\n";

       break;

   case 1:

       echo "Connection accepted\n";

       $conn = @socket_accept($socket);

       break;

   case 0:

       echo "Connection timed out\n";

       break;

}





if ($conn !== false) {

   // communicate over $conn

}

Code Examples / Notes » socket_listen

socket_listen() cannot be used for UDP communications as discussed below. In addition, the example below discusses UDP connections, which only exist if the application manages them through a state table (the OS does not create a UDP connection upon receiving a datagram). Having a function named socket_connect() that determines the remote IP and port only confuses the matter by giving the indication of some sort of connection handshake between two hosts. Rather, socket_connect() only specifies the remote IP and port used by subsequent socket_send() calls. You can achieve the same effect by skipping socket_connect() altogether and specifying the remote IP and port in socket_sendto() calls. If you find yourself writing a connection-based protocol on top of UDP, consider using TCP. If your application requires streaming data of some sort, use TCP to manage connections and control messages, and UDP to handle the streaming data (H.323 is an example of a suite of TCP and UDP protocols working in conjunction).

socket_listen

Listens for a connection on a socket (PHP 4 >= 4.0.7, PHP 5) bool socket_listen ( resource socket [, int backlog] )

Parameters

Return Values

Code Examples / Notes » socket_listen

Change Language

Listens for a connection on a socket (PHP 4 >= 4.0.7, PHP 5)
bool socket_listen ( resource socket [, int backlog] )