1// Copyright (c) 2012 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 NET_BASE_NET_ERRORS_H__
6#define NET_BASE_NET_ERRORS_H__
7
8#include <vector>
9
10#include "base/basictypes.h"
11#include "base/platform_file.h"
12#include "net/base/net_export.h"
13
14namespace net {
15
16// Error domain of the net module's error codes.
17NET_EXPORT extern const char kErrorDomain[];
18
19// Error values are negative.
20enum Error {
21  // No error.
22  OK = 0,
23
24#define NET_ERROR(label, value) ERR_ ## label = value,
25#include "net/base/net_error_list.h"
26#undef NET_ERROR
27
28  // The value of the first certificate error code.
29  ERR_CERT_BEGIN = ERR_CERT_COMMON_NAME_INVALID,
30};
31
32// Returns a textual representation of the error code for logging purposes.
33NET_EXPORT const char* ErrorToString(int error);
34
35// Returns true if |error| is a certificate error code.
36inline bool IsCertificateError(int error) {
37  // Certificate errors are negative integers from net::ERR_CERT_BEGIN
38  // (inclusive) to net::ERR_CERT_END (exclusive) in *decreasing* order.
39  return error <= ERR_CERT_BEGIN && error > ERR_CERT_END;
40}
41
42// Map system error code to Error.
43NET_EXPORT Error MapSystemError(int os_error);
44
45// Returns a list of all the possible net error codes (not counting OK). This
46// is intended for use with UMA histograms that are reporting the result of
47// an action that is represented as a net error code.
48//
49// Note that the error codes are all positive (since histograms expect positive
50// sample values). Also note that a guard bucket is created after any valid
51// error code that is not followed immediately by a valid error code.
52NET_EXPORT std::vector<int> GetAllErrorCodesForUma();
53
54// A convenient function to translate platform file error to net error code.
55NET_EXPORT Error PlatformFileErrorToNetError(
56    base::PlatformFileError file_error);
57
58}  // namespace net
59
60#endif  // NET_BASE_NET_ERRORS_H__
61