Public Types
using	Callback = Delegate< ReturnType(ArgumentTypes...)>
	The type of the delegates represented by the MulticastDelegate class. More...

Public Member Functions
	MulticastDelegate ()
	Constructs an empty collection. More...

	~MulticastDelegate ()
	Destructor. More...

	MulticastDelegate (std::nullptr_t)
	Equivalent to defalt constructor. More...

	MulticastDelegate (const MulticastDelegate &o)

MulticastDelegate &	operator= (const MulticastDelegate &o)

	MulticastDelegate (MulticastDelegate &&o)

MulticastDelegate &	operator= (MulticastDelegate &&o)

	MulticastDelegate (Callback &&initial)

template<class T , typename = decltype(Callback(std::declval<T>()))>
	MulticastDelegate (T arg)

bool	empty () const

bool	IsNull () const

bool	operator== (const std::nullptr_t &) const

bool	operator!= (const std::nullptr_t &) const

MulticastDelegate &	connect (Callback callback)

template<class R , class... Args>
MulticastDelegate &	connect (std::function< R(Args...)> f)

MulticastDelegate &	connect (MulticastDelegate &other)

template<class MemberType , class ClassType >
MulticastDelegate &	connect (MemberType ClassType::member, ClassType obj)

template<class MemberType , class ClassType >
MulticastDelegate &	connect (MemberType ClassType::*member, const SharedPtr< ClassType > &obj)

MulticastDelegate &	operator+= (Callback callback)

MulticastDelegate &	disconnect (Callback callback)

template<class MemberType , class ClassType >
MulticastDelegate &	disconnect (MemberType ClassType::member, ClassType obj)

template<class MemberType , class ClassType >
MulticastDelegate &	disconnect (MemberType ClassType::*member, const SharedPtr< ClassType > &obj)

MulticastDelegate &	disconnect (MulticastDelegate &other)

MulticastDelegate &	operator-= (Callback callback)

bool	operator== (const MulticastDelegate &other) const

bool	operator!= (const MulticastDelegate &other) const

MulticastDelegate &	disconnect_all_slots ()

void	remove_empty_callbacks () const
	Cleans out contained callbacks that are empty (not actually calling anything). More...

ReturnType	invoke (ArgumentTypes... args) const

ReturnType	operator() (ArgumentTypes... args) const

template<typename CallbackArgumentType >
SharedPtr< IAsyncResult >	BeginInvoke (ArgumentTypes... args, const AsyncCallback &member, const CallbackArgumentType &obj)

ReturnType	EndInvoke (const SharedPtr< IAsyncResult > &)

Detailed Description

template<class ReturnType, class... ArgumentTypes>
class System::MulticastDelegate< ReturnType(ArgumentTypes...)>

Represents a collection of delegates. This type should be allocated on stack and passed to functions by value or by reference. Never use System::SmartPtr class to manage objects of this type.

Template Parameters

ReturnType	Return type of the invokable entities pointed to by each delegate in the collection
ArgumentTypes	Argument list of the invokable entities pointed to by each delegate in the collection

Member Typedef Documentation

◆ Callback

template<class ReturnType , class... ArgumentTypes>

using System::MulticastDelegate< ReturnType(ArgumentTypes...)>::Callback = Delegate<ReturnType(ArgumentTypes...)>

The type of the delegates represented by the MulticastDelegate class.

Constructor & Destructor Documentation

◆ MulticastDelegate() [1/6]

template<class ReturnType , class... ArgumentTypes>

System::MulticastDelegate< ReturnType(ArgumentTypes...)>::MulticastDelegate ( )

inline

Constructs an empty collection.

◆ ~MulticastDelegate()

template<class ReturnType , class... ArgumentTypes>

System::MulticastDelegate< ReturnType(ArgumentTypes...)>::~MulticastDelegate ( )

inline

Destructor.

◆ MulticastDelegate() [2/6]

template<class ReturnType , class... ArgumentTypes>

System::MulticastDelegate< ReturnType(ArgumentTypes...)>::MulticastDelegate ( std::nullptr_t )

inline

Equivalent to defalt constructor.

◆ MulticastDelegate() [3/6]

