Legend

Class
Struct
Enum
Interface
Delegate
Constructor
Method
Property
Event
Field

Sealed class: RT.PropellerApi.PropellerSettings

Summary

Contains settings which are related to the Propeller engine, and not to any individual module.

Constructors

Creates a new instance of PropellerSettings.

Instance methods

void
Delete(string filename = null, SettingsOnFailure onFailure = SettingsOnFailure.Throw)
Deletes the settings file.
void
Save(string filename = null, SettingsSerializer? serializer = null, SettingsOnFailure onFailure = SettingsOnFailure.Throw)

Saves the settings.

This method is fully compatible with SettingsThreadedBase.SaveThreaded(string, SettingsSerializer?), and will cancel any pending earlier (older) saves.

void
SaveLoud(string filename = null, SettingsSerializer? serializer = null)

Saves the settings. Intended to be used whenever the settings are important enough to bug the user if this fails.

This method is fully compatible with SettingsThreadedBase.SaveThreaded(string, SettingsSerializer?), and will cancel any pending earlier (older) saves.

void
SaveQuiet(string filename = null, SettingsSerializer? serializer = null)

Saves the settings. Intended to be used whenever the settings are not important enough to bug the user if this fails.

This method is fully compatible with SettingsThreadedBase.SaveThreaded(string, SettingsSerializer?), and will cancel any pending earlier (older) saves.

Instance properties

SettingsAttribute Gets the SettingsAttribute instance specified on this settings class, or null if none are specified.

Instance fields

stringIf not null, every HTTP request is logged to this file.
boolIf true, all HTTP requests are logged to the console.
string Specifies log verbosity for the HTTP access log. For usage, see LoggerBase.ConfigureVerbosity(string).
stringSpecifies the path and filename for the Propeller log, or null to keep no log.
string Specifies log verbosity for the Propeller log. For usage, see LoggerBase.ConfigureVerbosity(string).
PropellerModuleSettings[]Contains the configuration of all the Propeller modules.
HttpServerOptionsHttpServer configuration.
string The folder into which Propeller can place a copy of the module DLLs. Propeller will actually create (and later clean up) numbered subfolders in this folder. (see also remarks)