Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzFramework::StdInOutProcessCommunicatorForChildProcess Class Reference

Inherits AzFramework::StdProcessCommunicatorForChildProcess, and AzFramework::StdInOutCommunication.

Public Member Functions

bool IsValid () const override
 
AZ::u32 WriteError (const void *writeBuffer, AZ::u32 bytesToWrite) override
 
AZ::u32 WriteOutput (const void *writeBuffer, AZ::u32 bytesToWrite) override
 
AZ::u32 PeekInput () override
 
AZ::u32 ReadInput (void *buffer, AZ::u32 bufferSize) override
 
bool AttachToExistingPipes () override
 
virtual bool AttachToExistingPipes ()=0
 
- Public Member Functions inherited from AzFramework::ProcessCommunicatorForChildProcess
virtual bool IsValid () const =0
 
virtual AZ::u32 WriteError (const void *writeBuffer, AZ::u32 bytesToWrite)=0
 
virtual AZ::u32 WriteOutput (const void *writeBuffer, AZ::u32 bytesToWrite)=0
 
virtual AZ::u32 PeekInput ()=0
 
virtual AZ::u32 ReadInput (void *readBuffer, AZ::u32 bufferSize)=0
 
AZ::u32 BlockUntilInputAvailable (AZStd::string &readBuffer)
 

Protected Member Functions

void CreateHandles ()
 
void CloseAllHandles ()
 
- Protected Member Functions inherited from AzFramework::ProcessCommunicatorForChildProcess
 AZ_DISABLE_COPY (ProcessCommunicatorForChildProcess)
 
- Protected Member Functions inherited from AzFramework::StdInOutCommunication
AZ::u32 PeekHandle (StdProcessCommunicatorHandle &handle)
 
AZ::u32 ReadDataFromHandle (StdProcessCommunicatorHandle &handle, void *readBuffer, AZ::u32 bufferSize)
 
AZ::u32 WriteDataToHandle (StdProcessCommunicatorHandle &handle, const void *writeBuffer, AZ::u32 bytesToWrite)
 

Protected Attributes

StdProcessCommunicatorHandle m_stdInRead
 
StdProcessCommunicatorHandle m_stdOutWrite
 
StdProcessCommunicatorHandle m_stdErrWrite
 
bool m_initialized = false
 

Member Function Documentation

◆ AttachToExistingPipes()

bool AzFramework::StdInOutProcessCommunicatorForChildProcess::AttachToExistingPipes ( )
overridevirtual

◆ IsValid()

bool AzFramework::StdInOutProcessCommunicatorForChildProcess::IsValid ( ) const
overridevirtual

◆ PeekInput()

AZ::u32 AzFramework::StdInOutProcessCommunicatorForChildProcess::PeekInput ( )
overridevirtual

◆ ReadInput()

AZ::u32 AzFramework::StdInOutProcessCommunicatorForChildProcess::ReadInput ( void *  buffer,
AZ::u32  bufferSize 
)
overridevirtual

◆ WriteError()

AZ::u32 AzFramework::StdInOutProcessCommunicatorForChildProcess::WriteError ( const void *  writeBuffer,
AZ::u32  bytesToWrite 
)
overridevirtual

◆ WriteOutput()

AZ::u32 AzFramework::StdInOutProcessCommunicatorForChildProcess::WriteOutput ( const void *  writeBuffer,
AZ::u32  bytesToWrite 
)
overridevirtual

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