appbase::channel< Data, DispatchPolicy >::handle Class Reference

#include <channel.hpp>

Public Member Functions
	~handle ()
void	unsubscribe ()
	handle ()=default
	handle (handle &&)=default
handle &	operator= (handle &&rhs)=default
	handle (const handle &)=delete
handle &	operator= (const handle &)=delete

Friends
class	channel

Detailed Description

template<typename Data, typename DispatchPolicy>
class appbase::channel< Data, DispatchPolicy >::handle

Type that represents an active subscription to a channel allowing for ownership via RAII and also explicit unsubscribe actions

Definition at line 53 of file channel.hpp.

Constructor & Destructor Documentation

~handle()

template<typename Data , typename DispatchPolicy >

appbase::channel< Data, DispatchPolicy >::handle::~handle ( )

inline

Definition at line 55 of file channel.hpp.

                         {
                  unsubscribe();
               }

Here is the call graph for this function:

handle() [1/3]

template<typename Data , typename DispatchPolicy >

appbase::channel< Data, DispatchPolicy >::handle::handle ( )

default

handle() [2/3]

template<typename Data , typename DispatchPolicy >

appbase::channel< Data, DispatchPolicy >::handle::handle ( handle && )

default

handle() [3/3]

template<typename Data , typename DispatchPolicy >

appbase::channel< Data, DispatchPolicy >::handle::handle ( const handle & )

delete

Member Function Documentation

operator=() [1/2]

template<typename Data , typename DispatchPolicy >

handle & appbase::channel< Data, DispatchPolicy >::handle::operator= ( const handle & )

delete

operator=() [2/2]

template<typename Data , typename DispatchPolicy >

handle & appbase::channel< Data, DispatchPolicy >::handle::operator= ( handle && rhs )

default

unsubscribe()

template<typename Data , typename DispatchPolicy >

void appbase::channel< Data, DispatchPolicy >::handle::unsubscribe ( )

inline

Explicitly unsubcribe from channel before the lifetime of this object expires

Definition at line 63 of file channel.hpp.

                                  {
                  if (_handle.connected()) {
                     _handle.disconnect();
                  }
               }

Here is the caller graph for this function:

Friends And Related Symbol Documentation

channel

template<typename Data , typename DispatchPolicy >

friend class channel

friend

Definition at line 92 of file channel.hpp.

---

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

• libraries/appbase/include/appbase/channel.hpp