#include <IOSPlatformProcess.h>

Inheritance diagram for FIOSPlatformProcess:

Static Public Member Functions
static const TCHAR *	ComputerName ()

static const TCHAR *	BaseDir ()

static FRunnableThread *	CreateRunnableThread ()

static void	LaunchURL (const TCHAR URL, const TCHAR Parms, FString *Error)

static void	LaunchSyncURL (const TCHAR URL, const TCHAR Parms, float Timeout, FString *Error)

static bool	CanLaunchURL (const TCHAR *URL)

static FString	GetGameBundleId ()

static void	SetupGameThread ()

static void	SetupRenderThread ()

static void	SetThreadAffinityMask (uint64 AffinityMask)

static const TCHAR *	ExecutablePath ()

static const TCHAR *	ExecutableName (bool bRemoveExtension=true)

static FString	GenerateApplicationPath (const FString &AppName, EBuildConfiguration BuildConfiguration)

Static Public Member Functions inherited from FApplePlatformProcess
static const TCHAR *	UserDir ()

static const TCHAR *	UserTempDir ()

static const TCHAR *	UserSettingsDir ()

static const TCHAR *	ApplicationSettingsDir ()

static FString	GetApplicationSettingsDir (const ApplicationSettingsContext &Settings)

static const TCHAR *	UserHomeDir ()

Static Public Member Functions inherited from FGenericPlatformProcess
static CORE_API void *	GetDllHandle (const TCHAR *Filename)

static CORE_API void	FreeDllHandle (void *DllHandle)

static CORE_API void *	GetDllExport (void DllHandle, const TCHAR ProcName)

static UE_FORCEINLINE_HINT void	AddDllDirectory (const TCHAR *Directory)

static UE_FORCEINLINE_HINT void	PushDllDirectory (const TCHAR *Directory)

static UE_FORCEINLINE_HINT void	PopDllDirectory (const TCHAR *Directory)

static UE_FORCEINLINE_HINT void	GetDllDirectories (TArray< FString > &OutDllDirectories)

static CORE_API uint32	GetCurrentProcessId ()

static CORE_API uint32	GetCurrentCoreNumber ()

static bool	GetPerFrameProcessorUsage (uint32 ProcessId, float &ProcessUsageFraction, float &IdleUsageFraction)

static CORE_API void	SetThreadAffinityMask (uint64 AffinityMask)

static CORE_API void	SetThreadPriority (EThreadPriority NewPriority)

static void	SetThreadName (const TCHAR *ThreadName)

static CORE_API uint32	GetStackSize ()

static void	DumpThreadInfo (const TCHAR *MarkerName)

static void	SetupGameThread ()

static void	SetupRenderThread ()

static void	SetupAudioThread ()

static void	TeardownAudioThread ()

static CORE_API bool	ShouldSaveToUserDir ()

static CORE_API const TCHAR *	BaseDir ()

static CORE_API const TCHAR *	UserDir ()

static CORE_API const TCHAR *	UserSettingsDir ()

static CORE_API const TCHAR *	UserTempDir ()

static CORE_API const TCHAR *	UserHomeDir ()

static CORE_API const TCHAR *	ApplicationSettingsDir ()

static CORE_API FString	GetApplicationSettingsDir (const ApplicationSettingsContext &Settings)

static CORE_API const TCHAR *	ComputerName ()

static CORE_API const TCHAR *	UserName (bool bOnlyAlphaNumeric=true)

static CORE_API const TCHAR *	ShaderDir ()

static CORE_API void	SetShaderDir (const TCHAR *Where)

static CORE_API void	SetCurrentWorkingDirectoryToBaseDir ()

static CORE_API FString	GetCurrentWorkingDirectory ()

static bool	SetProcessLimits (EProcessResource::Type Resource, uint64 Limit)

static CORE_API const FString	ShaderWorkingDir ()

static CORE_API void	CleanShaderWorkingDir ()

static CORE_API const TCHAR *	ExecutablePath ()

static CORE_API const TCHAR *	ExecutableName (bool bRemoveExtension=true)

static CORE_API FString	GenerateApplicationPath (const FString &AppName, EBuildConfiguration BuildConfiguration)

static CORE_API const TCHAR *	GetArchitectureSuffix ()

static CORE_API const TCHAR *	GetModulePrefix ()

static CORE_API const TCHAR *	GetModuleExtension ()

