]> git.stg.codes - stg.git/blob - stglibs/smux.lib/include/stg/ber_decoder.h
Merge branch 'stg-2.409' into stg-2.409-radius
[stg.git] / stglibs / smux.lib / include / stg / ber_decoder.h
1 /*-
2  * Copyright (c) 2003, 2004 Lev Walkin <vlm@lionet.info>. All rights reserved.
3  * Redistribution and modifications are permitted subject to BSD license.
4  */
5 #ifndef _BER_DECODER_H_
6 #define _BER_DECODER_H_
7
8 #include <asn_application.h>
9
10 #ifdef __cplusplus
11 extern "C" {
12 #endif
13
14 struct asn_TYPE_descriptor_s;   /* Forward declaration */
15 struct asn_codec_ctx_s;         /* Forward declaration */
16
17 /*
18  * The BER decoder of any type.
19  * This function may be invoked directly from the application.
20  */
21 asn_dec_rval_t ber_decode(struct asn_codec_ctx_s *opt_codec_ctx,
22         struct asn_TYPE_descriptor_s *type_descriptor,
23         void **struct_ptr,      /* Pointer to a target structure's pointer */
24         const void *buffer,     /* Data to be decoded */
25         size_t size             /* Size of that buffer */
26         );
27
28 /*
29  * Type of generic function which decodes the byte stream into the structure.
30  */
31 typedef asn_dec_rval_t (ber_type_decoder_f)(
32                 struct asn_codec_ctx_s *opt_codec_ctx,
33                 struct asn_TYPE_descriptor_s *type_descriptor,
34                 void **struct_ptr, const void *buf_ptr, size_t size,
35                 int tag_mode);
36
37 /*******************************
38  * INTERNALLY USEFUL FUNCTIONS *
39  *******************************/
40
41 /*
42  * Check that all tags correspond to the type definition (as given in head).
43  * On return, last_length would contain either a non-negative length of the
44  * value part of the last TLV, or the negative number of expected
45  * "end of content" sequences. The number may only be negative if the
46  * head->last_tag_form is non-zero.
47  */
48 asn_dec_rval_t ber_check_tags(
49                 struct asn_codec_ctx_s *opt_codec_ctx,  /* codec options */
50                 struct asn_TYPE_descriptor_s *type_descriptor,
51                 asn_struct_ctx_t *opt_ctx,      /* saved decoding context */
52                 const void *ptr, size_t size,
53                 int tag_mode,           /* {-1,0,1}: IMPLICIT, no, EXPLICIT */
54                 int last_tag_form,      /* {-1,0:1}: any, primitive, constr */
55                 ber_tlv_len_t *last_length,
56                 int *opt_tlv_form       /* optional tag form */
57         );
58
59 #ifdef __cplusplus
60 }
61 #endif
62
63 #endif  /* _BER_DECODER_H_ */