Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
heartbeat.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  * heartbeat.h - thread for sending heartbeat Msgs to bearerbox
59  */
60 
61 #ifndef HEARTBEAT_H
62 #define HEARTBEAT_H
63 
64 #include "gwlib/gwlib.h"
65 #include "msg.h"
66 
67 #define DEFAULT_HEARTBEAT 30
68 #define ALL_HEARTBEATS -1
69 /*
70  * Signature for a function that returns the current load value.
71  */
72 typedef long hb_load_func_t(void);
73 
74 /*
75  * Signature for a function that takes the heartbeat msg and does
76  * something with it.
77  */
78 typedef void hb_send_func_t(Msg *hb);
79 
80 /*
81  * Start a thread that produces Msgs of type heartbeat on the msgs list.
82  * The speed is approximately one per freq seconds.
83  * The function load_func will be called to determine what should be
84  * filled in for the load parameter.
85  * Return the thread number. Return -1 if the operation failed.
86  */
89 
90 /*
91  * Stop the indicated heartbeat thread.
92  */
93 void heartbeat_stop(long hb_thread);
94 
95 #endif
long heartbeat_start(hb_send_func_t *send_func, double freq, hb_load_func_t *load_func)
Definition: heartbeat.c:126
hb_send_func_t * send_func
Definition: heartbeat.c:72
long hb_load_func_t(void)
Definition: heartbeat.h:72
void hb_send_func_t(Msg *hb)
Definition: heartbeat.h:78
double freq
Definition: heartbeat.c:73
Definition: msg.h:79
hb_load_func_t * load_func
Definition: heartbeat.c:74
void heartbeat_stop(long hb_thread)
Definition: heartbeat.c:160
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.