static CORE_API const TCHAR *	GetBinariesSubdirectory ()

static CORE_API const FString	GetModulesDirectory ()

static CORE_API bool	ModuleExists (const FString &Filename)

static CORE_API void	LaunchURL (const TCHAR URL, const TCHAR Parms, FString *Error)

static CORE_API bool	LaunchURLFiltered (const TCHAR URL, const TCHAR Parms, FString *Error, const UE::Core::FURLRequestFilter &Filter)

static CORE_API bool	CanLaunchURL (const TCHAR *URL)

static CORE_API FString	GetGameBundleId ()

static CORE_API FProcHandle	CreateProc (const TCHAR URL, const TCHAR Parms, bool bLaunchDetached, bool bLaunchHidden, bool bLaunchReallyHidden, uint32 OutProcessID, int32 PriorityModifier, const TCHAR OptionalWorkingDirectory, void PipeWriteChild, void PipeReadChild=nullptr)

static CORE_API FProcHandle	CreateProc (const TCHAR URL, const TCHAR Parms, bool bLaunchDetached, bool bLaunchHidden, bool bLaunchReallyHidden, uint32 OutProcessID, int32 PriorityModifier, const TCHAR OptionalWorkingDirectory, void PipeWriteChild, void PipeReadChild, void *PipeStdErrChild)

static CORE_API TTuple< FProcHandle, UE::HAL::EProcessId >	CreateProc (const UE::HAL::FProcessStartInfo &StartInfo)

static CORE_API FProcHandle	OpenProcess (uint32 ProcessID)

static CORE_API bool	IsProcRunning (FProcHandle &ProcessHandle)

static CORE_API void	WaitForProc (FProcHandle &ProcessHandle)

static CORE_API void	CloseProc (FProcHandle &ProcessHandle)

static CORE_API void	TerminateProc (FProcHandle &ProcessHandle, bool KillTree=false)

static CORE_API void	TerminateProcTreeWithPredicate (FProcHandle &ProcessHandle, TFunctionRef< bool(uint32 ProcessId, const TCHAR *ApplicationName)> Predicate)

static CORE_API EWaitAndForkResult	WaitAndFork ()

static CORE_API bool	GetProcReturnCode (FProcHandle &ProcHandle, int32 *ReturnCode)

static CORE_API bool	IsApplicationRunning (uint32 ProcessId)

static CORE_API bool	IsApplicationRunning (const TCHAR *ProcName)

static CORE_API FString	GetApplicationName (uint32 ProcessId)

static CORE_API bool	GetApplicationMemoryUsage (uint32 ProcessId, SIZE_T *OutMemoryUsage)

static CORE_API bool	ExecProcess (const TCHAR URL, const TCHAR Params, int32 OutReturnCode, FString OutStdOut, FString OutStdErr, const TCHAR OptionalWorkingDirectory=NULL, bool bShouldEndWithParentProcess=false)

static CORE_API bool	ExecElevatedProcess (const TCHAR URL, const TCHAR Params, int32 *OutReturnCode)

static CORE_API bool	LaunchFileInDefaultExternalApplication (const TCHAR FileName, const TCHAR Parms=NULL, ELaunchVerb::Type Verb=ELaunchVerb::Open, bool bPromptToOpenOnFailure=true)

static CORE_API void	ExploreFolder (const TCHAR *FilePath)

static CORE_API void	ConditionalSleep (TFunctionRef< bool()> Condition, float SleepTime=0.0f)

static CORE_API class FEvent *	CreateSynchEvent (bool bIsManualReset=false)

static CORE_API class FEvent *	GetSynchEventFromPool (bool bIsManualReset=false)

static CORE_API void	FlushPoolSyncEvents ()

static CORE_API void	ReturnSynchEventToPool (FEvent *Event)

static CORE_API class FRunnableThread *	CreateRunnableThread ()

static CORE_API void	ClosePipe (void ReadPipe, void WritePipe)

static CORE_API bool	CreatePipe (void &ReadPipe, void &WritePipe, bool bWritePipeLocal=false)

static CORE_API FString	ReadPipe (void *ReadPipe)

static CORE_API bool	ReadPipeToArray (void *ReadPipe, TArray< uint8 > &Output)

static CORE_API bool	WritePipe (void WritePipe, const FString &Message, FString OutWritten=nullptr)

static CORE_API bool	WritePipe (void WritePipe, const uint8 Data, const int32 DataLength, int32 *OutDataLength=nullptr)

