Gets the container's communication manager.
Gets the container object of this controller.
Gets a boolean observable that emits true if the
connection state of the associated communication manager
transitions to offline, and false if it transitions to
online. When subscribed, the current connection state is
emitted immediately.
Gets the controller's options as specified in the configuration options.
Gets the registered name of this controller.
The registered name is either defined by the corresponding key in the
Components.controllers object in the container configuration, or by
invoking Container.registerController method with this name.
Gets the container's Runtime object.
Whenever one of the controller's log methods (e.g. logDebug, logInfo,
logWarning, logError, logFatal) is called by application code, the
controller creates a Log object with appropriate property values and
passes it to this method before advertising it.
You can override this method to additionally set certain properties (such
as LogHost.hostname or Log.logLabels). Ensure that
super.extendLogObject is called in your override. The base method does
nothing.
log object to be extended before being advertised
Advertise a Log object for debugging purposes.
a debug message
any number of log tags
Advertise a Log object for an error.
an error (object)
additional error message
any number of log tags
Advertise a Log object for an error with stacktrace information.
an error (object)
additional error message
any number of log tags
Advertise a Log object for a fatal error.
an error (object)
additional error message
any number of log tags
Advertise an informational Log object.
an informational message
any number of log tags
Advertise a Log object for a warning.
a warning message
any number of log tags
Called when the communication manager is about to start or restart.
Override this method to implement side effects here. Ensure that
super.onCommunicationManagerStarting is called in your override. The
base implementation does nothing.
Called when the communication manager is about to stop.
Override this method to implement side effects here. Ensure that
super.onCommunicationManagerStopping is called in your override. The
base implementation does nothing.
Called by the container when this instance should be disposed.
Implement cleanup side effects here. Ensure that super.onDispose is
called in your override. The base implementation does nothing.
Called when the container has completely set up and injected all dependency components, including all its controllers.
Override this method to perform initializations in your custom controller
class instead of defining a constructor. Although the base implementation
does nothing it is good practice to call super.onInit() in your
override method; especially if your custom controller class does not
extend from the base Controller class directly.
Generated using TypeDoc
A convenience controller that monitors the connection state (online or offline) of the associated communication manager.