xref: /btstack/src/ble/gatt-service/link_loss_service_server.h (revision ceed67ffe68ea5103bbc5647a2e000ed0e08b747)
1 /*
2  * Copyright (C) 2021 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 /**
39  * @title Link Loss Service Server
40  *
41  */
42 
43 #ifndef LINK_LOSS_SERVICE_SERVER_H
44 #define LINK_LOSS_SERVICE_SERVER_H
45 
46 #include <stdint.h>
47 #include "ble/gatt-service/link_loss_service_util.h"
48 
49 #if defined __cplusplus
50 extern "C" {
51 #endif
52 
53 
54 /**
55  * @ To use with your application, add `#import <link_loss_service.gatt>` to your .gatt file.
56  */
57 
58 /* API_START */
59 
60 /**
61  * @brief Init Link Loss Service Server with ATT DB
62  * @param mute_state
63  */
64 void link_loss_service_server_init(void);
65 
66 /**
67  * @brief Register packet handler
68  */
69 void link_loss_service_server_register_packet_handler(btstack_packet_handler_t packet_handler);
70 
71 /**
72  * @brief Set alert level. Default is no alert.
73  * @param alert_level
74  */
75 uint8_t link_loss_service_client_set_alert_level(lls_alert_level_t alert_level);
76 
77 /**
78  * @brief Set alert timeout. Default is 0 that equals to no timeout.
79  * @param alert_timeout_ms
80  */
81 uint8_t link_loss_service_server_set_alert_timeout(uint32_t alert_timeout_ms);
82 
83 
84 void link_loss_service_server_stop_alerting(void);
85 
86 /* API_END */
87 
88 #if defined __cplusplus
89 }
90 #endif
91 
92 #endif
93 
94