mirror of
https://github.com/zeromq/libzmq.git
synced 2024-12-12 10:33:52 +01:00
b6ca9b2983
* migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
55 lines
1.6 KiB
Plaintext
55 lines
1.6 KiB
Plaintext
= zmq_atomic_counter_dec(3)
|
|
|
|
|
|
== NAME
|
|
zmq_atomic_counter_dec - decrement an atomic counter
|
|
|
|
|
|
== SYNOPSIS
|
|
*int zmq_atomic_counter_dec (void *counter);*
|
|
|
|
|
|
== DESCRIPTION
|
|
The _zmq_atomic_counter_dec_ function decrements an atomic counter in
|
|
a threadsafe fashion. This function uses platform specific atomic
|
|
operations.
|
|
|
|
|
|
== RETURN VALUE
|
|
The _zmq_atomic_counter_dec()_ function returns 1 if the counter is
|
|
greater than zero after decrementing, or zero if the counter reached
|
|
zero.
|
|
|
|
|
|
== EXAMPLE
|
|
.Test code for atomic counters
|
|
----
|
|
void *counter = zmq_atomic_counter_new ();
|
|
assert (zmq_atomic_counter_value (counter) == 0);
|
|
assert (zmq_atomic_counter_inc (counter) == 0);
|
|
assert (zmq_atomic_counter_inc (counter) == 1);
|
|
assert (zmq_atomic_counter_inc (counter) == 2);
|
|
assert (zmq_atomic_counter_value (counter) == 3);
|
|
assert (zmq_atomic_counter_dec (counter) == 1);
|
|
assert (zmq_atomic_counter_dec (counter) == 1);
|
|
assert (zmq_atomic_counter_dec (counter) == 0);
|
|
zmq_atomic_counter_set (counter, 2);
|
|
assert (zmq_atomic_counter_dec (counter) == 1);
|
|
assert (zmq_atomic_counter_dec (counter) == 0);
|
|
zmq_atomic_counter_destroy (&counter);
|
|
return 0;
|
|
----
|
|
|
|
|
|
== SEE ALSO
|
|
xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
|
|
xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
|
|
xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
|
|
xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
|
|
xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
|
|
|
|
|
|
== AUTHORS
|
|
This page was written by the 0MQ community. To make a change please
|
|
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.
|