Home > PHP > Function > Streams > stream_socket_server()

stream_socket_server()

stream_socket_server - Create an Internet or Unix domain server socket

Syntax

resource stream_socket_server (string $local_socket, int &$errno, string &$errstr, int $flags, resource $context)

Arguments

  • local_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 targetportion should point to the socket file on the filesystem. Depending on the environment, Unix domain sockets may not be available. A list of available transports can be retrieved using stream_get_transports(). See List of Supported Socket Transportsfor a list of bulitin transports.
  • errno - If the optional errno and errstr arguments are present they will be set to indicate the actual system level error that occurred in the system-level socket(), bind(), and listen()calls. If the value returned in errno is 0and the function returned FALSE, it is an indication that the error occurred before the bind()call. This is most likely due to a problem initializing the socket. Note that the errno and errstr arguments will always be passed by reference.
  • errstr - See errno description.
  • flags - A bitmask field which may be set to any combination of socket creation flags. Note: For UDP sockets, you must use STREAM_SERVER_BIND as the flags parameter.
  • context

Description

Creates a stream or datagram socket on the specified local_socket.

Version

PHP 5

Return value

Returns the created stream, or FALSE on error.