xref: /btstack/src/classic/sdp_client.h (revision bc37f7b0d0a3eaa5763a873c5730bc14b849aaa0)
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  *  sdp_client.h
40  */
41 
42 #ifndef __SDP_CLIENT_H
43 #define __SDP_CLIENT_H
44 
45 #include "btstack_config.h"
46 
47 #include "btstack_util.h"
48 
49 #if defined __cplusplus
50 extern "C" {
51 #endif
52 
53 /* API_START */
54 
55 typedef struct de_state {
56     uint8_t  in_state_GET_DE_HEADER_LENGTH ;
57     uint32_t addon_header_bytes;
58     uint32_t de_size;
59     uint32_t de_offset;
60 } de_state_t;
61 
62 void de_state_init(de_state_t * state);
63 int  de_state_size(uint8_t eventByte, de_state_t *de_state);
64 
65 /**
66  * @brief Checks if the SDP Client is ready
67  * @return 1 when no query is active
68  */
69 int sdp_client_ready(void);
70 
71 /**
72  * @brief Queries the SDP service of the remote device given a service search pattern and a list of attribute IDs.
73  * The remote data is handled by the SDP parser. The SDP parser delivers attribute values and done event via the callback.
74  * @param callback for attributes values and done event
75  * @param remote address
76  * @param des_service_search_pattern
77  * @param des_attribute_id_list
78  */
79 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);
80 
81 /*
82  * @brief Searches SDP records on a remote device for all services with a given UUID.
83  * @note calls sdp_client_query with service search pattern based on uuid16
84  */
85 uint8_t sdp_client_query_uuid16(btstack_packet_handler_t callback, bd_addr_t remote, uint16_t uuid16);
86 
87 /*
88  * @brief Searches SDP records on a remote device for all services with a given UUID.
89  * @note calls sdp_client_query with service search pattern based on uuid128
90  */
91 uint8_t sdp_client_query_uuid128(btstack_packet_handler_t callback, bd_addr_t remote, const uint8_t* uuid128);
92 
93 
94 /**
95  * @brief Retrieves all attribute IDs of a SDP record specified by its service record handle and a list of attribute IDs.
96  * The remote data is handled by the SDP parser. The SDP parser delivers attribute values and done event via the callback.
97  * @note only provided if ENABLE_SDP_EXTRA_QUERIES is defined
98  * @param callback for attributes values and done event
99  * @param remote address
100  * @param search_service_record_handle
101  * @param des_attributeIDList
102  */
103 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);
104 
105 /**
106  * @brief Query the list of SDP records that match a given service search pattern.
107  * The remote data is handled by the SDP parser. The SDP parser delivers attribute values and done event via the callback.
108  * @note only provided if ENABLE_SDP_EXTRA_QUERIES is defined
109  * @param callback for attributes values and done event
110  * @param remote address
111  * @param des_service_search_pattern
112  */
113 uint8_t sdp_client_service_search(btstack_packet_handler_t callback, bd_addr_t remote, const uint8_t * des_service_search_pattern);
114 
115 
116 /* API_END */
117 
118 #if defined __cplusplus
119 }
120 #endif
121 
122 #endif // __SDP_CLIENT_H
123