BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file BSignal.h
3 * @author Ambroz Bizjak <ambrop7@gmail.com>
4 *
5 * @section LICENSE
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of the author nor the
15 * names of its contributors may be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * @section DESCRIPTION
30 *
31 * A global object for catching program termination requests.
32 */
33  
34 #ifndef BADVPN_SYSTEM_BSIGNAL_H
35 #define BADVPN_SYSTEM_BSIGNAL_H
36  
37 #include <misc/debug.h>
38 #include <system/BReactor.h>
39  
40 typedef void (*BSignal_handler) (void *user);
41  
42 /**
43 * Initializes signal handling.
44 * The object is created in not capturing state.
45 * {@link BLog_Init} must have been done.
46 *
47 * WARNING: make sure this won't interfere with other components:
48 * - On Linux, this uses {@link BUnixSignal} to catch SIGTERM, SIGINT
49 * and SIGHUP.
50 * - on Windows, this sets up a handler with SetConsoleCtrlHandler.
51 *
52 * @param reactor {@link BReactor} from which the handler will be called
53 * @param handler callback function invoked from the reactor
54 * @param user value passed to callback function
55 * @return 1 on success, 0 on failure
56 */
57 int BSignal_Init (BReactor *reactor, BSignal_handler handler, void *user) WARN_UNUSED;
58  
59 /**
60 * Finishes signal handling.
61 * {@link BSignal_Init} must not be called again.
62 */
63 void BSignal_Finish (void);
64  
65 #endif