ud3tn/include/bundle7/create.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

30 lines
1.2 KiB
C

// SPDX-License-Identifier: BSD-3-Clause OR Apache-2.0
#ifndef BUNDLE7_CREATE_H_INCLUDED
#define BUNDLE7_CREATE_H_INCLUDED
#include "ud3tn/bundle.h"
#include <stddef.h>
#include <stdint.h>
/**
* Creates a local BPv7-bis bundle using the specified parameters.
*
* @param payload The binary payload data which should be encapsulated.
* Memory management will be taken over by the bundle handling
* functions. In case of errors, the memory is freed.
* @param payload_length The length of the payload data.
* @param source The source EID the created bundle originated from.
* @param destination The destination EID the bundle is addressed to.
* @param creation_time_s The bundle creation timestamp (a DTN timestamp in seconds).
* @param sequence_number The bundle sequence number.
* @param lifetime The bundle lifetime, in seconds.
* @param proc_flags Additional processing flags to be set for the bundle.
*/
struct bundle *bundle7_create_local(
void *payload, size_t payload_length,
const char *source, const char *destination,
uint64_t creation_time_s, uint64_t sequence_number, uint64_t lifetime_s,
enum bundle_proc_flags proc_flags);
#endif // BUNDLE7_CREATE_H_INCLUDED