template<class ReturnType , class... ArgumentTypes>

System::MulticastDelegate< ReturnType(ArgumentTypes...)>::MulticastDelegate ( const MulticastDelegate< ReturnType(ArgumentTypes...)> & o )

inline

Performs a shallow copy of the delegate collection.

Parameters

o	An instance of MulticastDelegate class to copy the collection of delegates from.

◆ MulticastDelegate() [4/6]

template<class ReturnType , class... ArgumentTypes>

System::MulticastDelegate< ReturnType(ArgumentTypes...)>::MulticastDelegate ( MulticastDelegate< ReturnType(ArgumentTypes...)> && o )

inline

Moving constructor.

Parameters

o	An instance of MulticastDelegate class to move the collection of delegates from.

◆ MulticastDelegate() [5/6]

template<class ReturnType , class... ArgumentTypes>

System::MulticastDelegate< ReturnType(ArgumentTypes...)>::MulticastDelegate ( Callback && initial )

inline

Constructs an instance and puts the specified delegate to the delegates collection.

Parameters

initial A delegate to put to the delegate collection

◆ MulticastDelegate() [6/6]

template<class ReturnType , class... ArgumentTypes>

template<class T , typename = decltype(Callback(std::declval<T>()))>

System::MulticastDelegate< ReturnType(ArgumentTypes...)>::MulticastDelegate ( T arg )

inline

Constructs an instance and puts the specified value to the delegates collection.

Parameters

arg	A value to put to the delegate collection

Template Parameters

Type	of the value to put to the delegate collection of the newly constructed instance; the type must be convertible to Callback type.

Member Function Documentation

◆ BeginInvoke()

template<class ReturnType , class... ArgumentTypes>

template<typename CallbackArgumentType >

SharedPtr<IAsyncResult> System::MulticastDelegate< ReturnType(ArgumentTypes...)>::BeginInvoke	(	ArgumentTypes...	args,
		const AsyncCallback &	member,
		const CallbackArgumentType &	obj
	)

inline

NOT IMPLEMENTED

Exceptions

NotImplementedException Always

◆ connect() [1/5]

template<class ReturnType , class... ArgumentTypes>

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::connect ( Callback callback )

inline

Adds the specified delegate to the collection.

Parameters

callback The delegate to add to the collection

Returns: A reference to the self

◆ connect() [2/5]

template<class ReturnType , class... ArgumentTypes>

template<class R , class... Args>

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::connect ( std::function< R(Args...)> f )

inline

Adds the specified function object to the delegate collection. The function object is converted to the Callback delegate type before being added to the collection.

Parameters

f	The function object to add to the collection

Returns: A reference to the self

Template Parameters

R	The return type of the function object to add to the collection
Args	The argument list of the function object to add to the collection

◆ connect() [3/5]

template<class ReturnType , class... ArgumentTypes>

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::connect ( MulticastDelegate< ReturnType(ArgumentTypes...)> & other )

inline

Adds the specified MulticastDelegate object to the delegate collection.

Parameters

other An instance of the MulticastDelegate class to add to the delegate collection

Returns: A reference to the self

◆ connect() [4/5]

template<class ReturnType , class... ArgumentTypes>

template<class MemberType , class ClassType >

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::connect	(	MemberType ClassType::*	member,
		ClassType *	obj
	)

inline

Adds the specified non-static method of the specified object to the delegate collection.

Parameters

member	A pointer to the non-static method of the specified object
obj	A pointer to an object member method of which is to be added to the delegate collection

Returns: A reference to the self

Template Parameters

MemberType	The type of the non-static method that is to be added to the delegate collection
ClassType	The type of the object method of which is to be added to the delegate

◆ connect() [5/5]

template<class ReturnType , class... ArgumentTypes>

template<class MemberType , class ClassType >

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::connect	(	MemberType ClassType::*	member,
		const SharedPtr< ClassType > &	obj
	)

inline

Adds the specified non-static method of the specified object to the delegate collection.

Parameters

member	A pointer to the non-static method of the specified object
obj	A shared pointer to an object member method of which is to be added to the delegate collection

Returns: A reference to the self

Template Parameters

