WPILibC++ 2024.3.2
wpi::sig::ScopedConnection Class Reference

ScopedConnection is a RAII version of Connection It disconnects the slot from the signal upon destruction. More...

#include </home/runner/work/allwpilib/allwpilib/wpiutil/src/main/native/thirdparty/sigslot/include/wpi/Signal.h>

Inheritance diagram for wpi::sig::ScopedConnection:
wpi::sig::Connection

Public Member Functions

 ScopedConnection ()=default
 
 ~ScopedConnection ()
 
 ScopedConnection (const Connection &c) noexcept
 
 ScopedConnection (Connection &&c) noexcept
 
 ScopedConnection (const ScopedConnection &) noexcept=delete
 
ScopedConnectionoperator= (const ScopedConnection &) noexcept=delete
 
 ScopedConnection (ScopedConnection &&o) noexcept
 
ScopedConnectionoperator= (ScopedConnection &&o) noexcept
 
- Public Member Functions inherited from wpi::sig::Connection
 Connection ()=default
 
virtual ~Connection ()=default
 
 Connection (const Connection &) noexcept=default
 
Connectionoperator= (const Connection &) noexcept=default
 
 Connection (Connection &&) noexcept=default
 
Connectionoperator= (Connection &&) noexcept=default
 
bool valid () const noexcept
 
bool connected () const noexcept
 
bool disconnect () noexcept
 
bool blocked () const noexcept
 
void block () noexcept
 
void unblock () noexcept
 
ConnectionBlocker blocker () const noexcept
 

Friends

template<typename , typename... >
class SignalBase
 

Additional Inherited Members

- Protected Member Functions inherited from wpi::sig::Connection
 Connection (std::weak_ptr< detail::SlotState > s) noexcept
 
- Protected Attributes inherited from wpi::sig::Connection
std::weak_ptr< detail::SlotStatem_state
 

Detailed Description

ScopedConnection is a RAII version of Connection It disconnects the slot from the signal upon destruction.

Constructor & Destructor Documentation

◆ ScopedConnection() [1/5]

wpi::sig::ScopedConnection::ScopedConnection ( )
default

◆ ~ScopedConnection()

wpi::sig::ScopedConnection::~ScopedConnection ( )
inline

◆ ScopedConnection() [2/5]

wpi::sig::ScopedConnection::ScopedConnection ( const Connection c)
inlinenoexcept

◆ ScopedConnection() [3/5]

wpi::sig::ScopedConnection::ScopedConnection ( Connection &&  c)
inlinenoexcept

◆ ScopedConnection() [4/5]

wpi::sig::ScopedConnection::ScopedConnection ( const ScopedConnection )
deletenoexcept

◆ ScopedConnection() [5/5]

wpi::sig::ScopedConnection::ScopedConnection ( ScopedConnection &&  o)
inlinenoexcept

Member Function Documentation

◆ operator=() [1/2]

ScopedConnection & wpi::sig::ScopedConnection::operator= ( const ScopedConnection )
deletenoexcept

◆ operator=() [2/2]

ScopedConnection & wpi::sig::ScopedConnection::operator= ( ScopedConnection &&  o)
inlinenoexcept

Friends And Related Function Documentation

◆ SignalBase

template<typename , typename... >
friend class SignalBase
friend

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