#include <updatehandler.h>

Inheritance diagram for Steinberg::UpdateHandler:

Public Member Functions
	UpdateHandler ()
	~UpdateHandler ()
tresult PLUGIN_API	addDependent (FUnknown object, IDependent dependent) SMTG_OVERRIDE
tresult PLUGIN_API	removeDependent (FUnknown object, IDependent dependent) SMTG_OVERRIDE
tresult PLUGIN_API	triggerUpdates (FUnknown *object, int32 message) SMTG_OVERRIDE
tresult PLUGIN_API	deferUpdates (FUnknown *object, int32 message) SMTG_OVERRIDE
tresult PLUGIN_API	cancelUpdates (FUnknown *object) SMTG_OVERRIDE
tresult PLUGIN_API	triggerDeferedUpdates (FUnknown *object=nullptr) SMTG_OVERRIDE
size_t	countDependencies (FUnknown *object=nullptr)
virtual void	addDependent (IDependent *dep)
	adds dependency to the object
virtual void	removeDependent (IDependent *dep)
	removes dependency from the object
virtual void	deferUpdate (int32 msg=kChanged)
	Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates).
Public Member Functions inherited from Steinberg::FObject
	FObject ()
	default constructor...
	FObject (const FObject &)
	overloaded constructor...
virtual	~FObject ()
	destructor...
FObject &	operator= (const FObject &)
	overloads operator "=" as the reference assignment
virtual FClassID	isA () const
	a local alternative to getFClassID ()
virtual bool	isA (FClassID s) const
	evaluates if the passed ID is of the FObject type
virtual bool	isTypeOf (FClassID s, bool=true) const
	evaluates if the passed ID is of the FObject type
int32	getRefCount ()
	returns the current interface reference count
FUnknown *	unknownCast ()
	get FUnknown interface from object
tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj) SMTG_OVERRIDE
	please refer to FUnknown::queryInterface ()
uint32 PLUGIN_API	addRef () SMTG_OVERRIDE
	please refer to FUnknown::addref ()
uint32 PLUGIN_API	release () SMTG_OVERRIDE
	please refer to FUnknown::release ()
void PLUGIN_API	update (FUnknown *, int32) SMTG_OVERRIDE
	empty virtual method that should be overridden by derived classes for data updates upon changes
virtual void	changed (int32 msg=kChanged)
	Inform all dependents, that the object has changed.
virtual void	updateDone (int32)
	empty virtual method that should be overridden by derived classes
virtual bool	isEqualInstance (FUnknown *d)

Private Member Functions
tresult	doTriggerUpdates (FUnknown *object, int32 message, bool suppressUpdateDone)

Private Attributes
Steinberg::Base::Thread::FLock	lock
Update::Table *	table = nullptr

Static Private Attributes
static bool	lockUpdates = false

Friends
struct	LockUpdateDependencies

Additional Inherited Members
Public Types inherited from Steinberg::IDependent
enum	ChangeMessage { kWillChange , kChanged , kDestroyed , kWillDestroy , kStdChangeMessageLast = kWillDestroy }
Static Public Member Functions inherited from Steinberg::FObject
static FClassID	getFClassID ()
	return Class ID as an ASCII string (statically)
static void	setUpdateHandler (IUpdateHandler *handler)
	set method for the local attribute
static IUpdateHandler *	getUpdateHandler ()
	get method for the local attribute
static bool	classIDsEqual (FClassID ci1, FClassID ci2)
	compares (evaluates) 2 class IDs
static FObject *	unknownToObject (FUnknown *unknown)
	pointer conversion from FUnknown to FObject
Static Public Attributes inherited from Steinberg::FObject
static const FUID	iid
Static Public Attributes inherited from Steinberg::IDependent
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid
Static Public Attributes inherited from Steinberg::IUpdateHandler
static const FUID	iid
Static Public Attributes inherited from Steinberg::IUpdateManager
static const FUID	iid
Protected Attributes inherited from Steinberg::FObject
int32	refCount
	COM-model local reference count.
Static Protected Attributes inherited from Steinberg::FObject
static IUpdateHandler *	gUpdateHandler = nullptr