MemberType	The type of the non-static method that is to be added to the delegate collection
ClassType	The type of the object method of which is to be added to the delegate collection

◆ disconnect() [1/4]

template<class ReturnType , class... ArgumentTypes>

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::disconnect ( Callback callback )

inline

Removes the specified delegate from the delegate collection.

Parameters

callback The delegate to remove from the collection

Returns: A reference to the self

◆ disconnect() [2/4]

template<class ReturnType , class... ArgumentTypes>

template<class MemberType , class ClassType >

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::disconnect	(	MemberType ClassType::*	member,
		ClassType *	obj
	)

inline

Removes the specified non-static method of the specified object from the delegate collection.

Parameters

member	A pointer to the non-static method of the specified object
obj	A pointer to an object member method of which is to be removed from the delegate collection

Returns: A reference to the self

Template Parameters

MemberType	The type of the non-static method that is to be removed from the delegate collection
ClassType	The type of the object method of which is to be removed from the delegate collection

◆ disconnect() [3/4]

template<class ReturnType , class... ArgumentTypes>

template<class MemberType , class ClassType >

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::disconnect	(	MemberType ClassType::*	member,
		const SharedPtr< ClassType > &	obj
	)

inline

Removes the specified non-static method of the specified object from the delegate collection.

Parameters

member	A pointer to the non-static method of the specified object
obj	A shared pointer to an object member method of which is to be removed from the delegate collection

Returns: A reference to the self

Template Parameters

MemberType	The type of the non-static method that is to be removed from the delegate collection
ClassType	The type of the object method of which is to be removed from the delegate collection

◆ disconnect() [4/4]

template<class ReturnType , class... ArgumentTypes>

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::disconnect ( MulticastDelegate< ReturnType(ArgumentTypes...)> & other )

inline

Removes the specified MulticastDelegate object from the delegate collection.

Parameters

other An instance of the MulticastDelegate class to remove from the delegate collection

Returns: A reference to the self

◆ disconnect_all_slots()

template<class ReturnType , class... ArgumentTypes>

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::disconnect_all_slots ( )

inline

Removes all delegates from the delegate collection.

Returns: A reference to the self

◆ empty()

template<class ReturnType , class... ArgumentTypes>

bool System::MulticastDelegate< ReturnType(ArgumentTypes...)>::empty ( ) const

inline

Determines whether the delegate collection is empty.

Returns: True if the delegate collection is empty, otherwise - false

◆ EndInvoke()

template<class ReturnType , class... ArgumentTypes>

ReturnType System::MulticastDelegate< ReturnType(ArgumentTypes...)>::EndInvoke ( const SharedPtr< IAsyncResult > & )

inline

NOT IMPLEMENTED

Exceptions

NotImplementedException Always

◆ invoke()

template<class ReturnType , class... ArgumentTypes>

ReturnType System::MulticastDelegate< ReturnType(ArgumentTypes...)>::invoke ( ArgumentTypes... args ) const

inline

Invokes all delegates currently present in the delegates collection. Delegates are invoked in the same order as they were added to the collection. The method blocks while the delegates are executed.

Parameters

args	Arguments to pass to the delegates to be invoked

Returns: Return value of the last invoked delegate

◆ IsNull()

template<class ReturnType , class... ArgumentTypes>

bool System::MulticastDelegate< ReturnType(ArgumentTypes...)>::IsNull ( ) const

inline

Determines whether the delegate collection is empty.

Returns: True if the delegate collection is empty, otherwise - false

◆ operator!=() [1/2]

template<class ReturnType , class... ArgumentTypes>

bool System::MulticastDelegate< ReturnType(ArgumentTypes...)>::operator!= ( const std::nullptr_t & ) const

inline

Determines whether the delegate collection is not empty.

Returns: True if the delegate collection is not empty, otherwise - false

◆ operator!=() [2/2]

template<class ReturnType , class... ArgumentTypes>

bool System::MulticastDelegate< ReturnType(ArgumentTypes...)>::operator!= ( const MulticastDelegate< ReturnType(ArgumentTypes...)> & other ) const

inline

Determines whether two instances of MulticastDelegate - the current object and the specified object - point to different delegates collection.

