From c5b54a68f45a0e55a55e60078cacbdf96ae76665 Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Fri, 2 Mar 2012 03:46:36 +0000
Subject: [PATCH] Added documentation for socket_import_stream()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323784 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/socket-import-stream.xml        | 90 +++++++++++++++++++
 reference/sockets/versions.xml                |  1 +
 2 files changed, 91 insertions(+)
 create mode 100644 reference/sockets/functions/socket-import-stream.xml

diff --git a/reference/sockets/functions/socket-import-stream.xml b/reference/sockets/functions/socket-import-stream.xml
new file mode 100644
index 0000000000..de97bb09d1
--- /dev/null
+++ b/reference/sockets/functions/socket-import-stream.xml
@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision:$ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-import-stream">
+ <refnamediv>
+  <refname>socket_import_stream</refname>
+  <refpurpose>Import a stream</refpurpose>
+ </refnamediv>
+ 
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>void</type><methodname>socket_import_stream</methodname>
+   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Imports a stream that encapsulates a socket into a socket extension resource.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>stream</parameter></term>
+     <listitem>
+      <para>
+       The stream resource to import.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &false; or &null; on failure.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>socket_import_stream</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$stream = stream_socket_server("udp://0.0.0.0:58380", $errno, $errstr, STREAM_SERVER_BIND); 
+$sock   = socket_import_stream($stream);
+?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>stream_socket_server</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
+-->
diff --git a/reference/sockets/versions.xml b/reference/sockets/versions.xml
index b3d83ebb46..9023aec04b 100644
--- a/reference/sockets/versions.xml
+++ b/reference/sockets/versions.xml
@@ -25,6 +25,7 @@
  <function name='socket_getopt' from='PHP 4 &gt;= 4.1.0, PHP 5'/>
  <function name='socket_getpeername' from='PHP 4 &gt;= 4.1.0, PHP 5'/>
  <function name='socket_getsockname' from='PHP 4 &gt;= 4.1.0, PHP 5'/>
+ <function name='socket_import_stream' from='PHP 4 &gt;= 5.4.0'/>
  <function name='socket_iovec_add' from='PHP 4 &gt;= 4.1.0'/>
  <function name='socket_iovec_alloc' from='PHP 4 &gt;= 4.1.0'/>
  <function name='socket_iovec_delete' from='PHP 4 &gt;= 4.1.0'/>