UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::EventLoop::IIOManager Class Referenceabstract

#include <IEventLoopIOManager.h>

+ Inheritance diagram for UE::EventLoop::IIOManager:

Classes

struct  FParams
 

Public Member Functions

virtual ~IIOManager ()=default
 
virtual bool Init ()=0
 
virtual void Shutdown ()=0
 
virtual void Notify ()=0
 
virtual void Poll (FTimespan WaitTime)=0
 

Additional Inherited Members

- Protected Member Functions inherited from FNoncopyable
 FNoncopyable ()
 
 ~FNoncopyable ()
 

Constructor & Destructor Documentation

◆ ~IIOManager()

virtual UE::EventLoop::IIOManager::~IIOManager ( )
virtualdefault

IIOManager(IEventLoop& EventLoop, FParams&& Params);

Member Function Documentation

◆ Init()

virtual bool UE::EventLoop::IIOManager::Init ( )
pure virtual

Initialize the IO manager. Called from within IEventLoop::Init.

Returns
true if successfully initialized.

Implemented in UE::EventLoop::FIOManagerNull, UE::EventLoop::FIOManagerMock, and FAppleHTTPIOManager.

◆ Notify()

virtual void UE::EventLoop::IIOManager::Notify ( )
pure virtual

Notify the IO manager to interrupt a waiting call to Poll. Used to wake the request manager when activity is required.

Thread safe.

Implemented in UE::EventLoop::FIOManagerNull, UE::EventLoop::FIOManagerMock, and FAppleHTTPIOManager.

◆ Poll()

virtual void UE::EventLoop::IIOManager::Poll ( FTimespan  WaitTime)
pure virtual

Poll the request manager for activity.

Parameters
WaitTimeThe maximum amount of time to wait for request activity.

Implemented in UE::EventLoop::FIOManagerNull, UE::EventLoop::FIOManagerMock, and FAppleHTTPIOManager.

◆ Shutdown()

virtual void UE::EventLoop::IIOManager::Shutdown ( )
pure virtual

Cleanup any resources and prepare for shutdown. Called from IEventLoop::RunOnce when the event loop has received a shutdown request.

Implemented in UE::EventLoop::FIOManagerNull, UE::EventLoop::FIOManagerMock, and FAppleHTTPIOManager.


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