Warning: This is a development version. The latest stable version is Version 7.0.0.

Functions

uint64_t packet_sequence_number (const uint8_t * packet)
uint64_t packet_stream_lower_bound (const uint8_t * packet)
uint64_t packet_window_symbols (const uint8_t * packet)
uint64_t packet_window_offset (const uint8_t * packet)
bool is_packet_repair (const uint8_t * packet)
std::string version ()

auto packet_sequence_number (const uint8_t * packet) -> uint64_t

Read and return the packet’s sequence number. See Header Format.

Parameter packet:
Pointer to the packet data

Scope: rely

In header: #include <rely/packet.hpp>


auto packet_stream_lower_bound (const uint8_t * packet) -> uint64_t

Read and return the stream lower-bound. This is the index of the “oldest” available symbol on the encoder. See Header Format.

Parameter packet:
Pointer to the packet data

Scope: rely

In header: #include <rely/packet.hpp>


auto packet_window_symbols (const uint8_t * packet) -> uint64_t

Read and return the number of symbols in the coding window. If this function returns 1 it means that we contain a specific source symbol (i.e the packet is systematic). See Header Format.

Parameter packet:
Pointer to the packet data

Scope: rely

In header: #include <rely/packet.hpp>


auto packet_window_offset (const uint8_t * packet) -> uint64_t

Read and return the offset from the stream lower bound to the beginning of the coding window. This function is only valid for systematic packets. See Header Format.

Parameter packet:
Pointer to the packet data

Scope: rely

In header: #include <rely/packet.hpp>


auto is_packet_repair (const uint8_t * packet) -> bool

Read and return whether the packet is repair. Repair packets are results of combining source symbols (Linear combination). Non-repair packets on the other hand are systematic packets. Which consist of a single source symbol. See:ref:design/header_format:Header Format.

Parameter packet:
Pointer to the packet data

Scope: rely

In header: #include <rely/packet.hpp>


std::string version ()
Returns:
The version of the library as a string

Scope: rely

In header: #include <rely/version.hpp>