-
Notifications
You must be signed in to change notification settings - Fork 924
/
log4net.xml
14792 lines (14707 loc) · 698 KB
/
log4net.xml
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>log4net</name>
</assembly>
<members>
<member name="T:log4net.Appender.ADONetAppender">
<summary>
Appender that logs to a database.
</summary>
<remarks>
<para>
<see cref="T:log4net.Appender.ADONetAppender"/> appends logging events to a table within a
database. The appender can be configured to specify the connection
string by setting the <see cref="P:log4net.Appender.ADONetAppender.ConnectionString"/> property.
The connection type (provider) can be specified by setting the <see cref="P:log4net.Appender.ADONetAppender.ConnectionType"/>
property. For more information on database connection strings for
your specific database see <a href="http://www.connectionstrings.com/">http://www.connectionstrings.com/</a>.
</para>
<para>
Records are written into the database either using a prepared
statement or a stored procedure. The <see cref="P:log4net.Appender.ADONetAppender.CommandType"/> property
is set to <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify a prepared statement
or to <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify a stored
procedure.
</para>
<para>
The prepared statement text or the name of the stored procedure
must be set in the <see cref="P:log4net.Appender.ADONetAppender.CommandText"/> property.
</para>
<para>
The prepared statement or stored procedure can take a number
of parameters. Parameters are added using the <see cref="M:log4net.Appender.ADONetAppender.AddParameter(log4net.Appender.ADONetAppenderParameter)"/>
method. This adds a single <see cref="T:log4net.Appender.ADONetAppenderParameter"/> to the
ordered list of parameters. The <see cref="T:log4net.Appender.ADONetAppenderParameter"/>
type may be subclassed if required to provide database specific
functionality. The <see cref="T:log4net.Appender.ADONetAppenderParameter"/> specifies
the parameter name, database type, size, and how the value should
be generated using a <see cref="T:log4net.Layout.ILayout"/>.
</para>
</remarks>
<example>
An example of a SQL Server table that could be logged to:
<code>
CREATE TABLE [dbo].[Log] (
[ID] [int] IDENTITY (1, 1) NOT NULL ,
[Date] [datetime] NOT NULL ,
[Thread] [varchar] (255) NOT NULL ,
[Level] [varchar] (20) NOT NULL ,
[Logger] [varchar] (255) NOT NULL ,
[Message] [varchar] (4000) NOT NULL
) ON [PRIMARY]
</code>
</example>
<example>
An example configuration to log to the above table:
<code>
<appender name="ADONetAppender_SqlServer" type="log4net.Appender.ADONetAppender" >
<param name="ConnectionType" value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
<param name="ConnectionString" value="data source=GUINNESS;initial catalog=test_log4net;integrated security=false;persist security info=True;User ID=sa;Password=sql" />
<param name="CommandText" value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)" />
<param name="Parameter">
<param name="ParameterName" value="@log_date" />
<param name="DbType" value="DateTime" />
<param name="Layout" type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%d{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}" />
</param>
</param>
<param name="Parameter">
<param name="ParameterName" value="@thread" />
<param name="DbType" value="String" />
<param name="Size" value="255" />
<param name="Layout" type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%t" />
</param>
</param>
<param name="Parameter">
<param name="ParameterName" value="@log_level" />
<param name="DbType" value="String" />
<param name="Size" value="50" />
<param name="Layout" type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%p" />
</param>
</param>
<param name="Parameter">
<param name="ParameterName" value="@logger" />
<param name="DbType" value="String" />
<param name="Size" value="255" />
<param name="Layout" type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%c" />
</param>
</param>
<param name="Parameter">
<param name="ParameterName" value="@message" />
<param name="DbType" value="String" />
<param name="Size" value="4000" />
<param name="Layout" type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%m" />
</param>
</param>
</appender>
</code>
</example>
</member>
<member name="T:log4net.Appender.BufferingAppenderSkeleton">
<summary>
Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that
buffers events in a fixed size buffer.
</summary>
<remarks>
<para>
This base class should be used by appenders that need to buffer a
number of events before logging them. For example the <see cref="T:log4net.Appender.ADONetAppender"/>
buffers events and then submits the entire contents of the buffer to
the underlying database in one go.
</para>
<para>
Subclasses should override the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.spi.LoggingEvent[])"/>
method to deliver the buffered events.
</para>
<para>The BufferingAppenderSkeleton maintains a fixed size cyclic
buffer of events. The size of the buffer is set using
the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property.
</para>
<para>A <see cref="T:log4net.spi.ITriggeringEventEvaluator"/> is used to inspect
each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
triggers, then the current buffer is sent immediately
(see <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.spi.LoggingEvent[])"/>). Otherwise the event
is stored in the buffer. For example, an evaluator can be used to
deliver the events immediately when an ERROR event arrives.
</para>
<para>
The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode.
By default the appender is NOT lossy. When the buffer is full all
the buffered events are sent with <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.spi.LoggingEvent[])"/>.
If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the
buffer will not be sent when it is full, and new events arriving
in the appender will overwrite the oldest event in the buffer.
In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
triggers. This can be useful behaviour when you need to know about
ERROR events but not about events with a lower level, configure an
evaluator that will trigger when an ERROR event arrives, the whole
buffer will be sent which gives a history of events leading up to
the ERROR event.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.AppenderSkeleton">
<summary>
Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>.
</summary>
<remarks>
<para>
This class provides the code for common functionality, such
as support for threshold filtering and support for general filters.
</para>
<para>
Appenders can also implement the <see cref="T:log4net.spi.IOptionHandler"/> interface. Therefore
they would require that the <see cref="M:log4net.spi.IOptionHandler.ActivateOptions"/> method
be called after the appenders properties have been configured.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.IAppender">
<summary>
Implement this interface for your own strategies for printing log statements.
</summary>
<remarks>
<para>
Implementers should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/>
class which provides a default implementation of this interface.
</para>
<para>
Appenders can also implement the <see cref="T:log4net.spi.IOptionHandler"/> interface. Therefore
they would require that the <see cref="M:log4net.spi.IOptionHandler.ActivateOptions"/> method
be called after the appenders properties have been configured.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.IAppender.Close">
<summary>
Closes the appender and releases resources.
</summary>
<remarks>
<para>
Releases any resources allocated within the appender such as file handles,
network connections, etc.
</para>
<para>
It is a programming error to append to a closed appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.IAppender.DoAppend(log4net.spi.LoggingEvent)">
<summary>
Log the logging event in Appender specific way.
</summary>
<param name="loggingEvent">The event to log</param>
<remarks>
<para>
This method is called to log a message into this appender.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.IAppender.Name">
<summary>
Gets or sets the name of this appender.
</summary>
<value>The name of the appender.</value>
<remarks>
<para>The name uniquely identifies the appender.</para>
</remarks>
</member>
<member name="T:log4net.spi.IOptionHandler">
<summary>
A string based interface to configure components.
</summary>
</member>
<member name="M:log4net.spi.IOptionHandler.ActivateOptions">
<summary>
Activate the options that were previously set with calls to option setters.
</summary>
<remarks>
This allows to defer activation of the options until all
options have been set. This is required for components which have
related options that remain ambiguous until all are set.
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>Empty default constructor</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.Finalize">
<summary>
Finalizes this appender by calling the implementation's
<see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
</summary>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
<summary>
Initialise the appender based on the options set
</summary>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.Close">
<summary>
Closes the appender and release resources.
</summary>
<remarks>
<para>
Release any resources allocated within the appender such as file handles,
network connections, etc.
</para>
<para>
It is a programming error to append to a closed appender.
</para>
<para>
This method cannot be overridden by subclasses. This method
delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
method which must be overridden in the subclass.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.spi.LoggingEvent)">
<summary>
Performs threshold checks and invokes filters before
delegating actual logging to the subclasses specific
<see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.spi.LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
This method cannot be overridden by derived classes. A
derived class should override the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.spi.LoggingEvent)"/> method
which is called by this method.
</para>
<para>
The implementation of this method is as follows:
</para>
<para>
<list type="bullet">
<item>
<description>
Checks that the severity of the <paramref name="loggingEvent"/>
is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
appender.</description>
</item>
<item>
<description>
Checks that the <see cref="N:log4net.Filter"/> chain accepts the
<paramref name="loggingEvent"/>.
</description>
</item>
<item>
<description>
Calls <see cref="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"/> and checks that
it returns <c>true</c>.</description>
</item>
</list>
</para>
<para>
If all of the above steps succeed then the <paramref name="loggingEvent"/>
will be passed to the abstract <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.spi.LoggingEvent)"/> method.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.spi.Level)">
<summary>
Checks if the message level is below this appender's threshold.
</summary>
<param name="level"><see cref="T:log4net.spi.Level"/> to test against.</param>
<remarks>
<para>
If there is no threshold set, then the return value is always <c>true</c>.
</para>
</remarks>
<returns>
<c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
requirements of this appender.
</returns>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.OnClose">
<summary>
Is called when the appender is closed. Derived classes should override
this method if resources need to be released.
</summary>
<remarks>
<para>
Releases any resources allocated within the appender such as file handles,
network connections, etc.
</para>
<para>
It is a programming error to append to a closed appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
<summary>
Adds a filter to the end of the filter chain.
</summary>
<remarks>
<para>
The Filters are organized in a linked list.
</para>
<para>
Setting this property causes the new filter to be pushed onto the
back of the filter chain.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
<summary>
Clears the filter list for this appender.
</summary>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.spi.LoggingEvent)">
<summary>
Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
to perform actual logging.
</summary>
<param name="loggingEvent">The event to append.</param>
<remarks>
<para>
A subclass must implement this method to perform
logging of the <paramref name="loggingEvent"/>.
</para>
<para>This method will be called by <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.spi.LoggingEvent)"/>
if all the conditions listed for that method are met.
</para>
<para>
To restrict the logging of events in the appender
override the <see cref="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"/> method.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
<summary>
Called before <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.spi.LoggingEvent)"/> as a precondition.
</summary>
<remarks>
<para>
This method is called by <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.spi.LoggingEvent)"/>
before the call to the abstract <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.spi.LoggingEvent)"/> method.
</para>
<para>
This method can be overridden in a subclass to extend the checks
made before the event is passed to the <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.spi.LoggingEvent)"/> method.
</para>
<para>
A subclass should ensure that they delegate this call to
this base class if it is overridden.
</para>
</remarks>
<returns><c>true</c> if the call to <see cref="M:log4net.Appender.AppenderSkeleton.Append(log4net.spi.LoggingEvent)"/> should proceed.</returns>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.spi.LoggingEvent)">
<summary>
Renders the <see cref="T:log4net.spi.LoggingEvent"/> to a string.
</summary>
<param name="loggingEvent">The event to render.</param>
<returns>The event rendered as a string.</returns>
<remarks>
<para>
Helper method to render a <see cref="T:log4net.spi.LoggingEvent"/> to
a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
set to render the <paramref name="loggingEvent"/> to
a string.
</para>
<para>If there is exception data in the logging event and
the layout does not process the exception, this method
will append the exception text to the rendered string.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_layout">
<summary>
The layout of this appender.
</summary>
<remarks>
See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_name">
<summary>
The name of this appender.
</summary>
<remarks>
See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
<summary>
The level threshold of this appender.
</summary>
<remarks>
<para>
There is no level threshold filtering by default.
</para>
<para>
See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
<summary>
It is assumed and enforced that errorHandler is never null.
</summary>
<remarks>
<para>
It is assumed and enforced that errorHandler is never null.
</para>
<para>
See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
<summary>
The first filter in the filter chain.
</summary>
<remarks>
<para>
Set to <c>null</c> initially.
</para>
<para>
See <see cref="N:log4net.Filter"/> for more information.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
<summary>
The last filter in the filter chain.
</summary>
<remarks>
See <see cref="N:log4net.Filter"/> for more information.
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_closed">
<summary>
Flag indicating if this appender is closed.
</summary>
<remarks>
See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
<summary>
The guard prevents an appender from repeatedly calling its own DoAppend method
</summary>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.Threshold">
<summary>
Gets or sets the threshold <see cref="T:log4net.spi.Level"/> of this appender.
</summary>
<value>
The threshold <see cref="T:log4net.spi.Level"/> of the appender.
</value>
<remarks>
<para>
All log events with lower level than the threshold level are ignored
by the appender.
</para>
<para>
In configuration files this option is specified by setting the
value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
string, such as "DEBUG", "INFO" and so on.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
<summary>
Gets or sets the <see cref="T:log4net.spi.IErrorHandler"/> for this appender.
</summary>
<value>The <see cref="T:log4net.spi.IErrorHandler"/> of the appender</value>
<remarks>
<para>
The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
<summary>
The filter chain.
</summary>
<value>The head of the filter chain filter chain.</value>
<remarks>
<para>
Returns the head Filter. The Filters are organized in a linked list
and so all Filters on this Appender are available through the result.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.Layout">
<summary>
Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
</summary>
<value>The layout of the appender.</value>
<remarks>
<para>
See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
</para>
</remarks>
<seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.Name">
<summary>
Gets or sets the name of this appender.
</summary>
<value>The name of the appender.</value>
<remarks>
<para>
The name uniquely identifies the appender.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
<summary>
Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
</summary>
<remarks>
<para>
In the rather exceptional case, where the appender
implementation admits a layout but can also work without it,
then the appender should return <c>true</c>.
</para>
<para>
This default implementation always returns <c>true</c>.
</para>
</remarks>
<returns>
<c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
</returns>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
<summary>
The default buffer size.
</summary>
<remarks>
The default size of the cyclic buffer used to store events.
This is set to 512 by default.
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
</summary>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
</summary>
<param name="eventMustBeFixed">the events passed through this appender must be
fixed by the time that they arrive in the derived class'<c>SendBuffer</c> method.</param>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
<summary>
Initialise the appender based on the options set
</summary>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
<summary>
Close this appender instance.
</summary>
<remarks>
<para>Close this appender instance. If this appender is marked
as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
the buffer must be sent when the appender is closed.</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.spi.LoggingEvent)">
<summary>
This method is called by the <see cref="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.spi.LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">the event to log</param>
<remarks>
<para>Stores the <paramref name="loggingEvent"/> in the cyclic buffer.</para>
<para>The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.helpers.CyclicBuffer)"/>
method) if one of the following conditions is met:</para>
<list type="bullet">
<item>
<description>The cyclic buffer is full and this appender is
marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
</item>
<item>
<description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
it is triggered for the <paramref name="loggingEvent"/>
specified.</description>
</item>
</list>
<para>Before the event is stored in the buffer it is fixed
(see <see cref="M:log4net.spi.LoggingEvent.FixVolatileData"/>) to ensure that
any data referenced by the event will be valid when the buffer
is processed.</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.helpers.CyclicBuffer)">
<summary>
Sends the contents of the buffer.
</summary>
<param name="buffer">The buffer containing the events that need to be send.</param>
<remarks>
The subclass must override either <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.helpers.CyclicBuffer)"/>
or <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.spi.LoggingEvent[])"/>.
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.spi.LoggingEvent[])">
<summary>
Sends the events.
</summary>
<param name="events">The events that need to be send.</param>
<remarks>
The subclass must override either <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.helpers.CyclicBuffer)"/>
or <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.spi.LoggingEvent[])"/>.
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
<summary>
The size of the cyclic buffer used to hold the logging events.
</summary>
<remarks>
Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
<summary>
The cyclic buffer used to store the logging events.
</summary>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
<summary>
The triggering event evaluator that causes the buffer to be sent immediately.
</summary>
<remarks>
The object that is used to determine if an event causes the entire
buffer to be sent immediately. This field can be <c>null</c>, which
indicates that event triggering is not to be done. The evaluator
can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
<c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
<summary>
Indicates if the appender should overwrite events in the cyclic buffer
when it becomes full, or if the buffer should be flushed when the
buffer is full.
</summary>
<remarks>
If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
be set.
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
<summary>
The triggering event evaluator filters discarded events.
</summary>
<remarks>
The object that is used to determine if an event that is discarded should
really be discarded or if it should be sent to the appenders.
This field can be <c>null</c>, which indicates that all discarded events will
be discarded.
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
<summary>
Value indicating which fields in the event should be fixed
</summary>
<remarks>
By default all fields are fixed
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
<summary>
The events delivered to the subclass must be fixed.
</summary>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
<summary>
Gets or sets a value that indicates whether the appender is lossy.
</summary>
<value>
<c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
</value>
<remarks>
<para>
This appender uses a buffer to store logging events before
delivering them. A triggering event causes the whole buffer
to be send to the remote sink. If the buffer overruns before
a triggering event then logging events could be lost. Set
<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
from being lost.
</para>
<para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
</remarks>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
<summary>
Gets or sets the size of the cyclic buffer used to hold the
logging events.
</summary>
<value>
The size of the cyclic buffer used to hold the logging events.
</value>
<remarks>
The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
representing the maximum number of logging events to collect in
a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
oldest events are deleted as new events are added to the
buffer. By default the size of the cyclic buffer is 512 events.
</remarks>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
<summary>
Gets or sets the <see cref="T:log4net.spi.ITriggeringEventEvaluator"/> that causes the
buffer to be sent immediately.
</summary>
<value>
The <see cref="T:log4net.spi.ITriggeringEventEvaluator"/> that causes the buffer to be
sent immediately.
</value>
<remarks>
<para>
The evaluator will be called for each event that is appended to this
appender. If the evaluator triggers then the current buffer will
immediately be sent (see <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.spi.LoggingEvent[])"/>).
</para>
<para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
</remarks>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
<summary>
Gets or sets the value of the <see cref="T:log4net.spi.ITriggeringEventEvaluator"/> to use.
</summary>
<value>
The value of the <see cref="T:log4net.spi.ITriggeringEventEvaluator"/> to use.
</value>
<remarks>
<para>
The evaluator will be called for each event that is discarded from this
appender. If the evaluator triggers then the current buffer will immediately
be sent (see <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.spi.LoggingEvent[])"/>).
</para>
</remarks>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
<summary>
Gets or sets a value indicating if only part of the logging event data
should be fixed.
</summary>
<value>
<c>true</c> if the appender should only fix part of the logging event
data, otherwise <c>false</c>. The default is <c>false</c>.
</value>
<remarks>
<para>
Setting this property to <c>true</c> will cause only part of the
event data to be fixed and serialised. This will improve performance.
</para>
<para>
See <see cref="M:log4net.spi.LoggingEvent.FixVolatileData(System.Boolean)"/> for more information.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
<summary>
Gets or sets a the fields that will be fixed in the event
</summary>
</member>
<member name="M:log4net.Appender.ADONetAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.ADONetAppender"/> class.
</summary>
</member>
<member name="M:log4net.Appender.ADONetAppender.ActivateOptions">
<summary>
Initialise the appender based on the options set
</summary>
</member>
<member name="M:log4net.Appender.ADONetAppender.OnClose">
<summary>
Override the parent method to close the database
</summary>
</member>
<member name="M:log4net.Appender.ADONetAppender.SendBuffer(log4net.spi.LoggingEvent[])">
<summary>
Inserts the events into the database.
</summary>
<param name="events">The events to insert into the database.</param>
</member>
<member name="M:log4net.Appender.ADONetAppender.AddParameter(log4net.Appender.ADONetAppenderParameter)">
<summary>
Adds a parameter to the command.
</summary>
<param name="parameter">The parameter to add to the command.</param>
<remarks>
<para>
Adds a parameter to the ordered list of command parameters.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ADONetAppender.SendBuffer(System.Data.IDbTransaction,log4net.spi.LoggingEvent[])">
<summary>
Writes the events to the database using the transaction specified.
</summary>
<param name="dbTran">The transaction that the events will be executed under.</param>
<param name="events">The array of events to insert into the database.</param>
<remarks>
The transaction argument can be <c>null</c> if the appender has been
configured not to use transactions. See <see cref="P:log4net.Appender.ADONetAppender.UseTransactions"/>
property for more information.
</remarks>
</member>
<member name="M:log4net.Appender.ADONetAppender.GetLogStatement(log4net.spi.LoggingEvent)">
<summary>
Formats the log message into database statement text.
</summary>
<param name="logEvent">The event being logged.</param>
<remarks>
This method can be overridden by subclasses to provide
more control over the format of the database statement.
</remarks>
<returns>
Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
</returns>
</member>
<member name="M:log4net.Appender.ADONetAppender.InitializeDatabaseConnection">
<summary>
Connects to the database.
</summary>
</member>
<member name="M:log4net.Appender.ADONetAppender.ResolveConnectionType">
<summary>
Retrieves the class type of the ADO.NET provider.
</summary>
</member>
<member name="M:log4net.Appender.ADONetAppender.InitializeDatabaseCommand">
<summary>
Prepares the database command and initialize the parameters.
</summary>
</member>
<member name="F:log4net.Appender.ADONetAppender.m_dbConnection">
<summary>
The <see cref="T:System.Data.IDbConnection"/> that will be used
to insert logging events into a database.
</summary>
</member>
<member name="F:log4net.Appender.ADONetAppender.m_dbCommand">
<summary>
The database command.
</summary>
</member>
<member name="F:log4net.Appender.ADONetAppender.m_usePreparedCommand">
<summary>
Flag to indicate if we are using a command object
</summary>
</member>
<member name="F:log4net.Appender.ADONetAppender.m_connectionString">
<summary>
Database connection string.
</summary>
</member>
<member name="F:log4net.Appender.ADONetAppender.m_connectionType">
<summary>
String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
</summary>
</member>
<member name="F:log4net.Appender.ADONetAppender.m_commandText">
<summary>
The text of the command.
</summary>
</member>
<member name="F:log4net.Appender.ADONetAppender.m_commandType">
<summary>
The command type.
</summary>
</member>
<member name="F:log4net.Appender.ADONetAppender.m_useTransactions">
<summary>
Incicats whether to use Utransactions when writing to the
database.
</summary>
</member>
<member name="F:log4net.Appender.ADONetAppender.m_parameters">
<summary>
The list of <see cref="T:log4net.Appender.ADONetAppenderParameter"/> objects.
</summary>
<remarks>
The list of <see cref="T:log4net.Appender.ADONetAppenderParameter"/> objects.
</remarks>
</member>
<member name="P:log4net.Appender.ADONetAppender.ConnectionString">
<summary>
Gets or sets the database connection string that is used to connect to
the database.
</summary>
<value>
The database connection string used to connect to the database.
</value>
<remarks>
<para>
The connections string is specific to the connection type.
See <see cref="P:log4net.Appender.ADONetAppender.ConnectionType"/> for more information.
</para>
</remarks>
<example>Connection string for MS Access via ODBC:
<code>"DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\\data\\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\\data\\train33.mdb"</code>
</example>
<example>Another connection string for MS Access via ODBC:
<code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\\Work\\cvs_root\\log4net-1.2\\access.mdb;UID=;PWD=;"</code>
</example>
<example>Connection string for MS Access via OLE DB:
<code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\\Work\\cvs_root\\log4net-1.2\\access.mdb;User Id=;Password=;"</code>
</example>
</member>
<member name="P:log4net.Appender.ADONetAppender.ConnectionType">
<summary>
Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection
that should be created.
</summary>
<value>
The type name of the <see cref="T:System.Data.IDbConnection"/> connection.
</value>
<remarks>
<para>
The type name of the ADO.NET provider to use.
</para>
<para>
The default is to use the OLE DB provider.
</para>
</remarks>
<example>Use the OLE DB Provider. This is the default value.
<code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
</example>
<example>Use the MS SQL Server Provider.
<code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
</example>
<example>Use the ODBC Provider.
<code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code>
This is an optional package that you can download from
<a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
search for <b>ODBC .NET Data Provider</b>.
</example>
</member>
<member name="P:log4net.Appender.ADONetAppender.CommandText">
<summary>
Gets or sets the command text that is used to insert logging events
into the database.
</summary>
<value>
The command text used to insert logging events into the database.
</value>