xref: /btstack/src/classic/obex_iterator.h (revision 7dc86dfd3569d69491d87d64749fd45afb46c67a)
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 #ifndef __OBEX_ITERATOR_H
39 
40 #if defined __cplusplus
41 extern "C" {
42 #endif
43 
44 #include <stdint.h>
45 
46 /* API_START */
47 
48 typedef struct obex_iterator {
49      const uint8_t * data;
50      uint8_t   offset;
51      uint8_t   length;
52 } obex_iterator_t;
53 
54 // OBEX packet header iterator
55 void obex_iterator_init_with_request_packet(obex_iterator_t *context, const uint8_t * packet_data, uint16_t packet_len);
56 void obex_iterator_init_with_response_packet(obex_iterator_t *context, uint8_t request_opcode, const uint8_t * packet_data, uint16_t packet_len);
57 int  obex_iterator_has_more(const obex_iterator_t * context);
58 void obex_iterator_next(obex_iterator_t * context);
59 
60 // OBEX packet header access functions
61 // @note BODY/END-OF-BODY headers might be incomplete
62 uint8_t         obex_iterator_get_hi(const obex_iterator_t * context);
63 uint8_t         obex_iterator_get_data_8(const obex_iterator_t * context);
64 uint32_t        obex_iterator_get_data_32(const obex_iterator_t * context);
65 uint32_t        obex_iterator_get_data_len(const obex_iterator_t * context);
66 const uint8_t * obex_iterator_get_data(const obex_iterator_t * context);
67 
68 /* API_END */
69 
70 // debug
71 void            obex_dump_packet(uint8_t request_opcode, uint8_t * packet, uint16_t size);
72 
73 #if defined __cplusplus
74 }
75 #endif
76 #endif
77