socket_set_option

Sets socket options for the socket (PHP 4 >= 4.3.0, PHP 5)
bool socket_set_option ( resource socket, int level, int optname, mixed optval )

The socket_set_option() function sets the option specified by the optname parameter, at the specified protocol level, to the value pointed to by the optval parameter for the socket.

Parameters

socket: A valid socket resource created with socket_create() or socket_accept().
level: The level parameter specifies the protocol level at which the option resides. For example, to retrieve options at the socket level, a level parameter of SOL_SOCKET would be used. Other levels, such as TCP, can be used by specifying the protocol number of that level. Protocol numbers can be found by using the getprotobyname() function.
optname: The available socket options are the same as those for the socket_get_option() function.
optval: The option value.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 2303. socket_set_option() example

copy to clipboard

<?php

$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);


if (!is_resource($socket)) {

    echo 'Unable to create socket: '. socket_strerror(socket_last_error()) . PHP_EOL;

}


if (!socket_set_option($socket, SOL_SOCKET, SO_REUSEADDR, 1)) {

    echo 'Unable to set option on socket: '. socket_strerror(socket_last_error()) . PHP_EOL;

}


if (!socket_bind($socket, '127.0.0.1', 1223)) {

    echo 'Unable to bind socket: '. socket_strerror(socket_last_error()) . PHP_EOL;

}

$rval = socket_get_option($socket, SOL_SOCKET, SO_REUSEADDR);


if ($rval === false) {

    echo 'Unable to get socket option: '. socket_strerror(socket_last_error()) . PHP_EOL;

} else if ($rval !== 0) {

    echo 'SO_REUSEADDR is set on socket !' . PHP_EOL;

}
?>

ChangeLog

Version	Description
4.3.0	This function was renamed. It used to be called socket_setopt().

To expand a bit more on what "tim at e2-media dot co dot nz" started. SO_SNDTIMEO is one of the many constants you can use with socket_set_option. See http://ca.php.net/manual/en/ref.sockets.php for the available Predefind Constants and visit http://man.he.net/man2/setsockopt for the meaning of the ones relevant. Tim's example might seem at first a bit non-intuitive since he is using the SO_SNDTIMEO constant. Which means, if the socket has to send out data, it must do it within the limit specified - in his case 10 seconds. Usually you won't set a timeout for sending out data. Nevertheless, the example is valid, and there are situations where you need to do so. A more intuitive use of socket_set_option would be to set a time out for a blocking socket (a socket that waits for data to be receive when read from). You would do this like so: socket_set_option($socket,SOL_SOCKET, SO_RCVTIMEO, array("sec"=>0, "usec"=>100)); Notice that sec= 0 and usec= 100; Depending on how long you want your program to wait to recieve data, you might want to change these values. Regards, drenintell

socket_set_option

Sets socket options for the socket (PHP 4 >= 4.3.0, PHP 5)
bool socket_set_option ( resource socket, int level, int optname, mixed optval )

Parameters

Return Values

Examples

Example 2303. socket_set_option() example

ChangeLog

Code Examples / Notes » socket_set_option

Change Language

socket_set_option

Sets socket options for the socket (PHP 4 >= 4.3.0, PHP 5) bool socket_set_option ( resource socket, int level, int optname, mixed optval )

Parameters

Return Values

Examples

Example 2303. socket_set_option() example

ChangeLog

Code Examples / Notes » socket_set_option

Change Language

Sets socket options for the socket (PHP 4 >= 4.3.0, PHP 5)
bool socket_set_option ( resource socket, int level, int optname, mixed optval )