Parameters

other The MulticastDelegate object to compare with

Returns: True if both objects represent the same delegates collection, otherwise - false

◆ operator()()

template<class ReturnType , class... ArgumentTypes>

ReturnType System::MulticastDelegate< ReturnType(ArgumentTypes...)>::operator() ( ArgumentTypes... args ) const

inline

Invokes all delegates currently present in the delegates collection. Delegates are invoked in the same order as they were added to the collection. The operator blocks while the delegates are executed.

Parameters

args	Arguments to pass to the delegates to be invoked

Returns: Return value of the last invoked delegate

◆ operator+=()

template<class ReturnType , class... ArgumentTypes>

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::operator+= ( Callback callback )

inline

Adds the specified delegate to the collection.

Parameters

callback The delegate to add to the collection

Returns: A reference to the self

◆ operator-=()

template<class ReturnType , class... ArgumentTypes>

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::operator-= ( Callback callback )

inline

Removes the specified delegate from the delegate collection.

Parameters

callback The delegate to remove from the collection

Returns: A reference to the self

◆ operator=() [1/2]

template<class ReturnType , class... ArgumentTypes>

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::operator= ( const MulticastDelegate< ReturnType(ArgumentTypes...)> & o )

inline

Assigns the collection of delegates represented by the specified object to the current object. As a result both objects point to the same collection of delegates.

Parameters

o	An instance of MulticastDelegate class containing the collection of delegates to be assigned to the current object.

◆ operator=() [2/2]

template<class ReturnType , class... ArgumentTypes>

MulticastDelegate& System::MulticastDelegate< ReturnType(ArgumentTypes...)>::operator= ( MulticastDelegate< ReturnType(ArgumentTypes...)> && o )

inline

Moving assignment operator.

Parameters

o	An instance of MulticastDelegate class to move the collection of delegates from.

◆ operator==() [1/2]

template<class ReturnType , class... ArgumentTypes>

bool System::MulticastDelegate< ReturnType(ArgumentTypes...)>::operator== ( const std::nullptr_t & ) const

inline

Determines whether the delegate collection is empty.

Returns: True if the delegate collection is empty, otherwise - false

◆ operator==() [2/2]

template<class ReturnType , class... ArgumentTypes>

bool System::MulticastDelegate< ReturnType(ArgumentTypes...)>::operator== ( const MulticastDelegate< ReturnType(ArgumentTypes...)> & other ) const

inline

Determines whether two instances of MulticastDelegate - the current object and the specified object - point to the same delegates collection.

Parameters

other The MulticastDelegate object to compare with

Returns: True if both objects represent the same delegates collection, otherwise - false

◆ remove_empty_callbacks()

template<class ReturnType , class... ArgumentTypes>

void System::MulticastDelegate< ReturnType(ArgumentTypes...)>::remove_empty_callbacks ( ) const

inline

Cleans out contained callbacks that are empty (not actually calling anything).

Public Types

Public Member Functions

Detailed Description

template<class ReturnType, class... ArgumentTypes> class System::MulticastDelegate< ReturnType(ArgumentTypes...)>

Member Typedef Documentation

◆ Callback

Constructor & Destructor Documentation

◆ MulticastDelegate() [1/6]

◆ ~MulticastDelegate()

◆ MulticastDelegate() [2/6]

◆ MulticastDelegate() [3/6]

◆ MulticastDelegate() [4/6]

◆ MulticastDelegate() [5/6]

◆ MulticastDelegate() [6/6]

Member Function Documentation

◆ BeginInvoke()

◆ connect() [1/5]

◆ connect() [2/5]

◆ connect() [3/5]

◆ connect() [4/5]

◆ connect() [5/5]

◆ disconnect() [1/4]

◆ disconnect() [2/4]

◆ disconnect() [3/4]

◆ disconnect() [4/4]

◆ disconnect_all_slots()

◆ empty()

◆ EndInvoke()

◆ invoke()

◆ IsNull()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator()()

◆ operator+=()

◆ operator-=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ remove_empty_callbacks()

template<class ReturnType, class... ArgumentTypes>
class System::MulticastDelegate< ReturnType(ArgumentTypes...)>