#include <observable.h>

Inheritance diagram for UTIL::OBSERVABLE< ObserverInterface >:

Public Member Functions
	OBSERVABLE ()
	Construct an observable with empty non-shared subscription list. More...

	OBSERVABLE (OBSERVABLE &aInherit)
	Construct an observable with a shared subscription list. More...

void	SubscribeUnmanaged (ObserverInterface *aObserver)
	Add a subscription without RAII link. More...

LINK	Subscribe (ObserverInterface *aObserver)
	Add a subscription returning an RAII link. More...

void	Unsubscribe (ObserverInterface *aObserver)
	Cancel the subscription of a subscriber. More...

template<typename... Args1, typename... Args2>
void	Notify (void(ObserverInterface::*Ptr)(Args1...), Args2 &&... aArgs)
	Notify event to all subscribed observers. More...

template<typename... Args1, typename... Args2>
void	NotifyIgnore (void(ObserverInterface::Ptr)(Args1...), ObserverInterface aIgnore, Args2 &&... aArgs)
	Notify event to all subscribed observers but one to be ignore. More...

size_t	size () const

Protected Member Functions
void	on_observers_empty ()

void	enter_iteration ()

void	leave_iteration ()

void	add_observer (void *observer)

void	remove_observer (void *observer)

Protected Attributes
std::shared_ptr< IMPL >	impl_

Private Member Functions
void	allocate_impl ()

void	allocate_shared_impl ()

void	deallocate_impl ()

std::shared_ptr< IMPL >	get_shared_impl ()

Detailed Description

template<typename ObserverInterface>
class UTIL::OBSERVABLE< ObserverInterface >

Definition at line 126 of file observable.h.

Constructor & Destructor Documentation

◆ OBSERVABLE() [1/2]

template<typename ObserverInterface >

UTIL::OBSERVABLE< ObserverInterface >::OBSERVABLE ( )

inline

Construct an observable with empty non-shared subscription list.

Definition at line 132 of file observable.h.

132{}

◆ OBSERVABLE() [2/2]

template<typename ObserverInterface >

UTIL::OBSERVABLE< ObserverInterface >::OBSERVABLE ( OBSERVABLE< ObserverInterface > & aInherit )

inline

Construct an observable with a shared subscription list.

Parameters

aInherit Observable to share the subscription list with.

Definition at line 139 of file observable.h.

139: OBSERVABLE_BASE( aInherit ) {}

UTIL::DETAIL::OBSERVABLE_BASE::OBSERVABLE_BASE

OBSERVABLE_BASE()

Definition: observable.cpp:172

Member Function Documentation

◆ add_observer()

void UTIL::DETAIL::OBSERVABLE_BASE::add_observer ( void * observer )

protectedinherited

Definition at line 216 of file observable.cpp.

 {
 allocate_impl();
 impl_->add_observer( observer );
 }

References UTIL::DETAIL::OBSERVABLE_BASE::allocate_impl(), and UTIL::DETAIL::OBSERVABLE_BASE::impl_.

◆ allocate_impl()

void UTIL::DETAIL::OBSERVABLE_BASE::allocate_impl ( )

privateinherited

Definition at line 188 of file observable.cpp.

 {
 if(!impl_)
 impl_ = std::make_shared<IMPL>( this );
 }

References UTIL::DETAIL::OBSERVABLE_BASE::impl_.

Referenced by UTIL::DETAIL::OBSERVABLE_BASE::add_observer().

◆ allocate_shared_impl()

void UTIL::DETAIL::OBSERVABLE_BASE::allocate_shared_impl ( )

privateinherited

Definition at line 195 of file observable.cpp.

 {
 if(!impl_)
 impl_ = std::make_shared<IMPL>();
 else
 impl_->set_shared();
 }

References UTIL::DETAIL::OBSERVABLE_BASE::impl_.

Referenced by UTIL::DETAIL::OBSERVABLE_BASE::get_shared_impl().

◆ deallocate_impl()

void UTIL::DETAIL::OBSERVABLE_BASE::deallocate_impl ( )

