Monitor.js

/**
* @classdesc Represents the current state of the system. Instances of this class should be obtained using 
* {@link system#getMonitor system.getMonitor()}.
* @class
* @hideconstructor
*/

Monitor = function () {
      /**
       * Returns an array of Connection objects, each describing a single connection that currently connected to the system.
       *
       * @method
       * @return {Connection[]} Array of Connection objects.
     */
      this.getConnections = function () { };

      /**
       * Returns an array of Connection objects, each describing a single connection that currently connected to the system.
       *
       * @method
        * @param {String} siteID ID of site (from Connection object).
        * @param {String} sessionID ID of session (from Connection object).
       * @return {Connection[]} Array of Connection objects.
       */
      this.killSession = function (siteID, sessionID) { }
};


/**
 * Connection information.
 * @typedef {Object} Connection
 * @property {String} sessionID ID of session to which the connection belongs.
 * @property {String} siteID ID of site that the connection is connected to.
 * @property {Date} connectTime Time when the connection was established.
 * @property {Date} loginTime Time when the client logged in.
 * @property {String} userName Username of the session.
 * @property {String} siteName Name of site that the connection is connected to.
 * @property {Number} localPort Local port that that the connection is connected to.
 * @property {String} remoteAddress IP address of client.
 * @property {Number} remotePort Port of client end of the connection.
 * @property {String} protocol Protocol being used.
 * @property {Number} diskUsage Disk usage (null if no quota is set for the user).
 */