mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
Partially fix #77899: No documentation for 7.3 new functions
We document the socket_wsaprotocol_info_* functions. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347618 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker
@@ -0,0 +1,82 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="function.socket-wsaprotocol-info-export" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>socket_wsaprotocol_info_export</refname>
|
||||
<refpurpose>Exports the WSAPROTOCOL_INFO Structure</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>socket_wsaprotocol_info_export</methodname>
|
||||
<methodparam><type>resource </type><parameter>socket</parameter></methodparam>
|
||||
<methodparam><type>int </type><parameter>target_pid</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Exports the <literal>WSAPROTOCOL_INFO</literal> structure into shared memory and returns
|
||||
an identifier to be used with <function>socket_wsaprotocol_info_import</function>. The
|
||||
exported ID is only valid for the given <parameter>target_pid</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>socket</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A valid socket resource.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>target_pid</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The ID of the process which will import the the socket.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an identifier to be used for the import, &return.falseforfailure;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><function>socket_wsaprotocol_info_import</function></member>
|
||||
<member><function>socket_wsaprotocol_info_release</function></member>
|
||||
</simplelist>
|
||||
</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
|
||||
-->
|
||||
@@ -0,0 +1,71 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="function.socket-wsaprotocol-info-import" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>socket_wsaprotocol_info_import</refname>
|
||||
<refpurpose>Imports a Socket from another Process</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>resource</type><methodname>socket_wsaprotocol_info_import</methodname>
|
||||
<methodparam><type>string</type><parameter>info_id</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Imports a socket which has formerly been exported from another process.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>info_id</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The ID which has been returned by a former call to
|
||||
<function>socket_wsaprotocol_info_export</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the socket resource, &return.falseforfailure;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><function>socket_wsaprotocol_info_export</function></member>
|
||||
</simplelist>
|
||||
</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
|
||||
-->
|
||||
@@ -0,0 +1,71 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="function.socket-wsaprotocol-info-release" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>socket_wsaprotocol_info_release</refname>
|
||||
<refpurpose>Releases an exported WSAPROTOCOL_INFO Structure</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>socket_wsaprotocol_info_release</methodname>
|
||||
<methodparam><type>string</type><parameter>info_id</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Releases the shared memory corresponding to the given <parameter>info_id</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>info_id</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The ID which has been returned by a former call to
|
||||
<function>socket_wsaprotocol_info_export</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><function>socket_wsaprotocol_info_export</function></member>
|
||||
</simplelist>
|
||||
</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
|
||||
-->
|
||||
@@ -43,6 +43,9 @@
|
||||
<function name="socket_shutdown" from="PHP 4 >= 4.1.0, PHP 5, PHP 7"/>
|
||||
<function name="socket_strerror" from="PHP 4 >= 4.1.0, PHP 5, PHP 7"/>
|
||||
<function name="socket_write" from="PHP 4 >= 4.1.0, PHP 5, PHP 7"/>
|
||||
<function name="socket_wsaprotocol_info_export" from="PHP 7 >= 7.3.0"/>
|
||||
<function name="socket_wsaprotocol_info_import" from="PHP 7 >= 7.3.0"/>
|
||||
<function name="socket_wsaprotocol_info_release" from="PHP 7 >= 7.3.0"/>
|
||||
</versions>
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
||||
Reference in New Issue
Block a user