php-doc-en/reference/pht/atomicinteger/get.xml
2018-02-11 18:55:13 +00:00

83 lines
2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="pht.atomicinteger.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AtomicInteger::get</refname>
<refpurpose>Gets the atomic integer's value</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>AtomicInteger::get</methodname>
<void />
</methodsynopsis>
<para>
This method will fetch the current value of the atomic integer. Internally,
the mutex lock of the atomic integer will be acquired, and so there is no
need to manually acquire it (unless this operation needs to be grouped with
other operations on the same atomic integer - see the example in
<methodname>AtomicInteger::lock</methodname> for a demonstration of this).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The current integer value of the atomic integer.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Getting an atomic integer's value</title>
<programlisting role="php">
<![CDATA[
<?php
use pht\AtomicInteger;
$atomicInteger = new AtomicInteger(2);
var_dump($atomicInteger->get());
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
int(2)
]]>
</screen>
</example>
</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
-->