Nickvision::Events::Event< T > Class Template Reference

An event that can have handlers subscribe to it, which in turn will be called when the event is invoked. More...

#include <event.h>

Public Member Functions
	Event () noexcept=default
	Constructs an Event.
	Event (const Event &e) noexcept
	Constructs an Event via copy.
	Event (Event &&e) noexcept
	Constructs an Event via move.
size_t	count () const noexcept
	Gets the number of handlers subscribed to the event.
HandlerId	subscribe (const std::function< void(const T &)> &handler) noexcept
	Subscribes a handler to the event.
void	unsubscribe (HandlerId id) noexcept
	Unsubscribes a handler from the event.
void	invoke (const T &param) const noexcept
	Invokes the event, calling all handlers.
HandlerId	operator+= (const std::function< void(const T &)> &handler) noexcept
	Subscribes a handler to the event.
void	operator-= (HandlerId id) noexcept
	Unsubscribes a handler from the event.
void	operator() (const T &param) noexcept
	Invokes the event, calling all handlers.
Event &	operator= (const Event &e) noexcept
	Copies an Event.
Event &	operator= (Event &&e) noexcept
	Moves an Event.
	operator bool () const noexcept
	Gets whether or not the object is valid or not.

Detailed Description

template<DerivedEventArgs T>
class Nickvision::Events::Event< T >

An event that can have handlers subscribe to it, which in turn will be called when the event is invoked.

Template Parameters

T	Derived type of EventArgs

Constructor & Destructor Documentation

Event() [1/3]

template<DerivedEventArgs T>

Nickvision::Events::Event< T >::Event ( )

defaultnoexcept

Constructs an Event.

Event() [2/3]

template<DerivedEventArgs T>

Nickvision::Events::Event< T >::Event ( const Event< T > & e )

inlinenoexcept

Constructs an Event via copy.

Parameters

e	The object to copy

Event() [3/3]

template<DerivedEventArgs T>

Nickvision::Events::Event< T >::Event ( Event< T > && e )

inlinenoexcept

Constructs an Event via move.

Parameters

e	The object to move

Member Function Documentation

count()

template<DerivedEventArgs T>

size_t Nickvision::Events::Event< T >::count ( ) const

inlinenoexcept

Gets the number of handlers subscribed to the event.

Returns

The number of handlers

invoke()

template<DerivedEventArgs T>

void Nickvision::Events::Event< T >::invoke ( const T & param ) const

inlinenoexcept

Invokes the event, calling all handlers.

Parameters

param

The parameter to pass to the handlers

operator bool()

template<DerivedEventArgs T>

Nickvision::Events::Event< T >::operator bool ( ) const

inlinenoexcept

Gets whether or not the object is valid or not.

Returns

True if valid (if count() > 0), else false

operator()()

template<DerivedEventArgs T>

void Nickvision::Events::Event< T >::operator() ( const T & param )

inlinenoexcept

Invokes the event, calling all handlers.

Parameters

param

The parameter to pass to the handlers

operator+=()

template<DerivedEventArgs T>

HandlerId Nickvision::Events::Event< T >::operator+= ( const std::function< void(const T &)> & handler )

inlinenoexcept

Subscribes a handler to the event.

Parameters

handler

The handler function

Returns

The handler id

operator-=()

template<DerivedEventArgs T>

void Nickvision::Events::Event< T >::operator-= ( HandlerId id )

inlinenoexcept

Unsubscribes a handler from the event.

Parameters

id	The handler id

operator=() [1/2]

template<DerivedEventArgs T>

Event & Nickvision::Events::Event< T >::operator= ( const Event< T > & e )

inlinenoexcept

Copies an Event.

Parameters

e	The Event to copy

Returns

this

operator=() [2/2]

template<DerivedEventArgs T>

Event & Nickvision::Events::Event< T >::operator= ( Event< T > && e )

inlinenoexcept

Moves an Event.

Parameters

e	The Event to move

Returns

this

subscribe()

template<DerivedEventArgs T>

HandlerId Nickvision::Events::Event< T >::subscribe ( const std::function< void(const T &)> & handler )

inlinenoexcept

Subscribes a handler to the event.

Parameters

handler

The handler function

Returns

The handler id

unsubscribe()

template<DerivedEventArgs T>

void Nickvision::Events::Event< T >::unsubscribe ( HandlerId id )

inlinenoexcept

Unsubscribes a handler from the event.

Parameters

id	The handler id

---

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

• include/events/event.h