henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2004 The WebRTC Project Authors. All rights reserved. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
| 10 | |
| 11 | // LOG(...) an ostream target that can be used to send formatted |
| 12 | // output to a variety of logging targets, such as debugger console, stderr, |
Tommi | 0eefb4d | 2015-05-23 09:54:07 +0200 | [diff] [blame] | 13 | // or any LogSink. |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 +0000 | [diff] [blame] | 14 | // The severity level passed as the first argument to the LOGging |
| 15 | // functions is used as a filter, to limit the verbosity of the logging. |
| 16 | // Static members of LogMessage documented below are used to control the |
| 17 | // verbosity and target of the output. |
| 18 | // There are several variations on the LOG macro which facilitate logging |
| 19 | // of common error conditions, detailed below. |
| 20 | |
| 21 | // LOG(sev) logs the given stream at severity "sev", which must be a |
| 22 | // compile-time constant of the LoggingSeverity type, without the namespace |
| 23 | // prefix. |
| 24 | // LOG_V(sev) Like LOG(), but sev is a run-time variable of the LoggingSeverity |
| 25 | // type (basically, it just doesn't prepend the namespace). |
| 26 | // LOG_F(sev) Like LOG(), but includes the name of the current function. |
| 27 | // LOG_T(sev) Like LOG(), but includes the this pointer. |
| 28 | // LOG_T_F(sev) Like LOG_F(), but includes the this pointer. |
| 29 | // LOG_GLE(M)(sev [, mod]) attempt to add a string description of the |
| 30 | // HRESULT returned by GetLastError. The "M" variant allows searching of a |
| 31 | // DLL's string table for the error description. |
| 32 | // LOG_ERRNO(sev) attempts to add a string description of an errno-derived |
| 33 | // error. errno and associated facilities exist on both Windows and POSIX, |
| 34 | // but on Windows they only apply to the C/C++ runtime. |
| 35 | // LOG_ERR(sev) is an alias for the platform's normal error system, i.e. _GLE on |
| 36 | // Windows and _ERRNO on POSIX. |
| 37 | // (The above three also all have _EX versions that let you specify the error |
| 38 | // code, rather than using the last one.) |
| 39 | // LOG_E(sev, ctx, err, ...) logs a detailed error interpreted using the |
| 40 | // specified context. |
| 41 | // LOG_CHECK_LEVEL(sev) (and LOG_CHECK_LEVEL_V(sev)) can be used as a test |
| 42 | // before performing expensive or sensitive operations whose sole purpose is |
| 43 | // to output logging data at the desired level. |
| 44 | // Lastly, PLOG(sev, err) is an alias for LOG_ERR_EX. |
| 45 | |
| 46 | #ifndef WEBRTC_BASE_LOGGING_H_ |
| 47 | #define WEBRTC_BASE_LOGGING_H_ |
| 48 | |
mostynb | e38e4f6 | 2016-05-12 01:08:20 -0700 | [diff] [blame] | 49 | |
Henrik Kjellander | 6776518 | 2017-06-28 20:58:07 +0200 | [diff] [blame] | 50 | // This header is deprecated and is just left here temporarily during |
| 51 | // refactoring. See https://bugs.webrtc.org/7634 for more details. |
| 52 | #include "webrtc/rtc_base/logging.h" |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 +0000 | [diff] [blame] | 53 | |
| 54 | #endif // WEBRTC_BASE_LOGGING_H_ |