[edit] Last updated: Fri, 18 Sep 2009

stream_socket_client

(PHP 5)

stream_socket_client — Open Internet or Unix domain socket connection

Описание

resource stream_socket_client ( string $remote_socket [, int &$errno [, string &$errstr [, float $timeout = ini_get("default_socket_timeout") [, int $flags = STREAM_CLIENT_CONNECT [, resource $context ]]]]] )

Initiates a stream or datagram connection to the destination specified by remote_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 target portion 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 target portion should point to the socket file on the filesystem.

Забележка: The stream will by default be opened in blocking mode. You can switch it to non-blocking mode by using stream_set_blocking().

Параметри

remote_socket

Address to the socket to connect to.

errno

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

errstr

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

timeout

Number of seconds until the connect() system call should timeout.

Забележка: This parameter only applies when not making asynchronous connection attempts.

Забележка: To set a timeout for reading/writing data over the socket, use the stream_set_timeout(), as the timeout only applies while making connecting the socket.

flags

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.

context

A valid context resource created with stream_context_create().

Връщани стойности

On success a stream resource is returned which may be used together with the other file functions (such as fgets(), fgetss(), fwrite(), fclose(), and feof()), FALSE on failure.

Грешки/Изключения

On failure the errno and errstr arguments will be populated with the actual system level error that occurred in the system-level connect() call. If the value returned in errno is 0 and the function returned FALSE, it is an indication that the error occurred before the connect() 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.

Примери

Example #1 stream_socket_client() example


<?php
$fp = stream_socket_client("tcp://www.example.com:80", $errno, $errstr, 30);
if (!$fp) {
    echo "$errstr ($errno)<br />\n";
} else {
    fwrite($fp, "GET / HTTP/1.0\r\nHost: www.example.com\r\nAccept: */*\r\n\r\n");
    while (!feof($fp)) {
        echo fgets($fp, 1024);
    }
    fclose($fp);
}
?>

Example #2 Using UDP connection

Retrieving the day and time from the UDP service "daytime" (port 13) on localhost.


<?php
$fp = stream_socket_client("udp://127.0.0.1:13", $errno, $errstr);
if (!$fp) {
    echo "ERROR: $errno - $errstr<br />\n";
} else {
    fwrite($fp, "\n");
    echo fread($fp, 26);
    fclose($fp);
}
?>

Бележки

Предупреждение

UDP sockets will sometimes appear to have opened without an error, even if the remote host is unreachable. The error will only become apparent when you read or write data to/from the socket. The reason for this is because UDP is a "connectionless" protocol, which means that the operating system does not try to establish a link for the socket until it actually needs to send or receive data.

Забележка: При специфициране на цифров IPv6 адрес (например fe80::1) трябва да оградите IP-то с квадратни скоби. Например, tcp://[fe80::1]:80.

Забележка: Depending on the environment, the Unix domain or the optional connect timeout may not be available. A list of available transports can be retrieved using stream_get_transports(). See List of Supported Socket Transports for a list of built in transports.

Вж. също

stream_socket_server() - Create an Internet or Unix domain server socket
stream_set_blocking() - Set blocking/non-blocking mode on a stream
stream_set_timeout() - Set timeout period on a stream
stream_select() - Runs the equivalent of the select() system call on the given arrays of streams with a timeout specified by tv_sec and tv_usec
fgets() - Взима ред от файл от позицията, сочена от файловия указател
fgetss() - Взима ред от файл и изрязва HTML таговете
fwrite() - Двоично-безопасно записване във файл
fclose() - Closes an open file pointer
feof() - Проверява дали указателят е в края на файла
cURL Функции

stream_socket_enable_crypto

stream_socket_accept

[edit] Last updated: Fri, 18 Sep 2009

add a note User Contributed Notes stream_socket_client

Vasil Rangelov a.k.a. boen_robot 14-Aug-2011 07:11


