Skip to content

[PHP 8.3] Adding new socket_atmark call. #2946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Girgias merged 2 commits into from
Nov 18, 2023
Merged

[PHP 8.3] Adding new socket_atmark call. #2946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5485244
[PHP 8.3] Adding new socket_atmark call.
devnexen Nov 17, 2023
93ca6ea
changes from review
devnexen Nov 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions reference/sockets/functions/socket-atmark.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
-->
1 change: 1 addition & 0 deletions reference/sockets/versions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"/>
Expand Down