Castor3D 0.16.0
Multiplatform 3D engine
Public Member Functions | List of all members
castor::TSConnectionT< SignalT > Class Template Reference

Connection to a thread safe signal. More...

#include <ThreadSafeSignal.hpp>

Inheritance diagram for castor::TSConnectionT< SignalT >:
Inheritance graph
[legend]
Collaboration diagram for castor::TSConnectionT< SignalT >:
Collaboration graph
[legend]

Public Member Functions

 TSConnectionT ()
 Constructor.
 
 TSConnectionT (uint32_t connection, my_signal &signal)
 Constructor.
 
 TSConnectionT (TSConnectionT< my_signal > &&rhs) noexcept
 Move constructor.
 
TSConnectionToperator= (TSConnectionT< my_signal > &&rhs) noexcept
 Move assignment operator.
 
 ~TSConnectionT () noexcept
 Destructor.
 
bool disconnect () noexcept
 Disconnects the function from the signal.
 
 operator bool () const noexcept
 

Additional Inherited Members

- Protected Member Functions inherited from castor::NonCopyable
 NonCopyable ()=default
 Constructor.
 
 ~NonCopyable () noexcept=default
 Destructor.
 

Detailed Description

template<typename SignalT>
class castor::TSConnectionT< SignalT >

Connection to a thread safe signal.

Constructor & Destructor Documentation

◆ TSConnectionT() [1/3]

template<typename SignalT >
castor::TSConnectionT< SignalT >::TSConnectionT ( )
inline

Constructor.

◆ TSConnectionT() [2/3]

template<typename SignalT >
castor::TSConnectionT< SignalT >::TSConnectionT ( uint32_t connection,
my_signal & signal )
inline

Constructor.

Parameters
[in]connectionThe connection to the signal.
[in]signalThe signal.

References castor::makeStringStream().

Here is the call graph for this function:

◆ TSConnectionT() [3/3]

template<typename SignalT >
castor::TSConnectionT< SignalT >::TSConnectionT ( TSConnectionT< my_signal > && rhs)
inlinenoexcept

Move constructor.

Parameters
[in,out]rhsThe object to move.

◆ ~TSConnectionT()

template<typename SignalT >
castor::TSConnectionT< SignalT >::~TSConnectionT ( )
inlinenoexcept

Destructor.

Remarks
Disconnects the function from the signal.

References castor::TSConnectionT< SignalT >::disconnect(), and castor::makeUniqueLock().

Here is the call graph for this function:

Member Function Documentation

◆ disconnect()

template<typename SignalT >
bool castor::TSConnectionT< SignalT >::disconnect ( )
inlinenoexcept

Disconnects the function from the signal.

Referenced by castor::TSConnectionT< SignalT >::operator=(), and castor::TSConnectionT< SignalT >::~TSConnectionT().

Here is the caller graph for this function:

◆ operator bool()

template<typename SignalT >
castor::TSConnectionT< SignalT >::operator bool ( ) const
inlinenoexcept

◆ operator=()

template<typename SignalT >
TSConnectionT & castor::TSConnectionT< SignalT >::operator= ( TSConnectionT< my_signal > && rhs)
inlinenoexcept

Move assignment operator.

Parameters
[in,out]rhsThe object to move.

References castor::TSConnectionT< SignalT >::disconnect().

Here is the call graph for this function:

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