mirror of
https://github.com/zeromq/libzmq.git
synced 2024-12-14 11:06:59 +01:00
439e49bca1
Solution: provide correct description Fixes #2789
63 lines
1.6 KiB
Plaintext
63 lines
1.6 KiB
Plaintext
zmq_atomic_counter_value(3)
|
|
===========================
|
|
|
|
|
|
NAME
|
|
----
|
|
zmq_atomic_counter_value - return value of atomic counter
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
*int zmq_atomic_counter_value (void *counter);*
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
The _zmq_atomic_counter_value_ function returns the value of an atomic
|
|
counter created by _zmq_atomic_counter_new()_. This function uses platform
|
|
specific atomic operations.
|
|
|
|
|
|
RETURN VALUE
|
|
------------
|
|
The _zmq_atomic_counter_value()_ function returns the value of the
|
|
atomic counter. If _counter_ does not point to an atomic counter created by
|
|
_zmq_atomic_counter_new()_, the behaviour is undefined.
|
|
|
|
|
|
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
|
|
--------
|
|
linkzmq:zmq_atomic_counter_new[3]
|
|
linkzmq:zmq_atomic_counter_set[3]
|
|
linkzmq:zmq_atomic_counter_inc[3]
|
|
linkzmq:zmq_atomic_counter_dec[3]
|
|
linkzmq:zmq_atomic_counter_destroy[3]
|
|
|
|
|
|
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>.
|