Files
Leonardo Lara Rodrigues 4baf074b52 sync file lines with en rev
2026-01-27 09:14:27 -03:00

126 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncsharedmemory.write">
<refnamediv>
<refname>SyncSharedMemory::write</refname>
<refpurpose>Copia dados para memória compartilhada nomeada</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>SyncSharedMemory::write</methodname>
<methodparam choice="opt"><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<simpara>
Copia dados para memória compartilhada nomeada.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<simpara>
Os dados a serem gravados na memória compartilhada.
</simpara>
<note>
<simpara>
Se o tamanho dos dados exceder o tamanho da memória compartilhada, o número de bytes
gravados retornados será menor que o comprimento da entrada.
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>start</parameter></term>
<listitem>
<simpara>
A posição, em bytes, a partir da qual a escrita será iniciada.
</simpara>
<note>
<simpara>
Se o valor for negativo, a posição inicial começará no número
de bytes especificado a partir do final do segmento de memória compartilhada.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Um inteiro contendo o número de bytes gravados na memória compartilhada.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemplo de <function>SyncSharedMemory::write</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Provavelmente será necessário proteger a memória compartilhada com outros objetos de sincronização.
// A memória compartilhada desaparece quando a última referência a ela desaparece.
$mem = new SyncSharedMemory("AppReportName", 1024);
if ($mem->first())
{
// Faça a primeira inicialização aqui.
}
$result = $mem->write("report.txt");
var_dump($result);
$result = $mem->write("report.txt", -3);
var_dump($result);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
int(10)
int(3)
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>SyncSharedMemory::__construct</methodname></member>
<member><methodname>SyncSharedMemory::first</methodname></member>
<member><methodname>SyncSharedMemory::write</methodname></member>
<member><methodname>SyncSharedMemory::read</methodname></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
-->