xref: /btstack/src/classic/sdp_server.h (revision e9d8dc8bd8076b7b89b9c4687764374e98e2f843)
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 Server
40  *
41  */
42 
43 #ifndef SDP_H
44 #define SDP_H
45 
46 #include <stdint.h>
47 #include "btstack_linked_list.h"
48 
49 #include "btstack_config.h"
50 
51 #if defined __cplusplus
52 extern "C" {
53 #endif
54 
55 typedef struct {
56     // linked list - assert: first field
57     btstack_linked_item_t   item;
58 
59     uint32_t        service_record_handle;
60     uint8_t *       service_record;
61 } service_record_item_t;
62 
63 int sdp_handle_service_search_request(uint8_t * packet, uint16_t remote_mtu);
64 int sdp_handle_service_attribute_request(uint8_t * packet, uint16_t remote_mtu);
65 int sdp_handle_service_search_attribute_request(uint8_t * packet, uint16_t remote_mtu);
66 
67 /* API_START */
68 
69 /**
70  * @brief Set up SDP Server.
71  */
72 void sdp_init(void);
73 
74 /**
75  * @brief Register Service Record with database using ServiceRecordHandle stored in record
76  * @pre AttributeIDs are in ascending order
77  * @pre ServiceRecordHandle is first attribute and valid
78  * @param record is not copied!
79  * @result status
80  */
81 uint8_t sdp_register_service(const uint8_t * record);
82 
83 /**
84  * @brief Unregister service record internally.
85  */
86 void sdp_unregister_service(uint32_t service_record_handle);
87 
88 /**
89  * @brief gets service record handle from record
90  * @resutl service record handle or 0
91  */
92 uint32_t sdp_get_service_record_handle(const uint8_t * record);
93 
94 /**
95  * @brief Finds an unused valid service record handle
96  * @result handle
97  */
98 uint32_t sdp_create_service_record_handle(void);
99 
100 /**
101  * @brief gets record for handle
102  * @result record
103  */
104 
105 uint8_t * sdp_get_record_for_handle(uint32_t handle);
106 
107 /**
108  * @brief De-Init SDP Server
109  */
110 void sdp_deinit(void);
111 
112 /* API_END */
113 
114 #ifdef ENABLE_TESTING_SUPPORT
115 void sdp_server_set_single_record_response(bool enabled);
116 #endif
117 
118 
119 #if defined __cplusplus
120 }
121 #endif
122 #endif // SDP_H
123