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