blob: 6a7b68125c42f68e87d509cde15e032d9e9b684d [file] [log] [blame]
anjana_sreekumar@infosys.com991c2062020-01-08 11:42:57 +05301/*
2 * Copyright (c) 2017 Lev Walkin <vlm@lionet.info>. All rights reserved.
3 * Redistribution and modifications are permitted subject to BSD license.
4 */
5#ifndef OER_ENCODER_H
6#define OER_ENCODER_H
7
8#include <asn_application.h>
9
10#ifdef __cplusplus
11extern "C" {
12#endif
13
14struct asn_TYPE_descriptor_s; /* Forward declaration */
15
16/*
17 * The Octet Encoding Rules (OER, X.696 08/2015) encoder for any type.
18 * This function may be invoked directly by the application.
19 * Produces CANONICAL-OER output compatible with CANONICAL-OER
20 * and BASIC-OER decoders.
21 */
22asn_enc_rval_t oer_encode(const struct asn_TYPE_descriptor_s *type_descriptor,
23 const void *struct_ptr, /* Structure to be encoded */
24 asn_app_consume_bytes_f *consume_bytes_cb,
25 void *app_key /* Arbitrary callback argument */
26);
27
28/* A variant of oer_encode() which encodes data into the pre-allocated buffer */
29asn_enc_rval_t oer_encode_to_buffer(
30 const struct asn_TYPE_descriptor_s *type_descriptor,
31 const asn_oer_constraints_t *constraints,
32 const void *struct_ptr, /* Structure to be encoded */
33 void *buffer, /* Pre-allocated buffer */
34 size_t buffer_size /* Initial buffer size (maximum) */
35);
36
37/*
38 * Type of the generic OER encoder.
39 */
40typedef asn_enc_rval_t(oer_type_encoder_f)(
41 const struct asn_TYPE_descriptor_s *type_descriptor,
42 const asn_oer_constraints_t *constraints,
43 const void *struct_ptr, /* Structure to be encoded */
44 asn_app_consume_bytes_f *consume_bytes_cb, /* Callback */
45 void *app_key /* Arbitrary callback argument */
46);
47
48/*
49 * Write out the Open Type (X.696 (08/2015), #30).
50 * RETURN VALUES:
51 * -1: Fatal error encoding the type.
52 * >0: Number of bytes serialized.
53 */
54ssize_t oer_open_type_put(const struct asn_TYPE_descriptor_s *td,
55 const asn_oer_constraints_t *constraints,
56 const void *struct_ptr,
57 asn_app_consume_bytes_f *consume_bytes_cb,
58 void *app_key);
59
60
61/*
62 * Length-prefixed buffer encoding for primitive types.
63 */
64oer_type_encoder_f oer_encode_primitive;
65
66#ifdef __cplusplus
67}
68#endif
69
70#endif /* OER_ENCODER_H */