JoinBundleOptions Struct

Configuration for a JoinBundle stage executor. More...

Declaration

struct simaai::neat::graph::nodes::JoinBundleOptions { ... }

Included Headers

#include <JoinBundle.h>

Public Member Attributes Index

std::vector< std::string >	inputs
	Names of input ports participating in the join. More...
std::unordered_set< std::string >	required
	Inputs required for emission; default: all inputs. More...
JoinKeyPolicy	key_policy = JoinKeyPolicy::StreamFrame
	How samples are keyed for joining. More...
bool	emit_partial = false
	If true, emit a bundle even when only required inputs are present. More...
std::size_t	max_pending_keys = ...
	Upper bound on keys held in flight before evicting oldest. More...
int	timeout_ms = 0
	Per-key timeout (ms); 0 disables timeout-based eviction. More...

Description

Configuration for a JoinBundle stage executor.

Specifies the named input ports to join, which inputs are required for emission, the join key policy, and pending-bookkeeping bounds (max keys, optional timeout-based eviction).

Definition at line 45 of file JoinBundle.h.

Public Member Attributes

emit_partial

bool simaai::neat::graph::nodes::JoinBundleOptions::emit_partial = false

If true, emit a bundle even when only required inputs are present.

Definition at line 49 of file JoinBundle.h.

49 bool emit_partial = false;

inputs

std::vector<std::string> simaai::neat::graph::nodes::JoinBundleOptions::inputs

Names of input ports participating in the join.

Definition at line 46 of file JoinBundle.h.

46 std::vector<std::string> inputs;

key_policy

JoinKeyPolicy simaai::neat::graph::nodes::JoinBundleOptions::key_policy = JoinKeyPolicy::StreamFrame

How samples are keyed for joining.

Definition at line 48 of file JoinBundle.h.

48 JoinKeyPolicy key_policy = JoinKeyPolicy::StreamFrame;

max_pending_keys

std::size_t simaai::neat::graph::nodes::JoinBundleOptions::max_pending_keys

Upper bound on keys held in flight before evicting oldest.

Initialiser

= 4096

Definition at line 50 of file JoinBundle.h.

50 std::size_t max_pending_keys =

required

std::unordered_set<std::string> simaai::neat::graph::nodes::JoinBundleOptions::required

Inputs required for emission; default: all inputs.

Definition at line 47 of file JoinBundle.h.

47 std::unordered_set<std::string> required;

timeout_ms

int simaai::neat::graph::nodes::JoinBundleOptions::timeout_ms = 0

Per-key timeout (ms); 0 disables timeout-based eviction.

Definition at line 52 of file JoinBundle.h.

52 int timeout_ms = 0;

---

The documentation for this struct was generated from the following file:

• JoinBundle.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.