static CORE_API bool	SupportsMultithreading ()

static CORE_API FSemaphore *	NewInterprocessSynchObject (const FString &Name, bool bCreate, uint32 MaxLocks=1)

static CORE_API FSemaphore *	NewInterprocessSynchObject (const TCHAR *Name, bool bCreate, uint32 MaxLocks=1)

static CORE_API bool	DeleteInterprocessSynchObject (FSemaphore *Object)

static CORE_API bool	Daemonize ()

static CORE_API bool	IsFirstInstance ()

static CORE_API void	CeaseBeingFirstInstance ()

static CORE_API void	TearDown ()

static bool	SkipWaitForStats ()

static bool	TryGetMemoryUsage (FProcHandle &ProcessHandle, FPlatformProcessMemoryStats &OutStats)

static CORE_API ENamedThreads::Type	GetDesiredThreadForUObjectReferenceCollector ()

static CORE_API void	ModifyThreadAssignmentForUObjectReferenceCollector (int32 &NumThreads, int32 &NumBackgroundThreads, ENamedThreads::Type &NormalThreadName, ENamedThreads::Type &BackgroundThreadName)

static CORE_API TSharedPtr< IProcessSentinel >	CreateProcessSentinelObject ()

static CORE_API TSharedPtr< IProcessSentinel >	CreateProcessSentinel (const TCHAR *Name, const FString &Contents)

static void	Yield ()

static void	YieldCycles (uint64 Cycles)

Additional Inherited Members
Public Types inherited from FGenericPlatformProcess
enum class	EWaitAndForkResult : uint8 { Error , Parent , Child }

Detailed Description

iOS implementation of the Process OS functions

Member Function Documentation

◆ BaseDir()

const TCHAR * FIOSPlatformProcess::BaseDir ( )

static

◆ CanLaunchURL()

bool FIOSPlatformProcess::CanLaunchURL ( const TCHAR * URL )

static

◆ ComputerName()

const TCHAR * FIOSPlatformProcess::ComputerName ( )

static

◆ CreateRunnableThread()

FRunnableThread * FIOSPlatformProcess::CreateRunnableThread ( )

static

◆ ExecutableName()

const TCHAR * FIOSPlatformProcess::ExecutableName ( bool bRemoveExtension = true )

static

◆ ExecutablePath()

const TCHAR * FIOSPlatformProcess::ExecutablePath ( )

static

◆ GenerateApplicationPath()

FString FIOSPlatformProcess::GenerateApplicationPath	(	const FString &	AppName,
		EBuildConfiguration	BuildConfiguration
	)

static

◆ GetGameBundleId()

FString FIOSPlatformProcess::GetGameBundleId ( )

static

◆ LaunchSyncURL()

void FIOSPlatformProcess::LaunchSyncURL	(	const TCHAR *	URL,
		const TCHAR *	Parms,
		float	Timeout,
		FString *	Error
	)

static

Opens the specified URL and waits for it to open, up to the Timeout (s). If there's an error with the opening that's found within the timeout period, or a timeout occurs, Error is set to "Unable to open url"

Parameters

URL	The url to open
Parms	Not currently used
Timeout	The length of time to wait (in seconds) before it times out
Error	Either blank or with an error message if fails to open or times out

◆ LaunchURL()

void FIOSPlatformProcess::LaunchURL	(	const TCHAR *	URL,
		const TCHAR *	Parms,
		FString *	Error
	)

static

◆ SetThreadAffinityMask()

void FIOSPlatformProcess::SetThreadAffinityMask ( uint64 AffinityMask )

static

◆ SetupGameThread()

void FIOSPlatformProcess::SetupGameThread ( )

static

◆ SetupRenderThread()

void FIOSPlatformProcess::SetupRenderThread ( )

static

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

Engine/Source/Runtime/Core/Public/IOS/IOSPlatformProcess.h
Engine/Source/Runtime/Core/Private/IOS/IOSPlatformProcess.cpp

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BaseDir()

◆ CanLaunchURL()

◆ ComputerName()

◆ CreateRunnableThread()

◆ ExecutableName()

◆ ExecutablePath()

◆ GenerateApplicationPath()

◆ GetGameBundleId()

◆ LaunchSyncURL()

◆ LaunchURL()

◆ SetThreadAffinityMask()

◆ SetupGameThread()

◆ SetupRenderThread()