socket-bind.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 35883800e764cccacf5772330bc007b6b08ffc6e Maintainer: countzero Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.socket-bind" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_bind</refname>
  <refpurpose>Привязывает имя к сокету</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>socket_bind</methodname>
   <methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
   <methodparam><type>string</type><parameter>address</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция привязывает имя, которое указали в параметре <parameter>address</parameter>,
   к сокету, который описали в параметре <parameter>socket</parameter>. Привязку имени
   требуется сделать до установки соединения функцией <function>socket_connect</function>
   или <function>socket_listen</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       Экземпляр класса <classname>Socket</classname>, который создала функция <function>socket_create</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>address</parameter></term>
     <listitem>
      <para>
       В аргументе <parameter>address</parameter> передают IP-адрес
       в 4-точечной нотации наподобие <literal>127.0.0.1</literal>),
       если сокет принадлежит семейству <constant>AF_INET</constant> — IPv4-адреса сокетов в интернет-домене.
      </para>
      <para>
       В аргументе <parameter>address</parameter> передают путь сокета
       наподобие <filename>/tmp/my.sock</filename>),
       если сокет принадлежит семейству <constant>AF_UNIX</constant> — адреса сокетов
       в виде имён путей файловой системы в Unix-домене.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter> (Optional)</term>
     <listitem>
      <para>
       Параметр <parameter>port</parameter> устанавливают только
       при привязке <constant>AF_INET</constant>-сокета. Параметр определяет порт,
       на котором требуется прослушивать соединения.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
  <para>
   Код ошибки получают функцией <function>socket_last_error</function>.
   Код передают в функцию <function>socket_strerror</function>,
   чтобы получить текстовое объяснение ошибки.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &sockets.changelog.socket-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример установки адреса источника функцией <function>socket_bind</function></title>
    <programlisting role="php">
<![CDATA[
<?php

// Создаём новый сокет
$sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);

// Пример списка IP-адресов, которые принадлежат компьютеру
$sourceips['kevin']    = '127.0.0.1';
$sourceips['madcoder'] = '127.0.0.2';

// Привязываем адрес источника
socket_bind($sock, $sourceips['madcoder']);

// Соединяемся с адресом назначения
socket_connect($sock, '127.0.0.1', 80);

// Пишем в сокет
$request = 'GET / HTTP/1.1' . "\r\n" .
           'Host: example.com' . "\r\n\r\n"
;
socket_write($sock, $request);

// Закрываем сокет
socket_close($sock);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Функцию вызывают на сокете перед подключением к сокету
    функцией <function>socket_connect</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>socket_connect</function></member>
    <member><function>socket_listen</function></member>
    <member><function>socket_create</function></member>
    <member><function>socket_last_error</function></member>
    <member><function>socket_strerror</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->