Twyr Web Application Server

TwyrApplication

The Twyr Server Application Class.

Constructor

new TwyrApplication(parentopt, loaderopt)

The Application Class for this server.

Source:

server/twyr-application-class.js, line 20

The Application Class for this server.

This class has two major functionalities:

Provide an environment for the rest of the server modules to reside in
Load / Unload the server modules and control the Startup / Shutdown sequences

Parameters:

Name	Type	Attributes	Description
`parent`	TwyrBaseModule	<optional>	The parent module, if any. In this case, it's always null
`loader`	TwyrModuleLoader	<optional>	The loader to be used for managing modules' lifecycle, if any.

Extends

TwyrBaseModule

Members

(readonly) basePath :string

Source:

framework/twyr-base-class.js, line 58

Overrides:

TwyrBaseModule#basePath

Type:

string

(readonly) dependencies :Object

Source:

framework/twyr-base-module.js, line 562

Inherited From:

TwyrBaseModule#dependencies

Type:

Object

(readonly) name :string

Source:

framework/twyr-base-class.js, line 47

Overrides:

TwyrBaseModule#name

Type:

string

Methods

(async) _changeState(newState) → {undefined}

Enables / disables this module, and all its sub-modules (if any).

Source:

framework/twyr-base-module.js, line 401

Inherited From:

TwyrBaseModule#_changeState

Parameters:

Name	Type	Description
`newState`	Object	The next state of this module.

Returns:

Nothing.

Type: undefined

(async) _dependencyReconfigure(dependency) → {undefined}

Lets the module know that one of its dependencies changed configuration.

Source:

framework/twyr-base-module.js, line 381

Inherited From:

TwyrBaseModule#_dependencyReconfigure

Parameters:

Name	Type	Description
`dependency`	TwyrBaseModule	The dependency that changed configuration.

Returns:

Nothing.

Type: undefined

(async) _dependencyStateChange(dependency, newState) → {undefined}

Lets the module know that one of its dependencies changed state.

Source:

framework/twyr-base-module.js, line 491

Inherited From:

TwyrBaseModule#_dependencyStateChange

Parameters:

Name	Type	Description
`dependency`	TwyrBaseModule	The dependency that changed state.
`newState`	Object	The next state of the dependency.

Returns:

Nothing.

Type: undefined

(async) _exists(filepath, mode) → {boolean}

Checks to see if the path can be accessed by this process using the mode specified.

Source:

framework/twyr-base-module.js, line 522

Inherited From:

TwyrBaseModule#_exists

Parameters:

Name	Type	Description
`filepath`	string	Path of the filesystem entity.
`mode`	number	Permission to be checked for.

Returns:

True / False.

Type: boolean

_handleUncaughtException(err) → {undefined}

Logs Unhandled Exceptions to prevent the process from crashing.

Source:

framework/twyr-base-class.js, line 31

Inherited From:

TwyrBaseClass#_handleUncaughtException

Parameters:

Name	Type	Description
`err`	Error	The unhandled exception.

Returns:

Nothing.

Type: undefined

(async) _parentReconfigure() → {undefined}

Lets the module know that its parent changed configuration.

Source:

framework/twyr-base-module.js, line 365

Inherited From:

TwyrBaseModule#_parentReconfigure

Returns:

Nothing.

Type: undefined

(async) _parentStateChange(newState) → {undefined}

Lets the module know that its parent changed state.

Source:

framework/twyr-base-module.js, line 471

Inherited From:

TwyrBaseModule#_parentStateChange

Parameters:

Name	Type	Description
`newState`	Object	The next state of the parent module.

Returns:

Nothing.

Type: undefined

(async) _reconfigure(newConfig) → {undefined}

Changes the configuration of this module, and informs everyone interested.

Source:

framework/twyr-base-module.js, line 281

Inherited From:

TwyrBaseModule#_reconfigure

Parameters:

Name	Type	Description
`newConfig`	Object	The changed confoguration.

Returns:

Nothing.

Type: undefined

(async) _setup() → {undefined}

To be implemented by derived classes for setting themselves up.

Source:

framework/twyr-base-module.js, line 247

Inherited From:

