The unique ID of a function registered with ProgressThread. Composed of the ProgressThread address and a sequential function index. More...

Public Member Functions
	FunctionID ()=default
	Construct a FunctionID with an invalid address. More...

constexpr	FunctionID (ProgressThreadAddress thread_addr, FunctionIndex index)
	Construct a new FunctionID. More...

constexpr bool	is_valid () const
	Check if the FunctionID is valid. More...

Public Attributes
ProgressThreadAddress	thread_address
	The address of the ProgressThread instance. More...

FunctionIndex	function_index {0}
	The sequential index of the function.

Detailed Description

The unique ID of a function registered with ProgressThread. Composed of the ProgressThread address and a sequential function index.

Definition at line 53 of file progress_thread.hpp.

Constructor & Destructor Documentation

rapidsmpf::ProgressThread::FunctionID::FunctionID ( )

default

Construct a FunctionID with an invalid address.

For a valid object the constructor that takes thread_addr and index must be used.

constexpr rapidsmpf::ProgressThread::FunctionID::FunctionID	(	ProgressThreadAddress	thread_addr,
		FunctionIndex	index
	)

inlineconstexpr

Construct a new FunctionID.

Parameters

thread_addr	The address of the ProgressThread instance
index	The sequential index of the function

Definition at line 75 of file progress_thread.hpp.

constexpr bool rapidsmpf::ProgressThread::FunctionID::is_valid ( ) const

inlineconstexpr

Check if the FunctionID is valid.

Definition at line 83 of file progress_thread.hpp.

ProgressThreadAddress rapidsmpf::ProgressThread::FunctionID::thread_address

Initial value:

{
            ProgressThreadAddress(0)
        }

The address of the ProgressThread instance.

Definition at line 54 of file progress_thread.hpp.

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