Class Settings

Namespace

DuetWebServer

Assembly

DuetWebServer.dll

This class holds settings for DuetWebServer

public sealed class Settings

Inheritance

object

Settings

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Settings()

public Settings()

Properties

DefaultWebDirectory

Default directory to serve web content from

public string DefaultWebDirectory { get; set; }

Property Value

string

KeepAliveInterval

Keep-alive interval for WebSocket connections (in s)

public int KeepAliveInterval { get; set; }

Property Value

int

MaxAge

Maximum age of cached resources before they must be refreshed (in s)

public int MaxAge { get; set; }

Property Value

int

Remarks

The index file is never cached to allow browsers to detect changes after updates

ModelRetryDelay

Time to wait before attempting to subscribe to the DSF OM again (in ms)

public int ModelRetryDelay { get; set; }

Property Value

int

OverrideWebDirectory

Override web directory from directories.web with a custom path

public string? OverrideWebDirectory { get; set; }

Property Value

string

OverrideWebPassword

Override configured machine password

public string? OverrideWebPassword { get; set; }

Property Value

string

SessionTimeout

Timeout for web sessions (in ms)

public int SessionTimeout { get; set; }

Property Value

int

SocketPath

Full filename of the DSF IPC socket to use

public string SocketPath { get; set; }

Property Value

string

StartErrorFile

File holding the last known start-up error of DCS in case it failed to start

public string StartErrorFile { get; set; }

Property Value

string

UseStaticFiles

Provide static settings from 0:/www

public bool UseStaticFiles { get; set; }

Property Value

bool

WebSocketBufferSize

Buffer size for custom WebSocket connections

public int WebSocketBufferSize { get; set; }

Property Value

int