Navigation
API > API/Plugins > API/Plugins/WebSocketNetworking
Represents a directory on disk that can be mapped to a url route and served.
For example we may wish to map C:/www/Public_ to /_ of our webserver.
| Name | FWebSocketHttpMount |
| Type | class |
| Header File | /Engine/Plugins/Experimental/WebSocketNetworking/Source/WebSocketNetworking/Public/IWebSocketServer.h |
| Include Path | #include "IWebSocketServer.h" |
Syntax
class FWebSocketHttpMount
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DefaultFile | std::string | When the root of the `WebPath_ is requested, without a file, we can serve this file, e.g. index.html | IWebSocketServer.h | |
| PathOnDisk | std::string | The absolute path on disk to directory we wish to serve. | IWebSocketServer.h | |
| WebPath | std::string | The web url path to use for this mount, e.g. /images | IWebSocketServer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const char * GetDefaultFile() |
IWebSocketServer.h | ||
const char * GetPathOnDisk() |
IWebSocketServer.h | ||
const char * GetWebPath() |
IWebSocketServer.h | ||
bool HasDefaultFile() |
IWebSocketServer.h | ||
void SetDefaultFile
(
const FString& InDefaultFile |
Sets a file to serve when the root web path is requested. | IWebSocketServer.h | |
void SetPathOnDisk
(
const FString& InPathOnDisk |
Sets the absolute path on disk to the directory we wish to serve. | IWebSocketServer.h | |
void SetWebPath
(
const FString& InWebPath |
Sets The web url path to use for this mount, e.g. /images . | IWebSocketServer.h |