components/error_page/common/net_error_info.h

   1 // Copyright (c) 2013 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 #ifndef COMPONENTS_ERROR_PAGE_COMMON_NET_ERROR_INFO_H_
   6 #define COMPONENTS_ERROR_PAGE_COMMON_NET_ERROR_INFO_H_
   7
   8 // TODO(hashimoto): Change this to namespace error_page.
   9 namespace chrome_common_net {
  10
  11 // Network error page events.  Used for UMA statistics.
  12 enum NetworkErrorPageEvent {
  13   NETWORK_ERROR_PAGE_SHOWN,                      // Error pages shown.
  14
  15   NETWORK_ERROR_PAGE_RELOAD_BUTTON_SHOWN,        // Reload buttons shown.
  16   NETWORK_ERROR_PAGE_RELOAD_BUTTON_CLICKED,      // Reload button clicked.
  17   NETWORK_ERROR_PAGE_RELOAD_BUTTON_ERROR,        // Reload button clicked
  18                                                  // -> error.
  19
  20   // Same for the "Show saved copy" button.
  21   NETWORK_ERROR_PAGE_SHOW_SAVED_COPY_BUTTON_SHOWN,
  22   NETWORK_ERROR_PAGE_SHOW_SAVED_COPY_BUTTON_CLICKED,
  23   NETWORK_ERROR_PAGE_SHOW_SAVED_COPY_BUTTON_ERROR,
  24
  25   NETWORK_ERROR_PAGE_MORE_BUTTON_CLICKED,        // More button clicked.
  26
  27   NETWORK_ERROR_PAGE_BROWSER_INITIATED_RELOAD,   // Reload from browser.
  28
  29   // Keep track of which button the user chooses when both are shown.
  30   NETWORK_ERROR_PAGE_BOTH_BUTTONS_SHOWN,
  31   NETWORK_ERROR_PAGE_BOTH_BUTTONS_RELOAD_CLICKED,
  32   NETWORK_ERROR_PAGE_BOTH_BUTTONS_SHOWN_SAVED_COPY_CLICKED,
  33
  34   NETWORK_ERROR_EASTER_EGG_ACTIVATED,            // Easter egg activated.
  35
  36   NETWORK_ERROR_PAGE_EVENT_MAX,
  37 };
  38
  39 // The status of a DNS probe.
  40 //
  41 // The DNS_PROBE_FINISHED_* values are used in histograms, so:
  42 // 1. FINISHED_UNKNOWN must remain the first FINISHED_* value.
  43 // 2. FINISHED_* values must not be rearranged relative to FINISHED_UNKNOWN.
  44 // 3. New FINISHED_* values must be inserted at the end.
  45 // 4. New non-FINISHED_* values cannot be inserted.
  46 enum DnsProbeStatus {
  47   // A DNS probe may be run for this error page.  (This status is only used on
  48   // the renderer side before it's received a status update from the browser.)
  49   DNS_PROBE_POSSIBLE,
  50
  51   // A DNS probe will not be run for this error page.  (This happens if the
  52   // user has the "Use web service to resolve navigation errors" preference
  53   // turned off, or if probes are disabled by the field trial.)
  54   DNS_PROBE_NOT_RUN,
  55
  56   // A DNS probe has been started for this error page.  The renderer should
  57   // expect to receive another IPC with one of the FINISHED statuses once the
  58   // probe has finished (as long as the error page is still loaded).
  59   DNS_PROBE_STARTED,
  60
  61   // A DNS probe has finished with one of the following results:
  62
  63   // The probe was inconclusive.
  64   DNS_PROBE_FINISHED_INCONCLUSIVE,
  65
  66   // There's no internet connection.
  67   DNS_PROBE_FINISHED_NO_INTERNET,
  68
  69   // The DNS configuration is wrong, or the servers are down or broken.
  70   DNS_PROBE_FINISHED_BAD_CONFIG,
  71
  72   // The DNS servers are working fine, so the domain must not exist.
  73   DNS_PROBE_FINISHED_NXDOMAIN,
  74
  75   DNS_PROBE_MAX
  76 };
  77
  78 // Returns a string representing |status|.  It should be simply the name of
  79 // the value as a string, but don't rely on that.  This is presented to the
  80 // user as part of the DNS error page (as the error code, at the bottom),
  81 // and is also used in some verbose log messages.
  82 //
  83 // The function will NOTREACHED() and return an empty string if given an int
  84 // that does not match a value in DnsProbeStatus (or if it is DNS_PROBE_MAX,
  85 // which is not a real status).
  86 const char* DnsProbeStatusToString(int status);
  87
  88 // Returns true if |status| is one of the DNS_PROBE_FINISHED_* statuses.
  89 bool DnsProbeStatusIsFinished(DnsProbeStatus status);
  90
  91 // Record specific error page events.
  92 void RecordEvent(NetworkErrorPageEvent event);
  93
  94 // The error domain used to pass DNS probe statuses to the localized error
  95 // code.
  96 extern const char kDnsProbeErrorDomain[];
  97
  98 }  // namespace chrome_common_net
  99
 100 #endif  // COMPONENTS_ERROR_PAGE_COMMON_NET_ERROR_INFO_H_