xref: /6.0.3/platform/include/platform/interrupt.h (revision 72cbf62f)
1/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/*
3 *     Copyright 2018 Couchbase, Inc
4 *
5 *   Licensed under the Apache License, Version 2.0 (the "License");
6 *   you may not use this file except in compliance with the License.
7 *   You may obtain a copy of the License at
8 *
9 *       http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *   Unless required by applicable law or agreed to in writing, software
12 *   distributed under the License is distributed on an "AS IS" BASIS,
13 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *   See the License for the specific language governing permissions and
15 *   limitations under the License.
16 */
17#pragma once
18
19#include <platform/platform.h>
20
21namespace cb {
22namespace console {
23using interrupt_handler = void (*)();
24
25/**
26 * Sets a handler that will be invoked when a ctrl+c event is detected
27 *
28 * @throws std::system_error if an error occurs while setting up the
29 *                           handler
30 */
31PLATFORM_PUBLIC_API
32void set_sigint_handler(interrupt_handler h);
33
34/**
35 * Clears any handler that might have been invoked where a ctrl+c event
36 * was detected.
37 */
38PLATFORM_PUBLIC_API
39void clear_sigint_handler();
40} // namespace console
41} // namespace cb
42