Navigation
API > API/Plugins > API/Plugins/RemoteSession
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
| Type | Name | Description | |
|---|---|---|---|
 |
void | AddChannelFactory
(
const FStringView InChannelName, |
Register a third party channel |
 |
TSharedPtr< IRemoteSessionRole > | CreateClient
(
const TCHAR* RemoteAddress |
Client implementation Returns a reference to the client role (if any) |
  |
TSharedPtr< IRemoteSessionUnmanagedRole > | CreateHost
(
TArray< FRemoteSessionChannelInfo > SupportedChannels, |
Returns host that is not controlled by the module |
  |
TSharedPtr< IRemoteSessionRole > | GetHost () |
Returns a reference to the server role (if any) |
  |
FString | ||
  |
FString | ||
 |
void | InitHost
(
const int16 Port |
Server implementation Starts a RemoteSession server that listens for clients on the provided port |
  |
bool | Returns true/false if a client is connected | |
  |
bool | Returns true/false based on the running state of the host server | |
 |
void | RemoveChannelFactory
(
TWeakPtr< IRemoteSessionChannelFactoryWorker > Worker |
Unregister a channel factory |
 |
void | StopClient
(
TSharedPtr< IRemoteSessionRole > Client, |
Stops the client. |
 |
void | Stops the server, after this InitHost() must be called if a new connection is desired |
Overridden from IModuleInterface
| Type | Name | Description | |
|---|---|---|---|
 |
void | Called before the module is unloaded, right before the module object is destroyed. | |
 |
void | IModuleInterface implementation |
Constants
| Name | Description |
|---|---|
| kDefaultPort | End IModuleInterface implementation |