#include <Urho3D/Plugins/PluginManager.h>

Inheritance diagram for Urho3D::PluginManager:

Classes
struct	DynamicLibraryInfo
	Cached info about dynamic library on the disk. It may or may not be loaded. More...

Public Member Functions
	PluginManager (Context *context)

void	SerializeInBlock (Archive &archive) override
	Serialize content from/to archive. May throw ArchiveException.

void	Reload ()
	Reload all dynamic modules.

void	Commit ()

void	StartApplication ()
	Start plugin application for all loaded plugins.

void	StopApplication ()
	Stop plugin application for all loaded plugins.

bool	IsStarted () const
	Return whether the application is started now.

bool	ArePluginsRenamed () const
	Return whether the plugins are renamed on load.

void	SetPluginsLoaded (const StringVector &plugins)
	Set loaded plugins. Order is preserved.

bool	IsPluginLoaded (const ea::string &name)
	Return whether the plugin is loaded.

const StringVector &	GetLoadedPlugins () const
	Return loaded plugins.

unsigned	GetRevision () const
	Return revision of loaded plugins.

bool	IsReloadPending () const
	Return whether the load is pending at the end of the frame.

bool	AddDynamicPlugin (Plugin *plugin)
	Manually add new plugin with dynamic reloading.

bool	AddStaticPlugin (PluginApplication *pluginApplication)
	Manually add plugin that stays loaded forever.

Plugin *	GetDynamicPlugin (const ea::string &name, bool ignoreUnloaded)
	Find or load dynamic plugin by name.

PluginApplication *	GetPluginApplication (const ea::string &name, bool ignoreUnloaded, unsigned *version=nullptr)
	Find or load plugin application by name.

PluginApplication *	GetMainPlugin () const
	Return main plugin. The result is valid after plugin application started.

StringVector	ScanAvailableModules ()
	Enumerate dynamic modules available to load.

StringVector	EnumerateLoadedModules ()
	Enumerate already loaded dynamic modules and static plugins.

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static void	RegisterPluginApplication (const ea::string &name, PluginApplicationFactory factory)
	Register plugin application class to be visible in all future instances of PluginManager.

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (PluginManager, Object)

void	DisposeStack ()

void	RestoreStack ()

void	Update (bool exiting)

void	UpdatePlugin (Plugin *plugin, bool checkOutOfDate)

void	PerformPluginUnload (Plugin *plugin)

void	TryReloadPlugin (Plugin *plugin)

bool	CheckAndRemoveUnloadedPlugin (Plugin *plugin)

template<class T >
void	ForEachPluginApplication (const T &callback)

Private Attributes
bool	startPending_ {}

bool	stopPending_ {}

bool	stackReloadPending_ {}

StringVector	loadedPlugins_

unsigned	revision_ {}

SharedPtr< PluginStack >	pluginStack_

SerializedPlugins	restoreBuffer_

bool	wasStarted_ {}

ea::unordered_map< ea::string, DynamicLibraryInfo >	pluginInfoCache_


const bool	renamePluginBinaries_ {}

unsigned	reloadIntervalMs_ {1000}

unsigned	reloadTimeoutMs_ {10000}


ea::unordered_map< ea::string, SharedPtr< Plugin > >	dynamicPlugins_

ea::unordered_map< ea::string, SharedPtr< PluginApplication > >	staticPlugins_


bool	forceReload_ {}

bool	enableAutoReload_ {}

Timer	reloadTimer_

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Manages engine plugins. Note that module being loaded and plugin being loaded are two different things.

Member Function Documentation

◆ Commit()

void Urho3D::PluginManager::Commit ( )

Commit updates to the list of loaded plugins and to application status. This may be unsafe to call inside of the frame. Called automatically between frames.

Member Data Documentation

◆ dynamicPlugins_

ea::unordered_map<ea::string, SharedPtr<Plugin> > Urho3D::PluginManager::dynamicPlugins_

private

Currently loaded modules

◆ forceReload_

bool Urho3D::PluginManager::forceReload_ {}

private

Auto-reloading of dynamic plugins

◆ renamePluginBinaries_

const bool Urho3D::PluginManager::renamePluginBinaries_ {}

private

Parameters

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

Urho3D/Plugins/PluginManager.h
Urho3D/Plugins/PluginManager.cpp

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Commit()

Member Data Documentation

◆ dynamicPlugins_

◆ forceReload_

◆ renamePluginBinaries_