Skip to content

[Sync EN] streamWrapper::stream_lock: document LOCK_NB as bitmask flag #621

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
PhilDaiguille merged 1 commit into from
May 14, 2026
Merged

[Sync EN] streamWrapper::stream_lock: document LOCK_NB as bitmask flag #621

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 12 additions & 14 deletions reference/stream/streamwrapper/stream-lock.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: fa5ef560a6ea59e32de1e383969ac728526a1335 Maintainer: seros Status: ready -->
<!-- EN-Revision: 38231ac293eaabd5161c7276a72b9683ad02fd3c Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="streamwrapper.stream-lock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Expand All @@ -15,13 +15,13 @@
<modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_lock</methodname>
<methodparam><type>int</type><parameter>operation</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Este método es llamado en respuesta a <function>flock</function>, cuando se utiliza
<function>file_put_contents</function> (cuando el parámetro <parameter>flags</parameter>
contiene <constant>LOCK_EX</constant>),
<function>stream_set_blocking</function> y cuando se cierra el flujo
(<constant>LOCK_UN</constant>).
</para>
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand Down Expand Up @@ -49,15 +49,13 @@
<constant>LOCK_UN</constant> para liberar un bloqueo (compartido o exclusivo).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>LOCK_NB</constant>, utilice esta operación si no quiere que
<function>flock</function> bloquee mientras opera.
(no soportado en Windows)
</simpara>
</listitem>
</itemizedlist>
</para>
<simpara>
También es posible añadir <constant>LOCK_NB</constant> como máscara de bits
a una de las operaciones anteriores, si el bloqueo no debe bloquear
durante el intento de bloqueo (no soportado en Windows).
</simpara>
</listitem>
</varlistentry>
</variablelist>
Expand All @@ -66,16 +64,16 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>

<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
<simpara>
Emite un <constant>E_WARNING</constant> si la llamada a este método falla (es decir, no implementado).
</para>
</simpara>
</refsect1><!-- }}} -->


Expand Down