Observer::Subscription Class Reference

A move-only handle representing a connection to a Publisher. More...

#include <Observer.h>

Collaboration diagram for Observer::Subscription:

Public Member Functions
	Subscription ()
	Subscription (Subscription &&)
Subscription &	operator= (Subscription &&)
	~Subscription () noexcept
	Calls Reset. More...
void	Reset () noexcept
	Breaks the connection (constant time) More...
bool	Expired () const
	operator bool () const

Private Member Functions
	Subscription (std::weak_ptr< detail::RecordBase > pRecord)

Private Attributes
std::weak_ptr< detail::RecordBase >	m_wRecord

Detailed Description

A move-only handle representing a connection to a Publisher.

Definition at line 70 of file Observer.h.

Constructor & Destructor Documentation

Subscription() [1/3]

Observer::Subscription::Subscription ( )

default

Subscription() [2/3]

Observer::Subscription::Subscription ( Subscription &&  )

default

~Subscription()

Observer::Subscription::~Subscription ( )

inlinenoexcept

Calls Reset.

Definition at line 77 of file Observer.h.

{ Reset(); }

Subscription() [3/3]

Observer::Subscription::Subscription ( std::weak_ptr< detail::RecordBase >  pRecord )

explicitprivate

Definition at line 86 of file Observer.cpp.

   : m_wRecord{ move(pRecord) } {}

Member Function Documentation

Expired()

bool Observer::Subscription::Expired ( ) const

inline

Returns

true iff there is no connection (Publisher was destroyed, or this was not reassigned since it was last Reset(), default-constructed, or moved from)

Definition at line 87 of file Observer.h.

{ return m_wRecord.expired(); }

operator bool()

Observer::Subscription::operator bool ( ) const

inlineexplicit

Returns

not expired

Definition at line 90 of file Observer.h.

{ return !Expired(); }

operator=()

Subscription & Observer::Subscription::operator=

(

Subscription &&

other

)

Definition at line 89 of file Observer.cpp.

{
   const bool inequivalent =
      m_wRecord.owner_before(other.m_wRecord) ||
      other.m_wRecord.owner_before(m_wRecord);
   if (inequivalent) {
      Reset();
      m_wRecord = move(other.m_wRecord);
   }
   return *this;
}

References m_wRecord, and Reset().

Here is the call graph for this function:

Reset()

void Observer::Subscription::Reset ( )

noexcept

Breaks the connection (constant time)

Definition at line 101 of file Observer.cpp.

{
   if (auto pRecord = m_wRecord.lock())
      pRecord->Unlink();
   m_wRecord.reset();
}

References m_wRecord.

Referenced by EffectUIHost::CleanupRealtime(), operator=(), RealtimeEffectListWindow::ResetTrack(), and RealtimeEffectListWindow::SetTrack().

Here is the caller graph for this function:

Member Data Documentation

m_wRecord

std::weak_ptr<detail::RecordBase> Observer::Subscription::m_wRecord

private

Definition at line 95 of file Observer.h.

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

---

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

• Observer.h
• Observer.cpp