socket_connect

Initiates a connection on a socket

Description

bool socket_connect(Socket $socket, string $address, intnull $port = null)

Initiate a connection to address using the Socket instance socket, which must be Socket instance created with socket_create.

Parameters

socket

A Socket instance created with socket_create.

address

The address parameter is either an IPv4 address in dotted-quad notation (e.g. 127.0.0.1) if socket is AF_INET, a valid IPv6 address (e.g. ::1) if IPv6 support is enabled and socket is AF_INET6 or the pathname of a Unix domain socket, if the socket family is AF_UNIX.

port

The port parameter is only used and is mandatory when connecting to an AF_INET or an AF_INET6 socket, and designates the port on the remote host to which a connection should be made.

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.

Note:

If the socket is non-blocking then this function returns false with an error Operation now in progress.

Changelog

Version Description
8.0.0 socket is a Socket instance now; previously, it was a resource.
8.0.0 port is nullable now.

See Also

  • socket_bind
  • socket_listen
  • socket_create
  • socket_last_error
  • socket_strerror