Update README.

[stg.git] / libs / smux / include / stg / per_encoder.h

diff --git a/libs/smux/include/stg/per_encoder.h b/libs/smux/include/stg/per_encoder.h
index 9ac130b7373cc354effd24058027ea85ca3a9e59..44d8e8ac62fdac9d0026642e61544aaa2d8f2168 100644 (file)
--- a/libs/smux/include/stg/per_encoder.h
+++ b/libs/smux/include/stg/per_encoder.h
@@ -1,5 +1,5 @@
 /*-
- * Copyright (c) 2006 Lev Walkin <vlm@lionet.info>. All rights reserved.
+ * Copyright (c) 2006-2017 Lev Walkin <vlm@lionet.info>. All rights reserved.
  * Redistribution and modifications are permitted subject to BSD license.
  */
 #ifndef        _PER_ENCODER_H_
@@ -16,31 +16,52 @@ struct asn_TYPE_descriptor_s;       /* Forward declaration */
 
 /*
  * Unaligned PER encoder of any ASN.1 type. May be invoked by the application.
+ * WARNING: This function returns the number of encoded bits in the .encoded
+ * field of the return value. Use the following formula to convert to bytes:
+ *     bytes = ((.encoded + 7) / 8)
  */
-asn_enc_rval_t uper_encode(struct asn_TYPE_descriptor_s *type_descriptor,
-       void *struct_ptr,       /* Structure to be encoded */
-       asn_app_consume_bytes_f *consume_bytes_cb,      /* Data collector */
-       void *app_key           /* Arbitrary callback argument */
+asn_enc_rval_t uper_encode(
+    const struct asn_TYPE_descriptor_s *type_descriptor,
+    const asn_per_constraints_t *constraints,
+    const void *struct_ptr,                    /* Structure to be encoded */
+    asn_app_consume_bytes_f *consume_bytes_cb, /* Data collector */
+    void *app_key                              /* Arbitrary callback argument */
 );
 
-/* A variant of uper_encode() which encodes data into the existing buffer */
+/*
+ * A variant of uper_encode() which encodes data into the existing buffer
+ * WARNING: This function returns the number of encoded bits in the .encoded
+ * field of the return value.
+ */
 asn_enc_rval_t uper_encode_to_buffer(
-       struct asn_TYPE_descriptor_s *type_descriptor,
-       void *struct_ptr,       /* Structure to be encoded */
-       void *buffer,           /* Pre-allocated buffer */
-       size_t buffer_size      /* Initial buffer size (max) */
+    const struct asn_TYPE_descriptor_s *type_descriptor,
+    const asn_per_constraints_t *constraints,
+    const void *struct_ptr, /* Structure to be encoded */
+    void *buffer,           /* Pre-allocated buffer */
+    size_t buffer_size      /* Initial buffer size (max) */
 );
 
+/*
+ * A variant of uper_encode_to_buffer() which allocates buffer itself.
+ * Returns the number of bytes in the buffer or -1 in case of failure.
+ * WARNING: This function produces a "Production of the complete encoding",
+ * with length of at least one octet. Contrast this to precise bit-packing
+ * encoding of uper_encode() and uper_encode_to_buffer().
+ */
+ssize_t uper_encode_to_new_buffer(
+    const struct asn_TYPE_descriptor_s *type_descriptor,
+    const asn_per_constraints_t *constraints,
+    const void *struct_ptr, /* Structure to be encoded */
+    void **buffer_r         /* Buffer allocated and returned */
+);
 
 /*
  * Type of the generic PER encoder function.
  */
-typedef asn_enc_rval_t (per_type_encoder_f)(
-       struct asn_TYPE_descriptor_s *type_descriptor,
-       asn_per_constraints_t *constraints,
-       void *struct_ptr,
-       asn_per_outp_t *per_output
-);
+typedef asn_enc_rval_t(per_type_encoder_f)(
+    const struct asn_TYPE_descriptor_s *type_descriptor,
+    const asn_per_constraints_t *constraints, const void *struct_ptr,
+    asn_per_outp_t *per_output);
 
 #ifdef __cplusplus
 }