xiiEditorEngineProcessConnection Class Reference

Classes
struct	Event

Public Member Functions
void	SetFileSystemConfig (const xiiApplicationFileSystemConfig &cfg)
void	SetPluginConfig (const xiiApplicationPluginConfig &cfg)
void	Update ()
xiiResult	RestartProcess ()
void	ShutdownProcess ()
bool	IsProcessCrashed () const
xiiEditorEngineConnection *	CreateEngineConnection (xiiAssetDocument *pDocument)
void	DestroyEngineConnection (xiiAssetDocument *pDocument)
bool	SendMessage (xiiProcessMessage *pMessage)
xiiResult	WaitForMessage (const xiiRTTI *pMessageType, xiiTime timeout, xiiProcessCommunicationChannel ::WaitForMessageCallback *pCallback=nullptr)
xiiResult	WaitForDocumentMessage (const xiiUuid &assetGuid, const xiiRTTI *pMessageType, xiiTime timeout, xiiProcessCommunicationChannel::WaitForMessageCallback *pCallback=nullptr)
bool	IsEngineSetup () const
void	ActivateRemoteProcess (const xiiAssetDocument *pDocument, xiiUInt32 uiViewID)
xiiProcessCommunicationChannel &	GetCommunicationChannel ()

Static Public Attributes
static xiiEvent< const Event & >	s_Events

Member Function Documentation

SetFileSystemConfig()

void xiiEditorEngineProcessConnection::SetFileSystemConfig ( const xiiApplicationFileSystemConfig & cfg )

inline

The given file system configuration will be used by the engine process to setup the runtime data directories. This only takes effect if the editor process is restarted.

SetPluginConfig()

void xiiEditorEngineProcessConnection::SetPluginConfig ( const xiiApplicationPluginConfig & cfg )

inline

The given plugin configuration will be used by the engine process to load runtime plugins. This only takes effect if the editor process is restarted.

WaitForDocumentMessage()

xiiResult xiiEditorEngineProcessConnection::WaitForDocumentMessage	(	const xiiUuid &	assetGuid,
		const xiiRTTI *	pMessageType,
		xiiTime	timeout,
		xiiProcessCommunicationChannel::WaitForMessageCallback *	pCallback = nullptr )

Same as WaitForMessage but the message must be to a specific document. Therefore, pMessageType must be derived from xiiEditorEngineDocumentMsg and the function will only return if the received message matches both type, document and is accepted by pCallback.

WaitForMessage()

xiiResult xiiEditorEngineProcessConnection::WaitForMessage	(	const xiiRTTI *	pMessageType,
		xiiTime	timeout,
		xiiProcessCommunicationChannel ::WaitForMessageCallback *	pCallback = nullptr )

Waits for a message of type pMessageType. If tTimeout is zero, the function will not timeout. If the timeout is valid and is it, XII_FAILURE is returned. If the message type matches and pCallback is valid, the function will be called and the return values decides whether the message is to be accepted and the waiting has ended.

---

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

• /home/runner/work/XII/XII/Source/Editor/EditorFramework/IPC/EngineProcessConnection.h
• /home/runner/work/XII/XII/Source/Editor/EditorFramework/IPC/Implementation/EngineProcessConnection.cpp