WebSocketsProtocols

WebSocketsProtocols

#Overview

name: WebSocketsProtocols

The value of this variable can be defined or overridden in .ini config files. 6 .ini config files referencing this setting variable.

It is referenced in 1 C++ source file.

#Summary

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEngine.ini:68, section: [WebSockets]

• INI Section: WebSockets
• Raw value: "ws"
• Is Array: True

Location: <Workspace>/Engine/Config/BaseEngine.ini:69, section: [WebSockets]

• INI Section: WebSockets
• Raw value: "wss"
• Is Array: True

Location: <Workspace>/Engine/Config/BaseEngine.ini:70, section: [WebSockets]

• INI Section: WebSockets
• Raw value: "v10.stomp"
• Is Array: True

Location: <Workspace>/Engine/Config/BaseEngine.ini:71, section: [WebSockets]

• INI Section: WebSockets
• Raw value: "v11.stomp"
• Is Array: True

Location: <Workspace>/Engine/Config/BaseEngine.ini:72, section: [WebSockets]

• INI Section: WebSockets
• Raw value: "v12.stomp"
• Is Array: True

Location: <Workspace>/Engine/Config/BaseEngine.ini:73, section: [WebSockets]

• INI Section: WebSockets
• Raw value: "xmpp"
• Is Array: True

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Runtime/Online/WebSockets/Private/WebSocketsModule.cpp:32

Scope (from outer to inner):

file
function     void FWebSocketsModule::StartupModule

Source code excerpt:

	// Default configuration values can be found in BaseEngine.ini
	TArray<FString> Protocols;
	GConfig->GetArray(TEXT("WebSockets"), TEXT("WebSocketsProtocols"), Protocols, GEngineIni);
	if (Protocols.IsEmpty())
	{
		Protocols.Add(TEXT("ws"));
		Protocols.Add(TEXT("wss"));
	}