holoscan::ChannelSampleDescriptor

Beta

Fixed-size descriptor carried through the channel transport-control plane.

This descriptor is identity and metadata, not the buffer itself. For same-process tensor/buffer channels, Holoscan Runtime resolves sidecar_token against a runtime-owned sidecar store. The private transport carries only this POD value and does not resolve the token.

#include <holoscan/types.hpp>

Methods

has_supported_abi

bool holoscan::ChannelSampleDescriptor::has_supported_abi() const noexcept

Return whether the descriptor uses the ABI compiled into this Core build.

operator bool

holoscan::ChannelSampleDescriptor::operator bool() const noexcept

Return whether the descriptor is non-empty and ABI-compatible.

Member variables

Name	Type	Description
`magic`	`std::uint32_t`	Descriptor magic. Receivers reject descriptors with a different value.
`abi_version`	`std::uint16_t`	Descriptor ABI version.
`payload_kind`	`ChannelPayloadKind`	Payload representation selected by graph finalization.
`flags`	`std::uint32_t`	Runtime-defined flags. The private transport does not interpret these bits.
`expected_recipient_count`	`std::uint32_t`	Number of recipients expected to observe this descriptor.
`process_id`	`std::uint64_t`	Origin process id used as a safety check for same-process descriptors.
`sidecar_token`	`std::uint64_t`	Runtime-owned sidecar token. Zero is reserved for an empty descriptor.
`generation`	`std::uint64_t`	ABA-protection generation for the sidecar record.
`schema_id`	`SchemaId`	Complete compact schema identity for schema-backed payloads.
`sequence`	`std::uint64_t`	Producer sequence number.
`byte_size`	`std::uint64_t`	Logical payload byte size.