Public Member Functions | Public Attributes | List of all members
rapidsmpf::streaming::ChannelMetadata Struct Reference

Channel-level metadata describing the data stream. More...

#include <channel_metadata.hpp>

Public Member Functions

 ChannelMetadata ()=default
 Default constructor.
 
 ChannelMetadata (std::uint64_t local_count, Partitioning partitioning={}, bool duplicated=false)
 Construct metadata with specified values. More...
 

Public Attributes

std::uint64_t local_count {}
 Local chunk-count estimate for this rank.
 
Partitioning partitioning
 How the data is partitioned.
 
bool duplicated {}
 Whether data is duplicated on all workers.
 

Detailed Description

Channel-level metadata describing the data stream.

Contains information about chunk counts, partitioning, and duplication status for the data flowing through a channel.

Definition at line 219 of file channel_metadata.hpp.

Constructor & Destructor Documentation

◆ ChannelMetadata()

rapidsmpf::streaming::ChannelMetadata::ChannelMetadata ( std::uint64_t  local_count,
Partitioning  partitioning = {},
bool  duplicated = false 
)
inline

Construct metadata with specified values.

Parameters
local_countLocal chunk count.
partitioningPartitioning metadata (default: no partitioning).
duplicatedWhether data is duplicated (default: false).

Definition at line 234 of file channel_metadata.hpp.


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