The remote_socket argument, in its end (well... after the port), can also contain a "/" followed by a unique identifier. This is especially useful if you want to create multiple persistent connections to the same transport://host:port combo.



Example:

<?php

$socket = stream_socket_client('tcp://mysql.example.com:3306/root', $errorno, $errorstr, $timeout, STREAM_CLIENT_CONNECT | STREAM_CLIENT_PERSISTENT);

?>



Note that while (p)fsockopen() follows a similar scheme, it doesn't have this particular feature.

bisho at onirica dot com 29-Mar-2010 03:04


stream_socket_client is much easier and faster to use to direct sockets, because you can use directly fwrite / fget / fclose functions, but I find hard to find how to connect to a UNIX domain socket. The URL to use is "udg:///path/to/socket".



For example, to log to the log socket (like syslog), you can use:



<?php

$socket = stream_socket_client('udg:///dev/log',

        $errorno,

        $errorstr,

        $timeout);

fwrite($socket, ...);

?>

nicholas at nicholaswilliams dot net 28-Oct-2008 11:08


For those wanting to use stream_socket_client() to connect to a local UNIX socket who can't find documentation on how to do it, here's a (rough) example:



<?php



$sock = stream_socket_client('unix:///full/path/to/my/socket.sock', $errno, $errstr);



fwrite($sock, 'SOME COMMAND'."\r\n");



echo fread($sock, 4096)."\n";



fclose($sock);



?>

robin at gareus dot org 26-Aug-2008 10:19


the httpPost() function was almost too long for a user-comment..  I've cut some newlines but to be complete the code snippet misses:



<?php

 function randomNonce($len=0) {

  $chars = "ABCDEFGHIJKMNOPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz023456789";

  $i=0; $rv='';

  if ($len < 1) $len= (6+rand()%10);

  while ($i++ < $len) {

    $rv.=$chars[rand() % strlen($chars)];

  }

  return $rv;

}

?>

robin at gareus dot org 26-Aug-2008 09:34


I came here since fsockopen() does not support any SSL certificate checking in PHP5.



while curl is nice, I use stream_socket_client() to make XML-RPC POST requests via HTTPS and since I have not found any PHP code around that does this, I'll attach an example that also includes HTTP-Digest Auth (eg. trac's WikiRPCInterface2):



<?php

#################################################

# $host: hostname ; eg 'example.org' 

# $path: request' eg '/index.php?id=123'

# $data_to_send : data to POST after the HTTP header.

#

# if $opts is an  empty array() a standard  HTTP to port 80 request is performed. 

# 

# set auth['type']='basic' to use plain-text auth, 

# digest-auth will be handled automatically if $auth['username'] is set and a 401

# status is encountered. - use auth['type']='nodigest' to override.

#

##

