ThreadSchedule 1.0.0
Modern C++ thread management library
Loading...
Searching...
No Matches
threadschedule::ScheduledTaskHandle Class Reference

Handle for scheduled tasks that can be used to cancel them. More...

#include <scheduled_pool.hpp>

Public Member Functions

 ScheduledTaskHandle (uint64_t id)
void cancel ()
auto is_cancelled () const -> bool
auto id () const -> uint64_t

Friends

template<typename>
class ScheduledThreadPoolT

Detailed Description

Handle for scheduled tasks that can be used to cancel them.

Definition at line 19 of file scheduled_pool.hpp.

Constructor & Destructor Documentation

◆ ScheduledTaskHandle()

threadschedule::ScheduledTaskHandle::ScheduledTaskHandle ( uint64_t id)
inlineexplicit

Definition at line 22 of file scheduled_pool.hpp.

Member Function Documentation

◆ cancel()

void threadschedule::ScheduledTaskHandle::cancel ( )
inline

Definition at line 26 of file scheduled_pool.hpp.

◆ id()

auto threadschedule::ScheduledTaskHandle::id ( ) const -> uint64_t
inlinenodiscard

Definition at line 36 of file scheduled_pool.hpp.

◆ is_cancelled()

auto threadschedule::ScheduledTaskHandle::is_cancelled ( ) const -> bool
inlinenodiscard

Definition at line 31 of file scheduled_pool.hpp.

◆ ScheduledThreadPoolT

template<typename>
friend class ScheduledThreadPoolT
friend

Definition at line 46 of file scheduled_pool.hpp.


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