STREAM_SOCKET_RECVFROM(3)						 1						 STREAM_SOCKET_RECVFROM(3)

stream_socket_recvfrom - Receives data from a socket, connected or not

SYNOPSIS

       string stream_socket_recvfrom (resource	$socket, int  $length, [int  $flags], [string  &$address])

DESCRIPTION

       stream_socket_recvfrom(3) accepts data from a remote socket up to $length bytes.

PARAMETERS

	      o $socket
		- The remote socket.

	      o $length
		- The number of bytes to receive from the $socket.

	      o $flags
		- The value of $flags can be any combination of the following:

	      Possible values for $flags

	      +------------+---------------------------------------------------+
	      | 	   |						       |
	      |STREAM_OOB  |						       |
	      | 	   |						       |
	      | 	   |	      Process OOB ( out-of-band) data.	       |
	      | 	   |						       |
	      | 	   |						       |
	      |STREAM_PEEK |						       |
	      | 	   |						       |
	      | 	   |  Retrieve	data  from the socket, but do not con- |
	      | 	   | sume the buffer. Subsequent calls to fread(3)  or |
	      | 	   | stream_socket_recvfrom(3) will see the same data. |
	      | 	   |						       |
	      +------------+---------------------------------------------------+
	      o $address
		- If $address is provided it will be populated with the address of the remote socket.

RETURN VALUES

	Returns the read data, as a string

EXAMPLES

       Example #1

	      stream_socket_recvfrom(3) example

	      <?php
	      /* Open a server socket to port 1234 on localhost */
	      $server = stream_socket_server('tcp://127.0.0.1:1234');

	      /* Accept a connection */
	      $socket = stream_socket_accept($server);

	      /* Grab a packet (1500 is a typical MTU size) of OOB data */
	      echo "Received Out-Of-Band: '" . stream_socket_recvfrom($socket, 1500, STREAM_OOB) . "'
";

	      /* Take a peek at the normal in-band data, but don't comsume it. */
	      echo "Data: '" . stream_socket_recvfrom($socket, 1500, STREAM_PEEK) . "'
";

	      /* Get the exact same packet again, but remove it from the buffer this time. */
	      echo "Data: '" . stream_socket_recvfrom($socket, 1500) . "'
";

	      /* Close it up */
	      fclose($socket);
	      fclose($server);
	      ?>

NOTES

       Note

	       If  a message received is longer than the $length parameter, excess bytes may be discarded depending on the type of socket the mes-
	      sage is received from (such as UDP).

       Note

	       Calls to stream_socket_recvfrom(3) on socket-based streams,  after  calls  to  buffer-based  stream  functions  (like  fread(3)	or
	      stream_get_line(3)) read data directly from the socket and bypass the stream buffer.

SEE ALSO 
stream_socket_sendto(3), stream_socket_client(3), stream_socket_server(3).
PHP Documentation Group 												 STREAM_SOCKET_RECVFROM(3)