UDocumentation
UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
GenericPlatformHostCommunication.h
Go to the documentation of this file.
1
// Copyright Epic Games, Inc. All Rights Reserved.
2
3
#pragma once
4
5
#include "
CoreTypes.h
"
6
#include "
Containers/UnrealString.h
"
7
#include "
GenericPlatform/GenericPlatformHostSocket.h
"
8
9
10
18
enum
EHostProtocol
19
{
20
CookOnTheFly
= 0
21
};
22
23
31
class
IPlatformHostCommunication
32
{
33
public
:
34
38
virtual
void
Initialize
() = 0;
39
43
virtual
void
Shutdown
() = 0;
44
50
virtual
bool
Available
()
const
= 0;
51
70
virtual
IPlatformHostSocketPtr
OpenConnection
(
uint32
ProtocolIndex,
const
FString& DebugName,
uint32
Version = 0,
uint32
MinVersion
= 0) = 0;
71
76
virtual
void
CloseConnection
(
IPlatformHostSocketPtr
Socket) = 0;
77
84
virtual
bool
LaunchOnHost
(
const
char
*
BinaryPath
,
const
char
* CmdLine =
nullptr
) = 0;
85
89
virtual
~IPlatformHostCommunication
()
90
{
91
}
92
};
93
94
98
class
FGenericPlatformHostCommunication
:
public
IPlatformHostCommunication
99
{
100
public
:
101
102
virtual
void
Initialize
()
override
103
{
104
}
105
106
virtual
void
Shutdown
()
override
107
{
108
}
109
110
virtual
bool
Available
()
const override
111
{
112
return
false
;
113
}
114
115
virtual
IPlatformHostSocketPtr
OpenConnection
(
uint32
ProtocolIndex,
const
FString& DebugName,
uint32
Version = 0,
uint32
MinVersion
= 0)
override
116
{
117
return
nullptr
;
118
}
119
120
void
CloseConnection
(
IPlatformHostSocketPtr
Socket)
override
121
{
122
}
123
124
bool
LaunchOnHost
(
const
char
*
BinaryPath
,
const
char
* CmdLine =
nullptr
)
override
125
{
126
return
false
;
127
}
128
};
129
130
134
template
<
typename
T>
135
struct
FPlatformHostCommunicationAutoInit
136
{
137
FPlatformHostCommunicationAutoInit
()
138
{
139
HostCommunication
.Initialize();
140
}
141
142
~FPlatformHostCommunicationAutoInit
()
143
{
144
HostCommunication
.Shutdown();
145
}
146
147
operator
T& ()
148
{
149
return
HostCommunication
;
150
}
151
152
T
HostCommunication
;
153
};
CoreTypes.h
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition
SharedPointer.h:127
EHostProtocol
EHostProtocol
Definition
GenericPlatformHostCommunication.h:19
GenericPlatformHostSocket.h
UnrealString.h
uint32
uint32_t uint32
Definition
binka_ue_file_header.h:6
CookOnTheFly
Definition
CookOnTheFly.Build.cs:6
FGenericPlatformHostCommunication
Definition
GenericPlatformHostCommunication.h:99
FGenericPlatformHostCommunication::Available
virtual bool Available() const override
Definition
GenericPlatformHostCommunication.h:110
FGenericPlatformHostCommunication::CloseConnection
void CloseConnection(IPlatformHostSocketPtr Socket) override
Definition
GenericPlatformHostCommunication.h:120
FGenericPlatformHostCommunication::Initialize
virtual void Initialize() override
Definition
GenericPlatformHostCommunication.h:102
FGenericPlatformHostCommunication::OpenConnection
virtual IPlatformHostSocketPtr OpenConnection(uint32 ProtocolIndex, const FString &DebugName, uint32 Version=0, uint32 MinVersion=0) override
Definition
GenericPlatformHostCommunication.h:115
FGenericPlatformHostCommunication::LaunchOnHost
bool LaunchOnHost(const char *BinaryPath, const char *CmdLine=nullptr) override
Definition
GenericPlatformHostCommunication.h:124
FGenericPlatformHostCommunication::Shutdown
virtual void Shutdown() override
Definition
GenericPlatformHostCommunication.h:106
IPlatformHostCommunication
Definition
GenericPlatformHostCommunication.h:32
IPlatformHostCommunication::~IPlatformHostCommunication
virtual ~IPlatformHostCommunication()
Definition
GenericPlatformHostCommunication.h:89
IPlatformHostCommunication::LaunchOnHost
virtual bool LaunchOnHost(const char *BinaryPath, const char *CmdLine=nullptr)=0
IPlatformHostCommunication::OpenConnection
virtual IPlatformHostSocketPtr OpenConnection(uint32 ProtocolIndex, const FString &DebugName, uint32 Version=0, uint32 MinVersion=0)=0
IPlatformHostCommunication::Available
virtual bool Available() const =0
IPlatformHostCommunication::Initialize
virtual void Initialize()=0
IPlatformHostCommunication::Shutdown
virtual void Shutdown()=0
IPlatformHostCommunication::CloseConnection
virtual void CloseConnection(IPlatformHostSocketPtr Socket)=0
TSharedPtr< IPlatformHostSocket, ESPMode::ThreadSafe >
FPlatformHostCommunicationAutoInit
Definition
GenericPlatformHostCommunication.h:136
FPlatformHostCommunicationAutoInit::HostCommunication
T HostCommunication
Definition
GenericPlatformHostCommunication.h:152
FPlatformHostCommunicationAutoInit::FPlatformHostCommunicationAutoInit
FPlatformHostCommunicationAutoInit()
Definition
GenericPlatformHostCommunication.h:137
FPlatformHostCommunicationAutoInit::~FPlatformHostCommunicationAutoInit
~FPlatformHostCommunicationAutoInit()
Definition
GenericPlatformHostCommunication.h:142
Engine
Source
Runtime
Core
Public
GenericPlatform
GenericPlatformHostCommunication.h
Generated by
1.9.8