Home > PHP > Function > Streams > stream_socket_client()

stream_socket_client()

stream_socket_client - Open Internet or Unix domain socket connection

Syntax

resource stream_socket_client (string $remote_socket, int &$errno, string &$errstr, float $timeout, int $flags, resource $context)

Arguments

  • remote_socket - Address to the socket to connect to.
  • errno - Will be set to the system level error number if connection fails.
  • errstr - Will be set to the system level error message if the connection fails.
  • timeout - Number of seconds until the connect()system call should timeout. Note: This parameter only applies when not making asynchronous connection attempts. Note: To set a timeout for reading/writing data over the socket, use the stream_set_timeout(), as the timeout only applies while making connecting the socket.
  • flags - Bitmask field which may be set to any combination of connection flags. Currently the select of connection flags is limited to STREAM_CLIENT_CONNECT (default), STREAM_CLIENT_ASYNC_CONNECT and STREAM_CLIENT_PERSISTENT.
  • context - A valid context resource created with stream_context_create().

Description

Initiates a stream or datagram connection to the destination specified by remote_socket. The type of socket created is determined by the transport specified using standard URL formatting: transport://target. For Internet Domain sockets (AF_INET) such as TCP and UDP, the targetportion of the remote_socket parameter should consist of a hostname or IP address followed by a colon and a port number. For Unix domain sockets, the target portion should point to the socket file on the filesystem.

Version

PHP 5

Return value

On success a stream resource is returned which may be used together with the other file functions (such as fgets(), fgetss(), fwrite(), fclose(), and feof()), FALSE on failure.