Skip to navigation

holoscan::authoring::OpaqueFlowRef

Beta
View as Markdown

Type-erase one typed Graph flow handle.

#include <holoscan/authoring/registry.hpp>

Constructors

OpaqueFlowRef

holoscan::authoring::OpaqueFlowRef::OpaqueFlowRef() = default

Create an empty flow reference.


Methods

graph_valid

bool holoscan::authoring::OpaqueFlowRef::graph_valid() const noexcept

Return whether the exact flow remains live.

Returns: true only while the source Graph owns the edge.

operator bool

holoscan::authoring::OpaqueFlowRef::operator bool() const noexcept

Return whether this reference resolves to a live flow.

validate_owner

void holoscan::authoring::OpaqueFlowRef::validate_owner(
Graph &graph
) const

Validate that one Graph owns this exact live flow.

Throws: RuntimeError with GRAPH_FLOW_HANDLE_INVALID for a foreign or stale flow.

queue_policy

OpaqueFlowRef & holoscan::authoring::OpaqueFlowRef::queue_policy(
QueuePolicy policy
)

Configure the authored finite-queue behavior.

Returns: This flow for fluent language-neutral authoring.

queue_depth

OpaqueFlowRef & holoscan::authoring::OpaqueFlowRef::queue_depth(
std::uint32_t depth
)

Configure a positive destination queue depth.

Returns: This flow for fluent language-neutral authoring.

topic_name

OpaqueFlowRef & holoscan::authoring::OpaqueFlowRef::topic_name(
std::string_view name
)

Configure the logical flow alias.

Returns: This flow for fluent language-neutral authoring.

memory_conversion

OpaqueFlowRef & holoscan::authoring::OpaqueFlowRef::memory_conversion(
)

Configure the Tensor memory-conversion request.

Returns: This flow for fluent language-neutral authoring.

max_inflight_samples

OpaqueFlowRef & holoscan::authoring::OpaqueFlowRef::max_inflight_samples(
std::uint32_t count
)

Configure a positive in-flight retention bound.

Returns: This flow for fluent language-neutral authoring.


Member variables

NameTypeDescription
state_std::weak_ptr< holoscan::detail::GraphState >
edge_EdgeId
source_GraphPortId
target_GraphPortId
handle_identity_std::shared_ptr< const void >