ud3tn/include/bundle7/serializer.h
Georg Alexander Murzik 298431c68f Insert SPDX license expression comments into our .c, .h, .py, and .sh code
ud3tn is available under multiple licenses and we want to reflect this in
our source code. But which license information should appear first and how
can we manage this efficiently in the future? The Linux Kernel uses SPDX
expressions instead of boilerplate sections. This seems to be a great
approach, so we do the same here.

Signed-off-by: Georg Alexander Murzik <georg.murzik@d3tn.com>
2022-02-20 16:24:38 +01:00

69 lines
1.5 KiB
C

// SPDX-License-Identifier: BSD-3-Clause OR Apache-2.0
#ifndef BUNDLE_V7_SERIALIZER_H_INCLUDED
#define BUNDLE_V7_SERIALIZER_H_INCLUDED
#include "bundle7/bundle7.h"
#include "ud3tn/bundle.h"
#include "ud3tn/crc.h"
#include "ud3tn/result.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
enum bundle7_serializer_status {
BUNDLE_V7_SERIALIZER_STATUS_RUNNING,
BUNDLE_V7_SERIALIZER_STATUS_FINISHED,
BUNDLE_V7_SERIALIZER_STATUS_ERROR
};
struct bundle7_serializer {
enum bundle7_serializer_status status;
/*
* Output buffer
*
* CBOR encoded data is written into this buffer.
*/
size_t filled;
size_t written;
uint8_t *buffer;
/*
* If raw bytes should be written directory to the output without
* copying them into the output buffer, this pointer and size are
* used to notify the serializer to use the raw bytes directly.
*/
uint8_t *raw;
size_t raw_bytes;
/*
* CRC stream calculator
*
* "skip_crc" is a flag telling the serializer to jump over the
* currently written bytes and not using them in the CRC calculus
*/
struct crc_stream crc;
bool skip_crc;
struct bundle_block_list *block_element;
// Callbacks
void (*callback)(struct bundle7_serializer *, struct bundle *);
void (*next_callback)(struct bundle7_serializer *, struct bundle *);
};
/**
* Creates CBOR-encoded byte stream of a Bundle v7
*/
enum ud3tn_result bundle7_serialize(
struct bundle *bundle,
void (*write)(void *cla_obj, const void *, const size_t),
void *cla_obj);
#endif /* BUNDLE_V7_SERIALIZER_H_INCLUDED */