function httpPost($host, $path, $data_to_send,

                  $opts=array('cert'=>"", 'headers'=>0, 'transport' =>'ssl', 'port'=>443),

                  $auth=array('username'=>"", 'password'=>"", 'type'=>"")

                 ) {

  $transport=''; $port=80;

  if (!empty($opts['transport'])) $transport=$opts['transport'];

  if (!empty($opts['port'])) $port=$opts['port'];

  $remote=$transport.'://'.$host.':'.$port;



  $context = stream_context_create();

  $result = stream_context_set_option($context, 'ssl', 'verify_host', true);

  if (!empty($opts['cert'])) {

    $result = stream_context_set_option($context, 'ssl', 'cafile', $opts['cert']);

    $result = stream_context_set_option($context, 'ssl', 'verify_peer', true);

  } else {

    $result = stream_context_set_option($context, 'ssl', 'allow_self_signed', true);

  }

  $fp = stream_socket_client($remote, $err, $errstr, 60, STREAM_CLIENT_CONNECT, $context);



  if (!$fp) {

    trigger_error('httpPost error: '.$errstr);

    return NULL;

  }



  $req='';

  $req.="POST $path HTTP/1.1\r\n";

  $req.="Host: $host\r\n";

  if ($auth['type']=='basic' && !empty($auth['username'])) {

    $req.="Authorization: Basic ";

    $req.=base64_encode($auth['username'].':'.$auth['password'])."\r\n";

  }

  elseif ($auth['type']=='digest' && !empty($auth['username'])) {

    $req.='Authorization: Digest ';

    foreach ($auth as $k => $v) {

      if (empty($k) || empty($v)) continue;

      if ($k=='password') continue;

      $req.=$k.'="'.$v.'", ';

    }

    $req.="\r\n";

  }

  $req.="Content-type: text/xml\r\n";

  $req.='Content-length: '. strlen($data_to_send) ."\r\n";

  $req.="Connection: close\r\n\r\n";



  fputs($fp, $req);

  fputs($fp, $data_to_send);



  while(!feof($fp)) { $res .= fgets($fp, 128); }

  fclose($fp);



  if ($auth['type']!='nodigest'

        && !empty($auth['username'])

        && $auth['type']!='digest' # prev. digest AUTH failed.

        && preg_match("/^HTTP\/[0-9\.]* 401 /", $res)) {

    if (1 == preg_match("/WWW-Authenticate: Digest ([^\n\r]*)\r\n/Us", $res, $matches)) {

      foreach (split(",", $matches[1]) as $i) {

        $ii=split("=",trim($i),2);

        if (!empty($ii[1]) && !empty($ii[0])) {

          $auth[$ii[0]]=preg_replace("/^\"/",'', preg_replace("/\"$/",'', $ii[1]));

        }

      }

      $auth['type']='digest';

      $auth['uri']='https://'.$host.$path;

      $auth['cnonce']=randomNonce();

      $auth['nc']=1;

      $a1=md5($auth['username'].':'.$auth['realm'].':'.$auth['password']);

      $a2=md5('POST'.':'.$auth['uri']);

      $auth['response']=md5($a1.':'

                           .$auth['nonce'].':'.$auth['nc'].':'

                           .$auth['cnonce'].':'.$auth['qop'].':'.$a2);

      return httpPost($host, $path, $data_to_send, $opts, $auth);

    }

  }



  if (1 != preg_match("/^HTTP\/[0-9\.]* ([0-9]{3}) ([^\r\n]*)/", $res, $matches)) {

    trigger_error('httpPost: invalid HTTP reply.');

    return NULL;

  }



  if ($matches[1] != '200') {

    trigger_error('httpPost: HTTP error: '.$matches[1].' '.$matches[2]);

    return NULL;

  }



  if (!$opts['headers']) {

    $res=preg_replace("/^.*\r\n\r\n/Us",'',$res);

  }

  return $res;

}

?>

wbeaver at afilias dot info 31-Aug-2007 08:06


# Some may find it useful to know that your caCert 

# must be in pem format, and that PHP seems to like 

# your key, cert, and cacert pem's to be concatenated

# in a single file (I suffered various "unknown chain" 

# errors, otherwise)

#

# So, (linux users), concat your components as follows:

# (where current working dir is dir where 

# cert components are stored)

#

# cat key.pem >certchain.pem

# cat cert.pem >>certchain.pem

# cat cacert.pem >>certchain.pem

#

# Then, the php....

##################################



<?php



$host = 'host.domain.tld';

$port = 1234;

$timeout = 10;



$cert = '/path/to/your/certchain/certchain.pem';

$context = stream_context_create(array('ssl'=>array('local_cert'=> $cert,

)));



if ($fp = stream_socket_client('ssl://'.$host.':'.$port, $errno, $errstr, 30,

        STREAM_CLIENT_CONNECT, $context)) {

    fwrite($fp, "\n");

    echo fread($fp,8192);

    fclose($fp);

} else {

   echo "ERROR: $errno - $errstr<br />\n";

}



?>

add a note