jt
2021-06-10 5d0d028456874576560552f5a5c4e8b801786f11
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
#region Apache License
//
// Licensed to the Apache Software Foundation (ASF) under one or more 
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership. 
// The ASF licenses this file to you under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with 
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#endregion
 
#define DEBUG
 
using log4net.Layout;
using log4net.Core;
 
namespace log4net.Appender
{
    /// <summary>
    /// Appends log events to the <see cref="System.Diagnostics.Debug"/> system.
    /// </summary>
    /// <remarks>
    /// <para>
    /// The application configuration file can be used to control what listeners 
    /// are actually used. See the MSDN documentation for the 
    /// <see cref="System.Diagnostics.Debug"/> class for details on configuring the
    /// debug system.
    /// </para>
    /// <para>
    /// Events are written using the <see cref="System.Diagnostics.Debug.Write(string,string)"/>
    /// method. The event's logger name is passed as the value for the category name to the Write method.
    /// </para>
    /// </remarks>
    /// <author>Nicko Cadell</author>
    public class DebugAppender : AppenderSkeleton
    {
        #region Public Instance Constructors
 
        /// <summary>
        /// Initializes a new instance of the <see cref="DebugAppender" />.
        /// </summary>
        /// <remarks>
        /// <para>
        /// Default constructor.
        /// </para>
        /// </remarks>
        public DebugAppender()
        {
        }
 
        /// <summary>
        /// Initializes a new instance of the <see cref="DebugAppender" /> 
        /// with a specified layout.
        /// </summary>
        /// <param name="layout">The layout to use with this appender.</param>
        /// <remarks>
        /// <para>
        /// Obsolete constructor.
        /// </para>
        /// </remarks>
        [System.Obsolete("Instead use the default constructor and set the Layout property")]
        public DebugAppender(ILayout layout)
        {
            Layout = layout;
        }
 
        #endregion Public Instance Constructors
 
        #region Public Instance Properties
 
        /// <summary>
        /// Gets or sets a value that indicates whether the appender will 
        /// flush at the end of each write.
        /// </summary>
        /// <remarks>
        /// <para>The default behavior is to flush at the end of each 
        /// write. If the option is set to<c>false</c>, then the underlying 
        /// stream can defer writing to physical medium to a later time. 
        /// </para>
        /// <para>
        /// Avoiding the flush operation at the end of each append results 
        /// in a performance gain of 10 to 20 percent. However, there is safety
        /// trade-off involved in skipping flushing. Indeed, when flushing is
        /// skipped, then it is likely that the last few log events will not
        /// be recorded on disk when the application exits. This is a high
        /// price to pay even for a 20% performance gain.
        /// </para>
        /// </remarks>
        public bool ImmediateFlush
        {
            get { return m_immediateFlush; }
            set { m_immediateFlush = value; }
        }
 
        #endregion Public Instance Properties
 
        #region Override implementation of AppenderSkeleton
 
        /// <summary>
        /// Writes the logging event to the <see cref="System.Diagnostics.Debug"/> system.
        /// </summary>
        /// <param name="loggingEvent">The event to log.</param>
        /// <remarks>
        /// <para>
        /// Writes the logging event to the <see cref="System.Diagnostics.Debug"/> system.
        /// If <see cref="ImmediateFlush"/> is <c>true</c> then the <see cref="System.Diagnostics.Debug.Flush"/>
        /// is called.
        /// </para>
        /// </remarks>
        override protected void Append(LoggingEvent loggingEvent) 
        {
            //
            // Write the string to the Debug system
            //
            System.Diagnostics.Debug.Write(RenderLoggingEvent(loggingEvent), loggingEvent.LoggerName);
     
            //
            // Flush the Debug system if needed
            //
            if (m_immediateFlush) 
            {
                System.Diagnostics.Debug.Flush();
            } 
        }
 
        /// <summary>
        /// This appender requires a <see cref="Layout"/> to be set.
        /// </summary>
        /// <value><c>true</c></value>
        /// <remarks>
        /// <para>
        /// This appender requires a <see cref="Layout"/> to be set.
        /// </para>
        /// </remarks>
        override protected bool RequiresLayout
        {
            get { return true; }
        }
 
        #endregion Override implementation of AppenderSkeleton
 
        #region Private Instance Fields
 
        /// <summary>
        /// Immediate flush means that the underlying writer or output stream
        /// will be flushed at the end of each append operation.
        /// </summary>
        /// <remarks>
        /// <para>
        /// Immediate flush is slower but ensures that each append request is 
        /// actually written. If <see cref="ImmediateFlush"/> is set to
        /// <c>false</c>, then there is a good chance that the last few
        /// logs events are not actually written to persistent media if and
        /// when the application crashes.
        /// </para>
        /// <para>
        /// The default value is <c>true</c>.</para>
        /// </remarks>
        private bool m_immediateFlush = true;
 
        #endregion Private Instance Fields
    }
}