zmq_atomic_counter_value.txt 1.62 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
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
18 19
counter created by _zmq_atomic_counter_new()_. This function uses platform 
specific atomic operations.
20 21 22 23


RETURN VALUE
------------
24 25 26
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.
27 28 29 30 31 32 33 34 35 36 37 38


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);
39 40 41
assert (zmq_atomic_counter_dec (counter) == 1);
assert (zmq_atomic_counter_dec (counter) == 1);
assert (zmq_atomic_counter_dec (counter) == 0);
42
zmq_atomic_counter_set (counter, 2);
43 44
assert (zmq_atomic_counter_dec (counter) == 1);
assert (zmq_atomic_counter_dec (counter) == 0);
45
zmq_atomic_counter_destroy (&counter);
46
return 0;
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
----


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