remoting/webapp/base/js/logger.js

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5
   6 /** @suppress {duplicate} */
   7 var remoting = remoting || {};
   8
   9 (function() {
  10
  11 'use strict';
  12
  13 /**
  14  * @interface
  15  */
  16 remoting.Logger = function() {};
  17
  18 /**
  19  * @param {number} totalTime The value of time taken to complete authorization.
  20  * @return {void} Nothing.
  21  */
  22 remoting.Logger.prototype.setAuthTotalTime = function(totalTime) {};
  23
  24 /**
  25  * @param {string} hostVersion Version of the host for current session.
  26  * @return {void} Nothing.
  27  */
  28 remoting.Logger.prototype.setHostVersion = function(hostVersion) {};
  29
  30 /**
  31  * Set the connection type (direct, stun relay).
  32  *
  33  * @param {string} connectionType
  34  */
  35 remoting.Logger.prototype.setConnectionType = function(connectionType) {};
  36
  37 /**
  38  * @param {remoting.ChromotingEvent.Mode} mode
  39  */
  40 remoting.Logger.prototype.setLogEntryMode = function(mode) {};
  41
  42
  43 /**
  44  * @param {remoting.SignalStrategy.Type} strategyType
  45  * @param {remoting.FallbackSignalStrategy.Progress} progress
  46  */
  47 remoting.Logger.prototype.logSignalStrategyProgress =
  48     function(strategyType, progress) {};
  49
  50 /**
  51  * Logs a client session state change.
  52  *
  53  * @param {remoting.ClientSession.State} state
  54  * @param {!remoting.Error} connectionError
  55  * @param {?remoting.ChromotingEvent.XmppError} xmppError The XMPP error
  56  *     as described in http://xmpp.org/rfcs/rfc6120.html#stanzas-error.
  57  *     Set if the connecton error originates from the an XMPP stanza error.
  58  */
  59 remoting.Logger.prototype.logClientSessionStateChange =
  60     function(state, connectionError, xmppError) {};
  61
  62 /**
  63  * Logs connection statistics.
  64  * @param {Object<number>} stats The connection statistics
  65  */
  66 remoting.Logger.prototype.logStatistics = function(stats) {};
  67
  68
  69 /**
  70  * @return {string} The current session id. This is random GUID, refreshed
  71  *     every 24hrs.
  72  */
  73 remoting.Logger.prototype.getSessionId = function() {};
  74
  75 // The maximum age of a session ID, in milliseconds.
  76 remoting.Logger.MAX_SESSION_ID_AGE = 24 * 60 * 60 * 1000;
  77
  78 // The time over which to accumulate connection statistics before logging them
  79 // to the server, in milliseconds.
  80 remoting.Logger.CONNECTION_STATS_ACCUMULATE_TIME = 60 * 1000;
  81
  82 })();