<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- 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">

<refnamediv>

<refname>streamWrapper::stream_lock</refname>

<refpurpose>Bloqueo de archivos asesorado</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_lock</methodname>

<methodparam><type>int</type><parameter>operation</parameter></methodparam>

</methodsynopsis>

<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>).

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>operation</parameter></term>

<listitem>

<para>

<parameter>operation</parameter> es una de las operaciones siguientes:

<itemizedlist>

<listitem>

<simpara>

<constant>LOCK_SH</constant> para adquirir un bloqueo compartido (lectura).

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LOCK_EX</constant> para adquirir un bloqueo exclusivo (escritura).

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LOCK_UN</constant> para liberar un bloqueo (compartido o exclusivo).

</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>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<simpara>

&return.success;

</simpara>

</refsect1>

<refsect1 role="errors"><!-- {{{ -->

&reftitle.errors;

<simpara>

Emite un <constant>E_WARNING</constant> si la llamada a este método falla (es decir, no implementado).

</simpara>

</refsect1><!-- }}} -->

<!--

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>streamWrapper::stream_lock</function> example</title>

<programlisting role="php">

<![CDATA[

<?php

/* ... */

?>

]]>

</programlisting>

&example.outputs.similar;

<screen>

<![CDATA[

...

]]>

</screen>

</example>

</para>

</refsect1>

-->

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>stream_set_blocking</function></member>

<member><function>flock</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

-->