Bifrost SDK
Bifrost SDK documentation
Amino::StopCallback< Callback > Class Template Reference

A callback that can be attached to a StopToken. More...

#include <StopToken.h>

Inheritance diagram for Amino::StopCallback< Callback >:

Public Member Functions

 ~StopCallback ()=default
 Destructor. More...
 
template<typename C >
 StopCallback (StopToken const &token, C &&cb)
 Constructor. More...
 
template<typename C >
 StopCallback (StopToken &&token, C &&cb)
 Constructor. More...
 
 StopCallback (StopCallback const &)=delete
 StopCallback is not copyable nor movable. More...
 
 StopCallback (StopCallback &&) noexcept=delete
 StopCallback is not copyable nor movable. More...
 
StopCallbackoperator= (StopCallback const &)=delete
 StopCallback is not copyable nor movable. More...
 
StopCallbackoperator= (StopCallback &&) noexcept=delete
 StopCallback is not copyable nor movable. More...
 

Detailed Description

template<typename Callback>
class Amino::StopCallback< Callback >

A callback that can be attached to a StopToken.

Note
Essentially the same as std::stop_callback.

Definition at line 181 of file StopToken.h.

Constructor & Destructor Documentation

◆ StopCallback() [1/4]

template<typename Callback >
template<typename C >
Amino::StopCallback< Callback >::StopCallback ( StopToken const &  token,
C &&  cb 
)
inline

Constructor.

Definition at line 186 of file StopToken.h.

◆ StopCallback() [2/4]

template<typename Callback >
template<typename C >
Amino::StopCallback< Callback >::StopCallback ( StopToken &&  token,
C &&  cb 
)
inline

Constructor.

Definition at line 190 of file StopToken.h.

◆ StopCallback() [3/4]

template<typename Callback >
Amino::StopCallback< Callback >::StopCallback ( StopCallback< Callback > const &  )
delete

StopCallback is not copyable nor movable.

◆ StopCallback() [4/4]

template<typename Callback >
Amino::StopCallback< Callback >::StopCallback ( StopCallback< Callback > &&  )
deletenoexcept

StopCallback is not copyable nor movable.

◆ ~StopCallback()

template<typename Callback >
Amino::StopCallback< Callback >::~StopCallback ( )
default

Destructor.

Member Function Documentation

◆ operator=() [1/2]

template<typename Callback >
StopCallback & Amino::StopCallback< Callback >::operator= ( StopCallback< Callback > &&  )
deletenoexcept

StopCallback is not copyable nor movable.

◆ operator=() [2/2]

template<typename Callback >
StopCallback & Amino::StopCallback< Callback >::operator= ( StopCallback< Callback > const &  )
delete

StopCallback is not copyable nor movable.