Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
counter.h
Go to the documentation of this file.
1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2016 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Kannel Group (http://www.kannel.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  * endorse or promote products derived from this software without
29  * prior written permission. For written permission, please
30  * contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  * nor may "Kannel" appear in their name, without prior written
34  * permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group. For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 /*
58  * gwlib/counter.h - a counter object
59  *
60  * Kannel has monotonously growing counters in some places, and these need
61  * to work even when several threads use them. This header defines the
62  * type Counter that provides such a counter. The counter is a long, and
63  * if it reaches LONG_MAX, it wraps around to zero (_NOT_ LONG_MIN).
64  *
65  * Lars Wirzenius.
66  *
67  * Changed the counter type 'long' into 'unsigned long' so it wraps
68  * by itself. Just keep increasing it.
69  * Also added a counter_increase_with function.
70  * harrie@lisanza.net
71  */
72 
73 
74 #ifndef COUNTER_H
75 #define COUNTER_H
76 
77 typedef struct Counter Counter;
78 
79 /* create a new counter object. PANIC if fails */
80 Counter *counter_create(void);
81 
82 /* destroy it */
84 
85 /* return the current value of the counter and increase counter by one */
86 unsigned long counter_increase(Counter *counter);
87 
88 /* return the current value of the counter and increase counter by value */
89 unsigned long counter_increase_with(Counter *counter, unsigned long value);
90 
91 /* return the current value of the counter */
92 unsigned long counter_value(Counter *counter);
93 
94 /* return the current value of the counter and decrease counter by one */
95 unsigned long counter_decrease(Counter *counter);
96 
97 /* return the current value of the counter and set it to the supplied value */
98 unsigned long counter_set(Counter *, unsigned long);
99 
100 #endif
unsigned long counter_value(Counter *counter)
Definition: counter.c:145
unsigned long counter_increase_with(Counter *counter, unsigned long value)
Definition: counter.c:134
unsigned long counter_set(Counter *, unsigned long)
Definition: counter.c:167
Counter * counter_create(void)
Definition: counter.c:94
unsigned long counter_increase(Counter *counter)
Definition: counter.c:123
unsigned long counter_decrease(Counter *counter)
Definition: counter.c:155
static Counter * counter
void counter_destroy(Counter *counter)
Definition: counter.c:110
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.