xref: /btstack/src/classic/sdp_client.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
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 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 SDP Client
40  *
41  */
42 
43 #ifndef SDP_CLIENT_H
44 #define SDP_CLIENT_H
45 
46 #include "btstack_config.h"
47 
48 #include "btstack_util.h"
49 
50 #if defined __cplusplus
51 extern "C" {
52 #endif
53 
54 /* API_START */
55 
56 typedef struct de_state {
57     uint8_t  in_state_GET_DE_HEADER_LENGTH ;
58     uint32_t addon_header_bytes;
59     uint32_t de_size;
60     uint32_t de_offset;
61 } de_state_t;
62 
63 void de_state_init(de_state_t * state);
64 int  de_state_size(uint8_t eventByte, de_state_t *de_state);
65 
66 /**
67  * @brief SDP Client Init
68  */
69 void sdp_client_init(void);
70 
71 /**
72  * @brief Checks if the SDP Client is ready
73  * @deprecated Please use sdp_client_register_query_callback instead
74  * @return true when no query is active
75  */
76 bool sdp_client_ready(void);
77 
78 /**
79  * @brief Requests a callback, when the SDP Client is ready and can be used
80  * @note The callback might happens before sdp_client_register_query_callback has returned
81  * @param callback_registration
82  */
83 uint8_t sdp_client_register_query_callback(btstack_context_callback_registration_t * callback_registration);
84 
85 /**
86  * @brief Queries the SDP service of the remote device given a service search pattern and a list of attribute IDs.
87  * The remote data is handled by the SDP parser. The SDP parser delivers attribute values and done event via the callback.
88  * @param callback for attributes values and done event
89  * @param remote address
90  * @param des_service_search_pattern
91  * @param des_attribute_id_list
92  */
93 uint8_t sdp_client_query(btstack_packet_handler_t callback, bd_addr_t remote, const uint8_t * des_service_search_pattern, const uint8_t * des_attribute_id_list);
94 
95 /*
96  * @brief Searches SDP records on a remote device for all services with a given UUID.
97  * @note calls sdp_client_query with service search pattern based on uuid16
98  */
99 uint8_t sdp_client_query_uuid16(btstack_packet_handler_t callback, bd_addr_t remote, uint16_t uuid16);
100 
101 /*
102  * @brief Searches SDP records on a remote device for all services with a given UUID.
103  * @note calls sdp_client_query with service search pattern based on uuid128
104  */
105 uint8_t sdp_client_query_uuid128(btstack_packet_handler_t callback, bd_addr_t remote, const uint8_t* uuid128);
106 
107 
108 /**
109  * @brief Retrieves all attribute IDs of a SDP record specified by its service record handle and a list of attribute IDs.
110  * The remote data is handled by the SDP parser. The SDP parser delivers attribute values and done event via the callback.
111  * @note only provided if ENABLE_SDP_EXTRA_QUERIES is defined
112  * @param callback for attributes values and done event
113  * @param remote address
114  * @param search_service_record_handle
115  * @param des_attributeIDList
116  */
117 uint8_t sdp_client_service_attribute_search(btstack_packet_handler_t callback, bd_addr_t remote, uint32_t search_service_record_handle, const uint8_t * des_attributeIDList);
118 
119 /**
120  * @brief Query the list of SDP records that match a given service search pattern.
121  * The remote data is handled by the SDP parser. The SDP parser delivers attribute values and done event via the callback.
122  * @note only provided if ENABLE_SDP_EXTRA_QUERIES is defined
123  * @param callback for attributes values and done event
124  * @param remote address
125  * @param des_service_search_pattern
126  */
127 uint8_t sdp_client_service_search(btstack_packet_handler_t callback, bd_addr_t remote, const uint8_t * des_service_search_pattern);
128 
129 #ifdef ENABLE_SDP_EXTRA_QUERIES
130 void sdp_client_parse_service_record_handle_list(uint8_t* packet, uint16_t total_count, uint16_t current_count);
131 #endif
132 
133 /**
134  * @brief De-Init SDP Client
135  */
136 void sdp_client_deinit(void);
137 
138 /* API_END */
139 
140 #if defined __cplusplus
141 }
142 #endif
143 
144 #endif // SDP_CLIENT_H
145