Detailed Description

UpdateHandler implements IUpdateManager and IUpdateHandler to handle dependencies between objects to store and forward messages to dependent objects.

This implementation is thread save, so objects can send message, add or remove dependents from different threads. Do do so it uses mutex, so be aware of locking.

Constructor & Destructor Documentation

◆ UpdateHandler()

Steinberg::UpdateHandler::UpdateHandler ( )

◆ ~UpdateHandler()

Steinberg::UpdateHandler::~UpdateHandler ( )

Member Function Documentation

◆ addDependent() [1/2]

tresult PLUGIN_API Steinberg::UpdateHandler::addDependent	(	FUnknown *	object,
		IDependent *	dependent )

virtual

register

Parameters

dependent	to get messages from
object

Implements Steinberg::IUpdateHandler.

◆ addDependent() [2/2]

void Steinberg::FObject::addDependent ( IDependent * dep )

virtual

adds dependency to the object

Reimplemented from Steinberg::FObject.

◆ cancelUpdates()

tresult PLUGIN_API Steinberg::UpdateHandler::cancelUpdates ( FUnknown * object )

virtual

cancel pending messages send by

Parameters

object or by any if object is 0

Implements Steinberg::IUpdateManager.

◆ countDependencies()

size_t Steinberg::UpdateHandler::countDependencies ( FUnknown * object = nullptr )

◆ deferUpdate()

void Steinberg::FObject::deferUpdate ( int32 msg = kChanged )

virtual

Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates).

Reimplemented from Steinberg::FObject.

◆ deferUpdates()

tresult PLUGIN_API Steinberg::UpdateHandler::deferUpdates	(	FUnknown *	object,
		int32	message )

virtual

send

Parameters

message	to all dependents of
object	when idle

Implements Steinberg::IUpdateHandler.

◆ doTriggerUpdates()

tresult Steinberg::UpdateHandler::doTriggerUpdates	(	FUnknown *	object,
		int32	message,
		bool	suppressUpdateDone )

private

◆ removeDependent() [1/2]

tresult PLUGIN_API Steinberg::UpdateHandler::removeDependent	(	FUnknown *	object,
		IDependent *	dependent )

virtual

unregister

Parameters

dependent	to get no messages from
object

Implements Steinberg::IUpdateHandler.

◆ removeDependent() [2/2]

void Steinberg::FObject::removeDependent ( IDependent * dep )

virtual

removes dependency from the object

Reimplemented from Steinberg::FObject.

◆ triggerDeferedUpdates()

tresult PLUGIN_API Steinberg::UpdateHandler::triggerDeferedUpdates ( FUnknown * object = nullptr )

virtual

send pending messages send by

Parameters

object or by any if object is 0

Implements Steinberg::IUpdateManager.

◆ triggerUpdates()

tresult PLUGIN_API Steinberg::UpdateHandler::triggerUpdates	(	FUnknown *	object,
		int32	message )

virtual

send

Parameters

message	to all dependents of
object	immediately

Implements Steinberg::IUpdateHandler.

◆ LockUpdateDependencies

friend struct LockUpdateDependencies

friend

Member Data Documentation

◆ lock

Steinberg::Base::Thread::FLock Steinberg::UpdateHandler::lock

private

◆ lockUpdates

bool Steinberg::UpdateHandler::lockUpdates = false

staticprivate

◆ table

Update::Table* Steinberg::UpdateHandler::table = nullptr

private

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

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/base/source/updatehandler.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/base/source/updatehandler.cpp

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UpdateHandler()

◆ ~UpdateHandler()

Member Function Documentation

◆ addDependent() [1/2]

◆ addDependent() [2/2]

◆ cancelUpdates()

◆ countDependencies()

◆ deferUpdate()

◆ deferUpdates()

◆ doTriggerUpdates()

◆ removeDependent() [1/2]

◆ removeDependent() [2/2]

◆ triggerDeferedUpdates()

◆ triggerUpdates()

Friends And Related Symbol Documentation

◆ LockUpdateDependencies

Member Data Documentation

◆ lock

◆ lockUpdates

◆ table