plucky (3) zmq_atomic_counter_destroy.3.gz

Provided by: libzmq3-dev_4.3.5-1build2_amd64 bug

NAME

       zmq_atomic_counter_destroy - destroy an atomic counter

SYNOPSIS

       void zmq_atomic_counter_destroy (void **counter_p);

DESCRIPTION

       The zmq_atomic_counter_destroy function destroys an atomic counter and nullifies its reference. Pass the
       address of an atomic counter (void **) rather than the counter itself. You must destroy all counters that
       you create, to avoid memory leakage. This function uses platform specific atomic operations.

RETURN VALUE

       The zmq_atomic_counter_destroy() function has no return value.

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

       zmq_atomic_counter_new(3) zmq_atomic_counter_set(3) zmq_atomic_counter_inc(3) zmq_atomic_counter_dec(3)
       zmq_atomic_counter_value(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.