stream_budget.h

Go to the documentation of this file.

#ifndef NEXUS_STREAM_BUDGET_H
#define NEXUS_STREAM_BUDGET_H
#include "nexus/core/time.h"
#include "nexus/io/stream.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct {
    size_t capacity;
    size_t outstanding;
    size_t free_blocks;
    uint64_t epoch;
    uint32_t losses;
    bool next_free;
    bool stopping;
} nx_stream_observation_t;

nx_result_t nx_stream_observe(const nx_stream_t* stream,
                              nx_stream_observation_t* out);
typedef struct {
    uint64_t units_per_second;
    size_t units_per_block;
    size_t unit_bytes;
    nx_time_us_t release_delay_us;
    nx_time_us_t target_delay_us;
    size_t hardware_targets;
    size_t spare_blocks;
    size_t configured_blocks;
} nx_stream_budget_t;

typedef struct {
    size_t retained_blocks;
    size_t required_blocks;
    size_t required_payload_bytes;
    nx_time_us_t block_fill_us;
    bool capacity_sufficient;
    bool target_latency_sufficient;
} nx_stream_budget_result_t;

nx_result_t nx_stream_budget_calculate(const nx_stream_budget_t* budget,
                                       nx_stream_budget_result_t* out);
#ifdef __cplusplus
}
#endif
#endif