Harald Welte | 43ab79f | 2018-10-03 23:34:21 +0200 | [diff] [blame] | 1 | /*- |
| 2 | * Copyright (c) 2006, 2007 Lev Walkin <vlm@lionet.info>. All rights reserved. |
| 3 | * Redistribution and modifications are permitted subject to BSD license. |
| 4 | */ |
| 5 | #ifndef _PER_ENCODER_H_ |
| 6 | #define _PER_ENCODER_H_ |
| 7 | |
| 8 | #include <asn_application.h> |
| 9 | #include <per_support.h> |
| 10 | |
| 11 | #ifdef __cplusplus |
| 12 | extern "C" { |
| 13 | #endif |
| 14 | |
| 15 | struct asn_TYPE_descriptor_s; /* Forward declaration */ |
| 16 | |
| 17 | /* |
| 18 | * Unaligned PER encoder of any ASN.1 type. May be invoked by the application. |
| 19 | * WARNING: This function returns the number of encoded bits in the .encoded |
| 20 | * field of the return value. Use the following formula to convert to bytes: |
| 21 | * bytes = ((.encoded + 7) / 8) |
| 22 | */ |
| 23 | asn_enc_rval_t uper_encode(struct asn_TYPE_descriptor_s *type_descriptor, |
| 24 | void *struct_ptr, /* Structure to be encoded */ |
| 25 | asn_app_consume_bytes_f *consume_bytes_cb, /* Data collector */ |
| 26 | void *app_key /* Arbitrary callback argument */ |
| 27 | ); |
| 28 | |
| 29 | /* |
| 30 | * A variant of uper_encode() which encodes data into the existing buffer |
| 31 | * WARNING: This function returns the number of encoded bits in the .encoded |
| 32 | * field of the return value. |
| 33 | */ |
| 34 | asn_enc_rval_t uper_encode_to_buffer( |
| 35 | struct asn_TYPE_descriptor_s *type_descriptor, |
| 36 | void *struct_ptr, /* Structure to be encoded */ |
| 37 | void *buffer, /* Pre-allocated buffer */ |
| 38 | size_t buffer_size /* Initial buffer size (max) */ |
| 39 | ); |
| 40 | |
| 41 | asn_enc_rval_t aper_encode_to_buffer( |
| 42 | struct asn_TYPE_descriptor_s *type_descriptor, |
| 43 | void *struct_ptr, /* Structure to be encoded */ |
| 44 | void *buffer, /* Pre-allocated buffer */ |
| 45 | size_t buffer_size /* Initial buffer size (max) */ |
| 46 | ); |
| 47 | /* |
| 48 | * A variant of uper_encode_to_buffer() which allocates buffer itself. |
| 49 | * Returns the number of bytes in the buffer or -1 in case of failure. |
| 50 | * WARNING: This function produces a "Production of the complete encoding", |
| 51 | * with length of at least one octet. Contrast this to precise bit-packing |
| 52 | * encoding of uper_encode() and uper_encode_to_buffer(). |
| 53 | */ |
| 54 | ssize_t uper_encode_to_new_buffer( |
| 55 | struct asn_TYPE_descriptor_s *type_descriptor, |
| 56 | asn_per_constraints_t *constraints, |
| 57 | void *struct_ptr, /* Structure to be encoded */ |
| 58 | void **buffer_r /* Buffer allocated and returned */ |
| 59 | ); |
| 60 | |
| 61 | ssize_t |
| 62 | aper_encode_to_new_buffer(struct asn_TYPE_descriptor_s *td, |
| 63 | asn_per_constraints_t *constraints, |
| 64 | void *sptr, |
| 65 | void **buffer_r); |
| 66 | /* |
| 67 | * Type of the generic PER encoder function. |
| 68 | */ |
| 69 | typedef asn_enc_rval_t (per_type_encoder_f)( |
| 70 | struct asn_TYPE_descriptor_s *type_descriptor, |
| 71 | asn_per_constraints_t *constraints, |
| 72 | void *struct_ptr, |
| 73 | asn_per_outp_t *per_output |
| 74 | ); |
| 75 | |
| 76 | #ifdef __cplusplus |
| 77 | } |
| 78 | #endif |
| 79 | |
| 80 | #endif /* _PER_ENCODER_H_ */ |