Leviathan::Delegate Class Reference

An object which can accept BaseDelegateSlot derived callbacks that can be called when the event represented by this delegate is called. More...

#include <DelegateSlot.h>

Inheritance diagram for Leviathan::Delegate:

Public Member Functions
DLLEXPORT	Delegate ()
DLLEXPORT	~Delegate ()
DLLEXPORT void	Call (const NamedVars::pointer &values) const
	Calls all the attached delegates. More...
DLLEXPORT void	Register (const BaseDelegateSlot::pointer &callback)
	Registers a new callback. More...
DLLEXPORT void	Call (NamedVars *variables) const
	AngelScript wrapper for Call. More...
	REFERENCE_COUNTED_PTR_TYPE (Delegate)
Public Member Functions inherited from Leviathan::ThreadSafeGeneric< MutexType >
DLLEXPORT	ThreadSafeGeneric ()
DLLEXPORT	~ThreadSafeGeneric ()
FORCE_INLINE void	VerifyLock (RecursiveLock &guard) const
FORCE_INLINE void	VerifyLock (Lock &lockit) const
Public Member Functions inherited from Leviathan::ReferenceCounted
	ReferenceCounted (const ReferenceCounted &other)=delete
ReferenceCounted &	operator= (const ReferenceCounted &other)=delete
FORCE_INLINE void	AddRef ()
FORCE_INLINE void	Release ()
	removes a reference and deletes the object if reference count reaches zero More...
int32_t	GetRefCount () const
	Returns the reference count. More...

Additional Inherited Members
Public Types inherited from Leviathan::ReferenceCounted
using	basepointer = boost::intrusive_ptr< ReferenceCounted >
using	refcountedpointer = boost::intrusive_ptr< ReferenceCounted >
Static Public Member Functions inherited from Leviathan::ReferenceCounted
template<class ActualType >
static boost::intrusive_ptr< ActualType >	WrapPtr (ActualType *ptr)
	Creates an intrusive_ptr from raw pointer. More...
template<class ActualType , class... Args>
static boost::intrusive_ptr< ActualType >	MakeShared (Args &&... args)
	Constructs a new instance and wraps it. More...
Protected Member Functions inherited from Leviathan::ReferenceCounted
DLLEXPORT	ReferenceCounted ()
virtual DLLEXPORT	~ReferenceCounted ()
Protected Attributes inherited from Leviathan::ThreadSafeGeneric< MutexType >
MutexType	ObjectsLock

Detailed Description

An object which can accept BaseDelegateSlot derived callbacks that can be called when the event represented by this delegate is called.

Todo:

Allow unregistering callbacks

Note

Many objects will have Delegates as their members without pointers so scripts really shouldn't try to store these. unless the specific object supports storing them

Definition at line 52 of file DelegateSlot.h.

Constructor & Destructor Documentation

Delegate()

DLLEXPORT Delegate::Delegate

(

)

Definition at line 9 of file DelegateSlot.cpp.

{}

~Delegate()

DLLEXPORT Delegate::~Delegate

(

)

Definition at line 11 of file DelegateSlot.cpp.

{

    // Allow having pointers to delegates from application, but give errors if used as a value
    // and a script keeps a handle around
    LEVIATHAN_ASSERT(GetRefCount() == 1 || GetRefCount() == 0,
        "Delegate still has active references, scripts "
        "shouldn't store these");
}

Member Function Documentation

Call() [1/2]

DLLEXPORT void Delegate::Call

(

const NamedVars::pointer &

values

)

const

Calls all the attached delegates.

Parameters

values

The data for the callbacks to receive.

Todo:

Find a way to more efficiently pass known types or data that may not be stored (only copied)

Definition at line 21 of file DelegateSlot.cpp.

{

    GUARD_LOCK();

    for(const auto& callback : AttachedCallbacks)
        callback->OnCalled(values);
}

Call() [2/2]

DLLEXPORT void Delegate::Call

(

NamedVars *

variables

)

const

AngelScript wrapper for Call.

Note

Decreases reference count

Definition at line 30 of file DelegateSlot.cpp.

{

    GUARD_LOCK();

    for(const auto& callback : AttachedCallbacks)
        callback->OnCalled(values);

    values->Release();
}

REFERENCE_COUNTED_PTR_TYPE()

Leviathan::Delegate::REFERENCE_COUNTED_PTR_TYPE

(

Delegate

)

Register()

DLLEXPORT void Delegate::Register

(

const BaseDelegateSlot::pointer &

callback

)

Registers a new callback.

Definition at line 41 of file DelegateSlot.cpp.

{

    GUARD_LOCK();

    AttachedCallbacks.push_back(callback);
}

---

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

• DelegateSlot.h
• DelegateSlot.cpp