xref: /btstack/src/ble/att_dispatch.h (revision 0561b2d8d5dba972c7daa57d5e677f7a1327edfd)
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 
38 
39 /**
40  * Dispatcher for independent implementation of ATT client and server
41  */
42 
43 #ifndef ATT_DISPATCH_H
44 #define ATT_DISPATCH_H
45 
46 #include "btstack_util.h"
47 
48 #if defined __cplusplus
49 extern "C" {
50 #endif
51 
52 /**
53  * @brief reset att dispatchter
54  * @param packet_hander for ATT client packets
55  */
56 void att_dispatch_register_client(btstack_packet_handler_t packet_handler);
57 
58 /**
59  * @brief reset att dispatchter
60  * @param packet_hander for ATT server packets
61  */
62 void att_dispatch_register_server(btstack_packet_handler_t packet_handler);
63 
64 /**
65  * @brief can send packet for client
66  * @param con_handle
67  */
68 int att_dispatch_client_can_send_now(hci_con_handle_t con_handle);
69 
70 /**
71  * @brief can send packet for server
72  * @param con_handle
73  */
74 int att_dispatch_server_can_send_now(hci_con_handle_t con_handle);
75 
76 /**
77  * @brief Request emission of L2CAP_EVENT_CAN_SEND_NOW as soon as possible for client
78  * @note L2CAP_EVENT_CAN_SEND_NOW might be emitted during call to this function
79  *       so packet handler should be ready to handle it
80  * @param con_handle
81  */
82 void att_dispatch_client_request_can_send_now_event(hci_con_handle_t con_handle);
83 
84 /**
85  * @brief Request emission of L2CAP_EVENT_CAN_SEND_NOW as soon as possible for server
86  * @note L2CAP_EVENT_CAN_SEND_NOW might be emitted during call to this function
87  *       so packet handler should be ready to handle it
88  * @param con_handle
89  */
90 void att_dispatch_server_request_can_send_now_event(hci_con_handle_t con_handle);
91 
92 /**
93 * @brief Used for propogating a updated MTU from att_server to gatt_client
94 * @param con_handle
95 * @param mtu
96 */
97 void att_dispatch_server_mtu_exchanged(hci_con_handle_t con_handle, uint16_t new_mtu);
98 
99 /**
100 * @brief Used for propogating a updated MTU from gatt_client to att_server
101 * @param con_handle
102 * @param mtu
103 */
104 void att_dispatch_client_mtu_exchanged(hci_con_handle_t con_handle, uint16_t new_mtu);
105 
106 #if defined __cplusplus
107 }
108 #endif
109 
110 #endif // ATT_DISPATCH_H
111