ezProcessCommunicationChannel Class Reference

Inheritance diagram for ezProcessCommunicationChannel:

Classes
struct	Event

Public Types
using	WaitForMessageCallback = ezDelegate< bool(ezProcessMessage *)>

Public Member Functions
bool	SendMessage (ezProcessMessage *pMessage)
ezResult	WaitForMessage (const ezRTTI *pMessageType, ezTime timeout, WaitForMessageCallback *pMessageCallack=nullptr)
ezResult	WaitForConnection (ezTime timeout)
bool	IsConnected () const
bool	ProcessMessages ()
	Returns true if any message was processed.
void	WaitForMessages (ezTime timeout=ezTime::MakeZero())
	Blocks until a message arrives.

Public Attributes
ezEvent< const Event & >	m_Events
ezEvent< const ezIpcChannelEvent &, ezMutex >	m_IpcChannelEvents

Protected Member Functions
void	OnIpcProtocolEvent (const ezIpcProcessMessageProtocol::Event &msg)
void	OnIpcChannelEvent (const ezIpcChannelEvent &msg)
ezResult	CreateAndConnectChannel (ezInternal::NewInstance< ezIpcChannel > &&channel)
void	DestroyChannel ()

Protected Attributes
ezUniquePtr< ezIpcProcessMessageProtocol >	m_pProtocol
ezUniquePtr< ezIpcChannel >	m_pChannel
const ezRTTI *	m_pFirstAllowedMessageType = nullptr

Member Typedef Documentation

WaitForMessageCallback

using ezProcessCommunicationChannel::WaitForMessageCallback = ezDelegate<bool(ezProcessMessage*)>

/brief Callback for 'wait for...' functions. If true is returned, the message is accepted to match the wait criteria and the waiting ends. If false is returned the wait for the message continues.

Member Function Documentation

WaitForMessages()

void ezProcessCommunicationChannel::WaitForMessages

(

ezTime

timeout = ezTime::MakeZero()

)

Blocks until a message arrives.

Parameters

timeout

Zero blocks indefinitely. Pass a short one when the caller has other work that a message is not going to wake it up for.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Editor/EditorEngineProcessFramework/IPC/ProcessCommunicationChannel.h
• /home/runner/work/ezEngine/ezEngine/Code/Editor/EditorEngineProcessFramework/IPC/ProcessCommunicationChannel.cpp