[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] [doc-en] master: [PHP 8.3] Document new socket_atmark() function. (#2946)
From:       David CARLIER via GitHub <noreply () php ! net>
Date:       2023-11-18 5:19:23
Message-ID: jNRxdyCifPqdGZ4qABWahrpqHuM02hzlkohnv7ZA2ps () main ! php ! net
[Download RAW message or body]

Author: David CARLIER (devnexen)
Committer: GitHub (web-flow)
Pusher: Girgias
Date: 2023-11-18T05:05:45Z

Commit: https://github.com/php/doc-en/commit/eef7fb60d16864b253aa3aa95a57f8b1cfd41451
Raw diff: https://github.com/php/doc-en/commit/eef7fb60d16864b253aa3aa95a57f8b1cfd41451.diff


[PHP 8.3] Document new socket_atmark() function. (#2946)

Changed paths:
  A  reference/sockets/functions/socket-atmark.xml
  M  reference/sockets/versions.xml


Diff:

diff --git a/reference/sockets/functions/socket-atmark.xml \
b/reference/sockets/functions/socket-atmark.xml new file mode 100644
index 00000000000..b1b96f6e515
--- /dev/null
+++ b/reference/sockets/functions/socket-atmark.xml
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.socket-atmark" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>socket_atmark</refname>
+  <refpurpose>Determines whether socket is at out-of-band mark</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>socket_atmark</methodname>
+   <methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Determines whether <parameter>socket</parameter> is at out-of-band mark.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>socket</parameter></term>
+     <listitem>
+      <para>
+       A <classname>Socket</classname> instance created with \
<function>socket_create</function>. +      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Using <function>socket_atmark</function> to set the source \
address</title> +    <programlisting role="php">
+<![CDATA[
+<?php
+// Create a new socket
+$sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
+var_dump(socket_atmark($sock));
+// Close
+socket_close($sock);
+?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>socket_connect</function></member>
+    <member><function>socket_create</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 08f5b6f6583..032c0c13288 100644
--- a/reference/sockets/versions.xml
+++ b/reference/sockets/versions.xml
@@ -9,6 +9,7 @@
  <function name="socket_addrinfo_connect" from="PHP 7 &gt;= 7.2.0, PHP 8"/>
  <function name="socket_addrinfo_explain" from="PHP 7 &gt;= 7.2.0, PHP 8"/>
  <function name="socket_addrinfo_lookup" from="PHP 7 &gt;= 7.2.0, PHP 8"/>
+ <function name="socket_atmark" from="PHP 8 &gt;= 8.3.0, PHP 8"/>
  <function name="socket_bind" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
  <function name="socket_clear_error" from="PHP 4 &gt;= 4.2.0, PHP 5, PHP 7, PHP 8"/>
  <function name="socket_close" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>

-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php


[prev in list] [next in list] [prev in thread] [next in thread]