socket_set_option

(PHP 4 >= 4.3.0, PHP 5)

socket_set_option — Soketle ilgili seçenekleri belirler

Açıklama

bool socket_set_option ( resource $soket , int $seviye , int $seçenek , mixed $değer )

Belirtilen soket'in seçenek seçeneğine belirtilen protokol seviye'si için değer değerini atar.

Değiştirgeler

soket: socket_create() veya socket_accept() ile oluşturulmuş geçerli bir soket özkaynağı.
seviye: Seçeneğin geçerli olacağı protokol seviyesi. Örneğin soket seviyesindeki seçenekleri almak için bu değiştirgede SOL_SOCKET kullanılabilirdi. TCP gibi diğer seviyeler, seviyenin protokol numarası belirtilerek kullanılabilir. Protokol numaralarını getprotobyname() işleviyle alabilirsiniz.
seçenek: socket_get_option() işleviyle alınan soket seçeneklerinden biri olmalıdır.
değer: Seçeneğin değeri.

Dönen Değerler

Başarı durumunda TRUE, başarısızlık durumunda FALSE döner.

Örnekler

Örnek 1 - socket_set_option() örneği


<?php
$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);

if (!is_resource($socket)) {
    echo 'Soket oluşturulamadı: '.
          socket_strerror(socket_last_error()) . PHP_EOL;
}

if (!socket_set_option($socket, SOL_SOCKET, SO_REUSEADDR, 1)) {
    echo 'Sokete seçenek atanamadı: '.
          socket_strerror(socket_last_error()) . PHP_EOL;
}

if (!socket_bind($socket, '127.0.0.1', 1223)) {
    echo 'Sokete bağlanılamadı: '.
          socket_strerror(socket_last_error()) . PHP_EOL;
}

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

if ($rval === false) {
    echo 'Soket seçeneği alınamadı: '.
          socket_strerror(socket_last_error()) . PHP_EOL;
} else if ($rval !== 0) {
    echo 'Sokete SO_REUSEADDR atandı!' . PHP_EOL;
}
?>

Sürüm Bilgisi

Sürüm:	Açıklama
4.3.0	İşlevin ismi değişti. Eski ismi socket_setopt() idi.

socket_shutdown

socket_set_nonblock

[edit] Last updated: Fri, 23 Mar 2012

add a note User Contributed Notes socket_set_option

ckozler at kozler dot net 19-Mar-2012 01:06


It appears that Winsock does not acknowledge timeout (send and receive) on Windows.

DaveRandom 25-Nov-2010 09:13


Setting the socket timeout microseconds ('usec') does not work under Windows, at least under PHP/5.2.9:



<?php



  $timeout = array('sec'=>1,'usec'=>500000);

  socket_set_option($socket,SOL_SOCKET,SO_RCVTIMEO,$timeout);

  var_dump(socket_set_option($socket,SOL_SOCKET,SO_RCVTIMEO));



?>



Output on Windows box:



array(2) {

  ["sec"]=>

  int(1)

  ["usec"]=>

  int(0)

}



Output on Linux box:



array(2) {

  ["sec"]=>

  int(1)

  ["usec"]=>

  int(500000)

}

aeolianmeson at ifacfchi dot blitzeclipse dot com 26-Jun-2008 09:31


Lingering will sometimes not work when you're working with non-blocking sockets. Even if the socket is set to linger and you keep tying to close until the socket doesn't return an error and the resource is no longer identifiable as type 'Socket', the socket may STILL close without sending everything.



Therefore, in the event that you are using non-blocking sockets (which is preferable if you care at all about signaling), you should set the socket as blocking (socket_set_block()) before calling to close it. This will allow everything to flush before it returns.



Dustin Oprea

ludvig dot ericson at gmail dot com 21-Dec-2006 06:06


I would like to comment on the previous note regarding blocking sockets.

There is more to blocking sockets than waiting for data to be received when trying to be read upon, just to make example, a listening blocking socket will wait for a client to try to connect before it returns when you socket_accept() it.

drenintell 30-Apr-2005 11:19


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

tim at e2-media dot co dot nz 16-May-2004 02:00


To set a socket timeout value (assuming you've set it blocking) use:



socket_set_option(

  $socket,

  SOL_SOCKET,  // socket level

  SO_SNDTIMEO, // timeout option

  array(

    "sec"=>10, // Timeout in seconds

    "usec"=>0  // I assume timeout in microseconds

    )

  );

add a note