privateinherited

Definition at line 204 of file observable.cpp.

 {
 impl_.reset();
 }

References UTIL::DETAIL::OBSERVABLE_BASE::impl_.

Referenced by UTIL::DETAIL::OBSERVABLE_BASE::on_observers_empty().

◆ enter_iteration()

void UTIL::DETAIL::OBSERVABLE_BASE::enter_iteration ( )

protectedinherited

Definition at line 230 of file observable.cpp.

 {
 if( impl_ )
 impl_->enter_iteration();
 }

References UTIL::DETAIL::OBSERVABLE_BASE::impl_.

Referenced by UTIL::OBSERVABLE< ObserverInterface >::Notify(), and UTIL::OBSERVABLE< ObserverInterface >::NotifyIgnore().

◆ get_shared_impl()

std::shared_ptr< OBSERVABLE_BASE::IMPL > UTIL::DETAIL::OBSERVABLE_BASE::get_shared_impl ( )

privateinherited

Definition at line 209 of file observable.cpp.

 {
 allocate_shared_impl();
 return impl_;
 }

References UTIL::DETAIL::OBSERVABLE_BASE::allocate_shared_impl(), and UTIL::DETAIL::OBSERVABLE_BASE::impl_.

◆ leave_iteration()

void UTIL::DETAIL::OBSERVABLE_BASE::leave_iteration ( )

protectedinherited

Definition at line 237 of file observable.cpp.

 {
 if( impl_)
 {
 impl_->leave_iteration();
 
 if( !impl_->is_iterating() && !impl_->is_shared() && impl_.use_count() == 1 )
 impl_.reset();
 }
 }

References UTIL::DETAIL::OBSERVABLE_BASE::impl_.

Referenced by UTIL::OBSERVABLE< ObserverInterface >::Notify(), and UTIL::OBSERVABLE< ObserverInterface >::NotifyIgnore().

◆ Notify()

template<typename ObserverInterface >

template<typename... Args1, typename... Args2>

void UTIL::OBSERVABLE< ObserverInterface >::Notify	(	void(ObserverInterface::*)(Args1...)	Ptr,
		Args2 &&...	aArgs
	)

inline

Notify event to all subscribed observers.

Parameters

Ptr	is a pointer to method of the observer interface.
aArgs	is a list of arguments to each notification call, will be perfectly forwarded.

Definition at line 182 of file observable.h.

 {
 static_assert( sizeof...( Args1 ) == sizeof...( Args2 ), "argument counts don't match" );
 
 if( impl_ )
 {
 enter_iteration();
 try
 {
 for( auto* void_ptr : impl_->observers_ )
 {
 if( void_ptr )
 {
 auto* typed_ptr = static_cast<ObserverInterface*>( void_ptr );
 ( typed_ptr->*Ptr )( std::forward<Args2>( aArgs )... );
 }
 }
 }
 catch( ... )
 {
 leave_iteration();
 throw;
 }
 
 leave_iteration();
 }
 }

References UTIL::DETAIL::OBSERVABLE_BASE::enter_iteration(), UTIL::DETAIL::OBSERVABLE_BASE::impl_, and UTIL::DETAIL::OBSERVABLE_BASE::leave_iteration().

◆ NotifyIgnore()

template<typename ObserverInterface >

template<typename... Args1, typename... Args2>

void UTIL::OBSERVABLE< ObserverInterface >::NotifyIgnore	(	void(ObserverInterface::*)(Args1...)	Ptr,
		ObserverInterface *	aIgnore,
		Args2 &&...	aArgs
	)

inline

Notify event to all subscribed observers but one to be ignore.

Parameters

Ptr	is a pointer to method of the observer interface.
aIgnore	is an observer to ignore during this notification.
aArgs	is a list of arguments to each notification call, will be perfectly forwarded.

