Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals

counter.h

Go to the documentation of this file.
00001 /* ==================================================================== 
00002  * The Kannel Software License, Version 1.0 
00003  * 
00004  * Copyright (c) 2001-2008 Kannel Group  
00005  * Copyright (c) 1998-2001 WapIT Ltd.   
00006  * All rights reserved. 
00007  * 
00008  * Redistribution and use in source and binary forms, with or without 
00009  * modification, are permitted provided that the following conditions 
00010  * are met: 
00011  * 
00012  * 1. Redistributions of source code must retain the above copyright 
00013  *    notice, this list of conditions and the following disclaimer. 
00014  * 
00015  * 2. Redistributions in binary form must reproduce the above copyright 
00016  *    notice, this list of conditions and the following disclaimer in 
00017  *    the documentation and/or other materials provided with the 
00018  *    distribution. 
00019  * 
00020  * 3. The end-user documentation included with the redistribution, 
00021  *    if any, must include the following acknowledgment: 
00022  *       "This product includes software developed by the 
00023  *        Kannel Group (http://www.kannel.org/)." 
00024  *    Alternately, this acknowledgment may appear in the software itself, 
00025  *    if and wherever such third-party acknowledgments normally appear. 
00026  * 
00027  * 4. The names "Kannel" and "Kannel Group" must not be used to 
00028  *    endorse or promote products derived from this software without 
00029  *    prior written permission. For written permission, please  
00030  *    contact org@kannel.org. 
00031  * 
00032  * 5. Products derived from this software may not be called "Kannel", 
00033  *    nor may "Kannel" appear in their name, without prior written 
00034  *    permission of the Kannel Group. 
00035  * 
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
00039  * DISCLAIMED.  IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS 
00040  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,  
00041  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT  
00042  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR  
00043  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,  
00044  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE  
00045  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,  
00046  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
00047  * ==================================================================== 
00048  * 
00049  * This software consists of voluntary contributions made by many 
00050  * individuals on behalf of the Kannel Group.  For more information on  
00051  * the Kannel Group, please see <http://www.kannel.org/>. 
00052  * 
00053  * Portions of this software are based upon software originally written at  
00054  * WapIT Ltd., Helsinki, Finland for the Kannel project.  
00055  */ 
00056 
00057 /*
00058  * gwlib/counter.h - a counter object
00059  *
00060  * Kannel has monotonously growing counters in some places, and these need
00061  * to work even when several threads use them. This header defines the
00062  * type Counter that provides such a counter. The counter is a long, and
00063  * if it reaches LONG_MAX, it wraps around to zero (_NOT_ LONG_MIN).
00064  *
00065  * Lars Wirzenius.
00066  *
00067  * Changed the counter type 'long' into 'unsigned long' so it wraps
00068  * by itself. Just keep increasing it.
00069  * Also added a counter_increase_with function.
00070  * harrie@lisanza.net
00071  */
00072 
00073 
00074 #ifndef COUNTER_H
00075 #define COUNTER_H
00076 
00077 typedef struct Counter Counter;
00078 
00079 /* create a new counter object. PANIC if fails */
00080 Counter *counter_create(void);
00081 
00082 /* destroy it */
00083 void counter_destroy(Counter *counter);
00084 
00085 /* return the current value of the counter and increase counter by one */
00086 unsigned long counter_increase(Counter *counter);
00087 
00088 /* return the current value of the counter and increase counter by value */
00089 unsigned long counter_increase_with(Counter *counter, unsigned long value);
00090 
00091 /* return the current value of the counter */
00092 unsigned long counter_value(Counter *counter);
00093 
00094 /* return the current value of the counter and decrease counter by one */
00095 unsigned long counter_decrease(Counter *counter);
00096 
00097 /* return the current value of the counter and set it to the supplied value */
00098 unsigned long counter_set(Counter *, unsigned long);
00099 
00100 #endif
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.