xref: /btstack/src/ble/att_server.h (revision 8caefee39d444df6d8908a96a844825f10fbdaa4)
1 /*
2  * Copyright (C) 2014 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 MATTHIAS
24  * RINGWALD 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 #ifndef __ATT_SERVER_H
38 #define __ATT_SERVER_H
39 
40 #include "btstack.h"
41 #include <stdint.h>
42 #include "att.h"
43 
44 #if defined __cplusplus
45 extern "C" {
46 #endif
47 
48 /* API_START */
49 /*
50  * @brief setup ATT server
51  * @param db attribute database created by compile-gatt.ph
52  * @param read_callback, see att.h, can be NULL
53  * @param write_callback, see attl.h, can be NULL
54  */
55 void att_server_init(uint8_t const * db, att_read_callback_t read_callback, att_write_callback_t write_callback);
56 
57 /*
58  * @brief register packet handler for general HCI Events like connect, diconnect, etc.
59  * @param handler
60  */
61 void att_server_register_packet_handler(btstack_packet_handler_t handler);
62 
63 /*
64  * @brief tests if a notification or indication can be send right now
65  * @return 1, if packet can be sent
66  */
67 int  att_server_can_send(void);
68 
69 /*
70  * @brief notify client about attribute value change
71  * @return 0 if ok, error otherwise
72  */
73 int att_server_notify(uint16_t handle, uint8_t *value, uint16_t value_len);
74 
75 /*
76  * @brief indicate value change to client. client is supposed to reply with an indication_response
77  * @return 0 if ok, error otherwise
78  */
79 int att_server_indicate(uint16_t handle, uint8_t *value, uint16_t value_len);
80 
81 /* API_END */
82 
83 #if defined __cplusplus
84 }
85 #endif
86 
87 #endif // __ATT_SERVER_H
88