Definition at line 218 of file observable.h.

 {
 static_assert( sizeof...( Args1 ) == sizeof...( Args2 ), "argument counts don't match" );
 
 if( impl_ )
 {
 enter_iteration();
 
 try
 {
 for( auto* void_ptr : impl_->observers_ )
 {
 if( void_ptr && void_ptr != aIgnore )
 {
 auto* typed_ptr = static_cast<ObserverInterface*>( void_ptr );
 ( typed_ptr->*Ptr )( std::forward<Args2>( aArgs )... );
 }
 }
 }
 catch( ... )
 {
 leave_iteration();
 throw;
 }
 
 leave_iteration();
 }
 }

References UTIL::DETAIL::OBSERVABLE_BASE::enter_iteration(), UTIL::DETAIL::OBSERVABLE_BASE::impl_, and UTIL::DETAIL::OBSERVABLE_BASE::leave_iteration().

◆ on_observers_empty()

void UTIL::DETAIL::OBSERVABLE_BASE::on_observers_empty ( )

protectedinherited

Definition at line 258 of file observable.cpp.

 {
 // called by an impl that is owned by this, ie. it is a non-shared impl
 // also it is not iterating
 deallocate_impl();
 }

References UTIL::DETAIL::OBSERVABLE_BASE::deallocate_impl().

◆ remove_observer()

void UTIL::DETAIL::OBSERVABLE_BASE::remove_observer ( void * observer )

protectedinherited

Definition at line 223 of file observable.cpp.

 {
 assert( impl_ );
 impl_->remove_observer( observer );
 }

References UTIL::DETAIL::OBSERVABLE_BASE::impl_.

◆ size()

size_t UTIL::DETAIL::OBSERVABLE_BASE::size ( ) const

inherited

Definition at line 249 of file observable.cpp.

 {
 if( impl_ )
 return impl_->observers_.size();
 else
 return 0;
 }

References UTIL::DETAIL::OBSERVABLE_BASE::impl_.

◆ Subscribe()

template<typename ObserverInterface >

LINK UTIL::OBSERVABLE< ObserverInterface >::Subscribe ( ObserverInterface * aObserver )

inline

Add a subscription returning an RAII link.

Parameters

aObserver observer to subscribe

Returns: RAII link controlling the lifetime of the subscription

Definition at line 157 of file observable.h.

 {
 OBSERVABLE_BASE::add_observer( static_cast<void*>( aObserver ) );
 return LINK( impl_, static_cast<void*>( aObserver ) );
 }

References UTIL::DETAIL::OBSERVABLE_BASE::impl_.

Referenced by KIGFX::GAL::GAL().

◆ SubscribeUnmanaged()

template<typename ObserverInterface >

void UTIL::OBSERVABLE< ObserverInterface >::SubscribeUnmanaged ( ObserverInterface * aObserver )

inline

Add a subscription without RAII link.

Parameters

aObserver Observer to subscribe.

Definition at line 146 of file observable.h.

 {
 OBSERVABLE_BASE::add_observer( static_cast<void*>( aObserver ) );
 }

◆ Unsubscribe()

template<typename ObserverInterface >

void UTIL::OBSERVABLE< ObserverInterface >::Unsubscribe ( ObserverInterface * aObserver )

inline

Cancel the subscription of a subscriber.

This can be called during notification calls.

Parameters

aObserver observer to remove from the subscription list.

Definition at line 170 of file observable.h.

 {
 OBSERVABLE_BASE::remove_observer( static_cast<void*>( aObserver ) );
 }

Member Data Documentation

◆ impl_

std::shared_ptr<IMPL> UTIL::DETAIL::OBSERVABLE_BASE::impl_

protectedinherited

Definition at line 93 of file observable.h.

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

observable.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OBSERVABLE() [1/2]

◆ OBSERVABLE() [2/2]

Member Function Documentation

◆ add_observer()

◆ allocate_impl()

◆ allocate_shared_impl()

◆ deallocate_impl()

◆ enter_iteration()

◆ get_shared_impl()

◆ leave_iteration()

◆ Notify()

◆ NotifyIgnore()

◆ on_observers_empty()

◆ remove_observer()

◆ size()

◆ Subscribe()

◆ SubscribeUnmanaged()

◆ Unsubscribe()

Member Data Documentation

◆ impl_