IRemoteSessionModule

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

IRemoteSessionModule

References

Module

RemoteSession

Header

/Engine/Plugins/Experimental/RemoteSession/Source/RemoteSession/Public/RemoteSession.h

Include

#include "RemoteSession.h"

Syntax

class IRemoteSessionModule : public IModuleInterface

Functions

Name Description

Public function

void

 

AddChannelFactory

(
    const FStringView InChannelName,
    ERemoteSessionChannelMode InHostMod...,
    TWeakPtr< IRemoteSessionChannelFact...
)

Register a third party channel

Public function

TSharedPtr< ...

 

CreateClient

(
    const TCHAR* RemoteAddress
)

Client implementation Returns a reference to the client role (if any)

Public function Const

TSharedPtr< ...

 

CreateHost

(
    TArray< FRemoteSessionChannelInfo >...,
    int32 Port
)

Returns host that is not controlled by the module

Public function Const

TSharedPtr< ...

 

GetHost()

Returns a reference to the server role (if any)

Public function Static

FString

 

GetLastSupportedVersion()

Public function Static

FString

 

GetLocalVersion()

Public function

void

 

InitHost

(
    const int16 Port
)

Server implementation Starts a RemoteSession server that listens for clients on the provided port

Public function Const

bool

 

IsHostConnected()

Returns true/false if a client is connected

Public function Const

bool

 

IsHostRunning()

Returns true/false based on the running state of the host server

Public function

void

 

RemoveChannelFactory

(
    TWeakPtr< IRemoteSessionChannelFact...
)

Unregister a channel factory

Public function

void

 

StopClient

(
    TSharedPtr< IRemoteSessionRole > Cl...,
    const FString& InReason
)

Stops the client.

Public function

void

 

StopHost

(
    const FString& InReason
)

Stops the server, after this InitHost() must be called if a new connection is desired

Overridden from IModuleInterface

Name Description

Public function

void

 

ShutdownModule()

Called before the module is unloaded, right before the module object is destroyed.

Public function

void

 

StartupModule()

IModuleInterface implementation

Constants

Name

Description

kDefaultPort

End IModuleInterface implementation
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss