blob: e3b9190bfae38a15b30105c352472c11b3ed98f1 [file] [log] [blame]
Lev Walkin523de9e2006-08-18 01:34:18 +00001/*-
Lev Walkina2987ea2007-06-26 23:56:54 +00002 * Copyright (c) 2006, 2007 Lev Walkin <vlm@lionet.info>. All rights reserved.
Lev Walkin523de9e2006-08-18 01:34:18 +00003 * 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
12extern "C" {
13#endif
14
15struct asn_TYPE_descriptor_s; /* Forward declaration */
16
17/*
18 * Unaligned PER encoder of any ASN.1 type. May be invoked by the application.
Lev Walkin62258e22007-06-23 23:50:25 +000019 * 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)
Lev Walkin523de9e2006-08-18 01:34:18 +000022 */
23asn_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
Lev Walkin62258e22007-06-23 23:50:25 +000029/*
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 */
Lev Walkin523de9e2006-08-18 01:34:18 +000034asn_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
Harald Welte498c9712015-08-30 16:33:07 +020041asn_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);
Lev Walkin62258e22007-06-23 23:50:25 +000047/*
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",
Lev Walkina2987ea2007-06-26 23:56:54 +000051 * with length of at least one octet. Contrast this to precise bit-packing
Lev Walkin62258e22007-06-23 23:50:25 +000052 * encoding of uper_encode() and uper_encode_to_buffer().
53 */
54ssize_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);
Lev Walkin523de9e2006-08-18 01:34:18 +000060
Harald Welte498c9712015-08-30 16:33:07 +020061ssize_t
62aper_encode_to_new_buffer(struct asn_TYPE_descriptor_s *td,
63 asn_per_constraints_t *constraints,
64 void *sptr,
65 void **buffer_r);
Lev Walkin523de9e2006-08-18 01:34:18 +000066/*
67 * Type of the generic PER encoder function.
68 */
69typedef 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_ */