stream_socket_client

Open Internet or Unix domain socket connection.

stream_socket_client Function synopsis

stream_socket_client(
    string $address,
    &$error_code = null,
    &$error_message = null,
    ?float $timeout = null,
    int $flags = STREAM_CLIENT_CONNECT,
    $context = null
  )

Parameters

$address

Typestring

Address to the socket to connect to.

$error_code

Passed by reference, OptionalDefault valuenull

Will be set to the system level error number if connection fails.

$error_message

Passed by reference, OptionalDefault valuenull

Will be set to the system level error message if the connection fails.

$timeout

OptionalType?floatDefault valuenull

Number of seconds until the connect() system call should timeout. By default, default_socket_timeout is used.

$flags

OptionalTypeintDefault valueSTREAM_CLIENT_CONNECT

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.

$flags accepts one or a bitmask of the following constant values:

• STREAM_CLIENT_CONNECT
• STREAM_CLIENT_ASYNC_CONNECT
• STREAM_CLIENT_PERSISTENT

$context

OptionalDefault valuenull

A valid context resource created with stream_context_create.

Note that the parameters $error_code and $error_message are passed by reference, and contain additional/updated context data that may be useful.