mvm_gui_open_webserverT_mvm_gui_open_webserverMvmGuiOpenWebserverMvmGuiOpenWebserver (Operator)

Name

mvm_gui_open_webserverT_mvm_gui_open_webserverMvmGuiOpenWebserverMvmGuiOpenWebserver — Open a GUI webserver.

Signature

mvm_gui_open_webserver( : : Port, RootDir, AllowRemote : ServerHandle)

Description

Opens a GUI webserver which listens for connections at the local host on port PortPortPortPortport. The server supplies a HTTP server serving files from the directory RootDirRootDirRootDirRootDirrootDir and a WebSocket server. The returned ServerHandleServerHandleServerHandleServerHandleserverHandle should be used to close the webserver at the end of the program with mvm_gui_close_webservermvm_gui_close_webserverMvmGuiCloseWebserverMvmGuiCloseWebserverMvmGuiCloseWebserver.

The root directory of the server must be an absolute path to an existing directory or a path relative to the current working directory (see also set_current_dirset_current_dirSetCurrentDirSetCurrentDirSetCurrentDir). The directory is resolved immediately when this operator is executed. It is therefore OK to change the working directory afterwards.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

PortPortPortPortport (input_control) integer → (integer)

GUI server port

Default value: 9980

RootDirRootDirRootDirRootDirrootDir (input_control) string(-array) → (string)

root directory. Only files in this directory or in its subdirectories are accessible.

Default value: '' "" "" "" ""

AllowRemoteAllowRemoteAllowRemoteAllowRemoteallowRemote (input_control) string → (string)

allow remote clients (contrary to allowing only access by the local host)

Default value: 'true' "true" "true" "true" "true"

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

ServerHandleServerHandleServerHandleServerHandleserverHandle (output_control) serial → (handle)

GUI server handle

Example (HDevelop)

mvm_gui_open_webserver (9980, 'client/app/', true, ServerHandle)

Module

Foundation

Operators