hdk::grid::eps::Conduit< ArgTypes >::Tap Class Reference

#include <EPS.hpp>

Public Member Functions
	Tap ()=default
	Tap (const Tap &)=delete
Tap &	operator= (const Tap &)=delete
	Tap (Tap &&other) noexcept
Tap &	operator= (Tap &&other) noexcept
bool	IsActive () const
	Check if this subscription is still active.
bool	Detach ()
	Manually unsubscribe from the event.
bool	Pause ()
bool	Resume ()
bool	IsPaused () const

Friends
class	Conduit

Detailed Description

template<typename... ArgTypes>
class hdk::grid::eps::Conduit< ArgTypes >::Tap

Definition at line 21 of file EPS.hpp.

Constructor & Destructor Documentation

Tap() [1/3]

template<typename... ArgTypes>

hdk::grid::eps::Conduit< ArgTypes >::Tap::Tap ( )

default

Referenced by operator=(), operator=(), Tap(), and Tap().

Tap() [2/3]

template<typename... ArgTypes>

hdk::grid::eps::Conduit< ArgTypes >::Tap::Tap ( const Tap & )

delete

References Tap().

Tap() [3/3]

template<typename... ArgTypes>

hdk::grid::eps::Conduit< ArgTypes >::Tap::Tap ( Tap && other )

inlinenoexcept

Definition at line 26 of file EPS.hpp.

References Tap().

Member Function Documentation

Detach()

template<typename... ArgTypes>

bool hdk::grid::eps::Conduit< ArgTypes >::Tap::Detach ( )

inline

Manually unsubscribe from the event.

Removes this subscription from the dispatcher so the callback will no longer be invoked. Safe to call multiple times - subsequent calls return false.

Returns

true if unsubscription was successful, false if already unsubscribed

Definition at line 49 of file EPS.hpp.

Referenced by operator=().

IsActive()

template<typename... ArgTypes>

bool hdk::grid::eps::Conduit< ArgTypes >::Tap::IsActive ( ) const

inline

Check if this subscription is still active.

Returns

true if the subscription is active and will receive events, false otherwise

Note

A subscription becomes inactive after Detach() is called or the dispatcher is destroyed

Definition at line 40 of file EPS.hpp.

IsPaused()

template<typename... ArgTypes>

bool hdk::grid::eps::Conduit< ArgTypes >::Tap::IsPaused ( ) const

inline

Definition at line 96 of file EPS.hpp.

operator=() [1/2]

template<typename... ArgTypes>

Tap & hdk::grid::eps::Conduit< ArgTypes >::Tap::operator= ( const Tap & )

delete

References Tap().

operator=() [2/2]

template<typename... ArgTypes>

Tap & hdk::grid::eps::Conduit< ArgTypes >::Tap::operator= ( Tap && other )

inlinenoexcept

Definition at line 30 of file EPS.hpp.

References Detach(), and Tap().

Pause()

template<typename... ArgTypes>

bool hdk::grid::eps::Conduit< ArgTypes >::Tap::Pause ( )

inline

Definition at line 66 of file EPS.hpp.

Resume()

template<typename... ArgTypes>

bool hdk::grid::eps::Conduit< ArgTypes >::Tap::Resume ( )

inline

Definition at line 81 of file EPS.hpp.

Friends And Related Symbol Documentation

Conduit

template<typename... ArgTypes>

friend class Conduit

friend

Definition at line 110 of file EPS.hpp.

References Conduit.

Referenced by Conduit.

---

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

• include/hdk/grid/EPS.hpp
• src/AbstractEventDispatch.cpp