Navigation
API > API/Developer > API/Developer/Zen
A representation of a Zen service instance. Generally not accessed directly, but via FScopeZenService.
| Name | FZenServiceInstance |
| Type | class |
| Header File | /Engine/Source/Developer/Zen/Public/Experimental/ZenServerInterface.h |
| Include Path | #include "Experimental/ZenServerInterface.h" |
Syntax
class FZenServiceInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Experimental/ZenServerInterface.h | |||
FZenServiceInstance
(
FStringView InstanceURL |
Experimental/ZenServerInterface.h | ||
FZenServiceInstance
(
FServiceSettings&& InSettings |
Experimental/ZenServerInterface.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FZenServiceInstance() |
Experimental/ZenServerInterface.h |
Enums
Public
| Name | Remarks |
|---|---|
| ERecoveryMode |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AutoLaunchedPid | uint32 | Experimental/ZenServerInterface.h | |
| AutoLaunchedPort | uint16 | Experimental/ZenServerInterface.h | |
| DefaultSmallOperationConnectTimeoutMS | const uint32 | Experimental/ZenServerInterface.h | |
| DefaultSmallOperationTimeoutMS | const uint32 | Experimental/ZenServerInterface.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasLaunchedLocal | bool | Experimental/ZenServerInterface.h | ||
| bHasLaunchedSystemService | bool | Experimental/ZenServerInterface.h | ||
| bIsRunningLocally | bool | Experimental/ZenServerInterface.h | ||
| CacheStatsRequest | TFuture< FZenCacheStats > | Experimental/ZenServerInterface.h | ||
| Endpoint | FZenServiceEndpoint | Experimental/ZenServerInterface.h | ||
| GCStatusRequest | TFuture< TOptional< FGCStatus > > | Experimental/ZenServerInterface.h | ||
| LastCacheStats | FZenCacheStats | Experimental/ZenServerInterface.h | ||
| LastCacheStatsMutex | FMutex | Experimental/ZenServerInterface.h | ||
| LastCacheStatsTime | uint64 | Experimental/ZenServerInterface.h | ||
| LastGCStatus | TOptional< FGCStatus > | Experimental/ZenServerInterface.h | ||
| LastGCStatusTime | uint64 | Experimental/ZenServerInterface.h | ||
| LastProjectStats | FZenProjectStats | Experimental/ZenServerInterface.h | ||
| LastProjectStatsMutex | FMutex | Experimental/ZenServerInterface.h | ||
| LastProjectStatsTime | uint64 | Experimental/ZenServerInterface.h | ||
| ProjectStatsRequest | TFuture< FZenProjectStats > | Experimental/ZenServerInterface.h | ||
| Settings | FServiceSettings | Experimental/ZenServerInterface.h | ||
| WorkspacesRequest | TFuture< FZenWorkspaces > | Experimental/ZenServerInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddSponsorProcessIDs
(
TArrayView< uint32 > SponsorProcessIDs |
Experimental/ZenServerInterface.h | ||
bool GatherAnalytics
(
TArray< FAnalyticsEventAttribute >& Attributes |
Experimental/ZenServerInterface.h | ||
bool GetCacheStats
(
FZenCacheStats& Stats |
Experimental/ZenServerInterface.h | ||
const FZenServiceEndpoint & GetEndpoint() |
Experimental/ZenServerInterface.h | ||
bool GetGCStatus
(
FGCStatus& Status |
Experimental/ZenServerInterface.h | ||
const FString GetPath() |
Experimental/ZenServerInterface.h | ||
bool GetProjectStats
(
FZenProjectStats& Stats |
Experimental/ZenServerInterface.h | ||
const FServiceSettings & GetServiceSettings() |
Experimental/ZenServerInterface.h | ||
int32 GetWorkspaceCount() |
Experimental/ZenServerInterface.h | ||
bool GetWorkspaces
(
FZenWorkspaces& Workspaces |
Experimental/ZenServerInterface.h | ||
bool IsServiceReady() |
Experimental/ZenServerInterface.h | ||
bool IsServiceRunning() |
Experimental/ZenServerInterface.h | ||
bool IsServiceRunningLocally() |
Experimental/ZenServerInterface.h | ||
bool RequestGC
(
const bool* OverrideCollectSmallObjects, |
Experimental/ZenServerInterface.h | ||
bool TryRecovery
(
ERecoveryMode RecoveryMode |
Experimental/ZenServerInterface.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool AutoLaunch
(
const FServiceAutoLaunchSettings& InSettings, |
Experimental/ZenServerInterface.h | ||
static uint16 GetAutoLaunchedPort() |
Experimental/ZenServerInterface.h |