TwyrBaseModule#_setup

Returns:

Nothing.

Type: undefined

(async) _subModuleReconfigure(subModule) → {undefined}

Lets the module know that one of its subModules changed configuration.

Source:

framework/twyr-base-module.js, line 347

Overrides:

TwyrBaseModule#_subModuleReconfigure

Parameters:

Name	Type	Description
`subModule`	TwyrBaseModule	The sub-module that changed configuration.

Returns:

Nothing.

Type: undefined

(async) _subModuleStateChange(subModule, newState) → {undefined}

Lets the module know that one of its subModules changed state.

Source:

framework/twyr-base-module.js, line 452

Inherited From:

TwyrBaseModule#_subModuleStateChange

Parameters:

Name	Type	Description
`subModule`	TwyrBaseModule	The sub-module that changed state.
`newState`	Object	The next state of the sub-module.

Returns:

Nothing.

Type: undefined

(async) _teardown() → {undefined}

To be implemented by derived classes for un-setting themselves down.

Source:

framework/twyr-base-module.js, line 263

Inherited From:

TwyrBaseModule#_teardown

Returns:

Nothing.

Type: undefined

bootupServer() → {Array}

Loads / Initializes / Starts-up sub-modules.

Source:

server/twyr-application-class.js, line 47

Returns:

The aggregated status returned by sub-modules (if any).

Type: Array

(async) initialize() → {Object}

Initializes sub-modules, if any.

Source:

framework/twyr-base-module.js, line 101

Inherited From:

TwyrBaseModule#initialize

Call the loader (typically, TwyrModuleLoader#initialize) to initialize sub-modules, if any.

Returns:

The aggregated status returned by sub-modules (if any) once they complete their initialization.

Type: Object

(async) load(configSrvc) → {Object}

Loads sub-modules, if any.

Source:

framework/twyr-base-module.js, line 64

Inherited From:

TwyrBaseModule#load

Use the supplied ConfigurationService instance (if any), to get / store both configuration and state.
Call the loader (typically, TwyrModuleLoader#load) to load sub-modules, if any.

Parameters:

Name	Type	Description
`configSrvc`	ConfigurationService	Instance of the `ConfigurationService` that supplies configuration.

Returns:

The aggregated status returned by sub-modules (if any) once they complete their loading.

Type: Object

shutdownServer() → {Array}

Shuts-down / Un-initializes / Un-loads sub-modules.

Source:

server/twyr-application-class.js, line 109

Returns:

The aggregated status returned by sub-modules (if any).

Type: Array

(async) start(dependencies) → {Object}

Starts sub-modules, if any.

Source:

framework/twyr-base-module.js, line 127

Inherited From:

TwyrBaseModule#start

Call the loader (typically, TwyrModuleLoader#start) to start sub-modules, if any.

Parameters:

Name	Type	Description
`dependencies`	Object	Interfaces to `TwyrBaseService` instances that this module depends on.

Returns:

The aggregated status returned by sub-modules (if any) once they complete their startup sequences.

Type: Object

(async) stop() → {Object}

Stops sub-modules, if any.

Source:

framework/twyr-base-module.js, line 167

Inherited From:

TwyrBaseModule#stop

Call the loader (typically, TwyrModuleLoader#stop) to shutdown sub-modules, if any.

Returns:

The aggregated status returned by sub-modules (if any) once they complete their shutdown sequences.

Type: Object

(async) uninitialize() → {Object}

Uninitializes sub-modules, if any.

Source:

framework/twyr-base-module.js, line 195

Inherited From:

TwyrBaseModule#uninitialize

Call the loader (typically, TwyrModuleLoader#uninitialize) to uninitialize sub-modules, if any.

Returns:

The aggregated status returned by sub-modules (if any) once they uninitialize themselves.

Type: Object

(async) unload() → {Object}

Unloads sub-modules, if any.

Source:

framework/twyr-base-module.js, line 221

Inherited From:

TwyrBaseModule#unload

Call the loader (typically, TwyrModuleLoader#unload) to unload sub-modules, if any.

Returns:

The aggregated status returned by sub-modules (if any) once they unload themselves.

Type: Object