FGenericPlatformHostCommunication Class Reference

#include <GenericPlatformHostCommunication.h>

Inheritance diagram for FGenericPlatformHostCommunication:

Public Member Functions
virtual void	Initialize () override
virtual void	Shutdown () override
virtual bool	Available () const override
virtual IPlatformHostSocketPtr	OpenConnection (uint32 ProtocolIndex, const FString &DebugName, uint32 Version=0, uint32 MinVersion=0) override
void	CloseConnection (IPlatformHostSocketPtr Socket) override
bool	LaunchOnHost (const char *BinaryPath, const char *CmdLine=nullptr) override
Public Member Functions inherited from IPlatformHostCommunication
virtual	~IPlatformHostCommunication ()

Detailed Description

Generic implementation of IPlatformHostCommunication.

Member Function Documentation

Available()

virtual bool FGenericPlatformHostCommunication::Available ( ) const

inlineoverridevirtual

Check if the host communication system is available and can be used.

Returns

True is available, false otherwise.

Implements IPlatformHostCommunication.

CloseConnection()

void FGenericPlatformHostCommunication::CloseConnection ( IPlatformHostSocketPtr  Socket )

inlineoverridevirtual

Close a communication channel previously opened using OpenConnection.

Parameters

Socket

Socket object.

Implements IPlatformHostCommunication.

Initialize()

virtual void FGenericPlatformHostCommunication::Initialize ( )

inlineoverridevirtual

Initialize the host communication system (done by IPlatformFeaturesModule).

Implements IPlatformHostCommunication.

LaunchOnHost()

bool FGenericPlatformHostCommunication::LaunchOnHost ( const char *  BinaryPath, const char *  CmdLine = nullptr  )

inlineoverridevirtual

Launch an executable on the connected host PC.

Parameters

BinaryPath	Path to the executable on the PC to launch.
CmdLine	(optional) Command line parameters to pass to the executable.

Returns

True on success, otherwise false (e.g. no permissions or incorrect executable path).

Implements IPlatformHostCommunication.

OpenConnection()

virtual IPlatformHostSocketPtr FGenericPlatformHostCommunication::OpenConnection ( uint32  ProtocolIndex, const FString &  DebugName, uint32  Version = 0, uint32  MinVersion = 0  )

inlineoverridevirtual

Open a communication channel with the host PC.

The connected PC is determined in a platform-dependent way.

Note that opening a connection does not necessarily mean that the host PC is ready to communicate. Check the state of the socket before attempting to send/receive data. There can be only one connection using any given ProtocolIndex. Attempts to use a ProtocolIndex while there is already a connection using it will fail.

Parameters

ProtocolIndex	Arbitrary 0-based number indicating the communication channel (the same number needs to be used on the host PC).
DebugName	Name of this communication channel used for diagnostic purposes.
Version	(optional) Version of the communication protocol (ProtocolIndex) used to verify compatibility with the host PC.
MinVersion	(optional) Minimum version of the communication protocol (ProtocolIndex) that is supported.

Returns

Socket object on success, nullptr otherwise.

See also

CloseConnection, IPlatformHostSocket::GetState

Implements IPlatformHostCommunication.

Shutdown()

virtual void FGenericPlatformHostCommunication::Shutdown ( )

inlineoverridevirtual

Shutdown the host communication system (done by IPlatformFeaturesModule).

Implements IPlatformHostCommunication.

---

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

• Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformHostCommunication.h