332 lines
18 KiB
XML
332 lines
18 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="BufferModeSettings" FullName="System.Web.Configuration.BufferModeSettings">
|
|
<TypeSignature Language="C#" Value="public sealed class BufferModeSettings : System.Configuration.ConfigurationElement" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Configuration.ConfigurationElement</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Web.Configuration.BufferModeSettings" /> class is used to define roles for event providers, such as Critical, Notification, Analysis, and Logging. Each role would buffer events differently, as appropriate for that role. For example a Critical role would keep the <see cref="P:System.Web.Configuration.BufferModeSettings.MaxBufferSize" />, <see cref="P:System.Web.Configuration.BufferModeSettings.MaxFlushSize" />, and <see cref="P:System.Web.Configuration.BufferModeSettings.UrgentFlushInterval" /> properties small, whereas an Analysis role would set those properties to higher values.</para>
|
|
<para>This class corresponds to the bufferModes configuration-file element.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Configures the ASP.NET event-buffering settings for event providers. This class cannot be inherited.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public BufferModeSettings (string name, int maxBufferSize, int maxFlushSize, int urgentFlushThreshold, TimeSpan regularFlushInterval, TimeSpan urgentFlushInterval, int maxBufferThreads);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="maxBufferSize" Type="System.Int32" />
|
|
<Parameter Name="maxFlushSize" Type="System.Int32" />
|
|
<Parameter Name="urgentFlushThreshold" Type="System.Int32" />
|
|
<Parameter Name="regularFlushInterval" Type="System.TimeSpan" />
|
|
<Parameter Name="urgentFlushInterval" Type="System.TimeSpan" />
|
|
<Parameter Name="maxBufferThreads" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.Configuration.BufferModeSettings" /> class using specified settings.</para>
|
|
</summary>
|
|
<param name="name">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.BufferModeSettings" /> object being created.</param>
|
|
<param name="maxBufferSize">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The maximum number of events buffered at one time. The value must be greater than zero.</param>
|
|
<param name="maxFlushSize">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The maximum number of events per buffer flush. Must be greater than zero.</param>
|
|
<param name="urgentFlushThreshold">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The number of events buffered before a buffer flush is triggered. The value must be greater than zero and less than or equal to <paramref name="maxBufferSize" />.</param>
|
|
<param name="regularFlushInterval">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The standard amount of time between buffer flushes. The value can be made infinite by setting it to <see cref="F:System.Int32.MaxValue" /> ticks.</param>
|
|
<param name="urgentFlushInterval">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The minimum length of time that can pass between buffer flushes. The value must be less than or equal to <paramref name="regularFlushInterval" />.</param>
|
|
<param name="maxBufferThreads">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The maximum number of buffer-flushing threads that can be active at one time.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ElementProperty">
|
|
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationElementProperty ElementProperty { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Configuration.ConfigurationElementProperty</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="MaxBufferSize">
|
|
<MemberSignature Language="C#" Value="public int MaxBufferSize { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.ConfigurationProperty("maxBufferSize", DefaultValue="2147483647", Options=System.Configuration.ConfigurationPropertyOptions.IsRequired)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.IntegerValidator(MinValue=1, MaxValue=2147483647)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.InfiniteIntConverter))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This property must have a value greater than zero. Invalid values may cause an exception to be thrown when the configuration section is saved.</para>
|
|
<para>The default value varies based on the provider. The <see cref="T:System.Web.Configuration.BufferModeSettings" /> objects in the <see cref="P:System.Web.Configuration.HealthMonitoringSection.BufferModes" /> collection are referred to by name by the providers in the <see cref="P:System.Web.Configuration.HealthMonitoringSection.Providers" /> collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the maximum number of events that can be buffered at one time.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="MaxBufferThreads">
|
|
<MemberSignature Language="C#" Value="public int MaxBufferThreads { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.ConfigurationProperty("maxBufferThreads", DefaultValue="1")</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.IntegerValidator(MinValue=1, MaxValue=2147483647)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.InfiniteIntConverter))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This property must have a value greater than zero. Invalid values may cause an exception to be thrown when the configuration section is saved.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the maximum number of flushing threads that can be active at one time.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="MaxFlushSize">
|
|
<MemberSignature Language="C#" Value="public int MaxFlushSize { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.ConfigurationProperty("maxFlushSize", DefaultValue="2147483647", Options=System.Configuration.ConfigurationPropertyOptions.IsRequired)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.IntegerValidator(MinValue=1, MaxValue=2147483647)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.InfiniteIntConverter))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This property must have a value greater than zero. Invalid values may cause an exception to be thrown when the configuration section is saved.</para>
|
|
<para>The default value varies based on the provider. The <see cref="T:System.Web.Configuration.BufferModeSettings" /> objects in the <see cref="P:System.Web.Configuration.HealthMonitoringSection.BufferModes" /> collection are referred to by name by the providers in the <see cref="P:System.Web.Configuration.HealthMonitoringSection.Providers" /> collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the maximum number of events per flush.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Name">
|
|
<MemberSignature Language="C#" Value="public string Name { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.ConfigurationProperty("name", DefaultValue="", Options=System.Configuration.ConfigurationPropertyOptions.IsRequired | System.Configuration.ConfigurationPropertyOptions.IsKey)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.StringValidator(MinLength=1)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A unique name is required.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the name of the <see cref="T:System.Web.Configuration.BufferModeSettings" /> object.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Properties">
|
|
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not intended to be used directly from your code.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a <see cref="T:System.Configuration.ConfigurationPropertyCollection" /> collection.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="RegularFlushInterval">
|
|
<MemberSignature Language="C#" Value="public TimeSpan RegularFlushInterval { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.ConfigurationProperty("regularFlushInterval", DefaultValue="00:00:01", Options=System.Configuration.ConfigurationPropertyOptions.IsRequired)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.TimeSpanValidator(MinValueString="00:00:00", MaxValueString="10675199.02:48:05.4775807")</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.InfiniteTimeSpanConverter))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This property must have a value greater than zero. The value can be made infinite by setting it to <see cref="F:System.Int32.MaxValue" /> ticks. Invalid values may cause an exception when the configuration section is saved.</para>
|
|
<para>The default value varies based on the provider. The <see cref="T:System.Web.Configuration.BufferModeSettings" /> objects in the <see cref="P:System.Web.Configuration.HealthMonitoringSection.BufferModes" /> collection are referred to by name by the providers in the <see cref="P:System.Web.Configuration.HealthMonitoringSection.Providers" /> collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the amount of time between buffer flushes.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="UrgentFlushInterval">
|
|
<MemberSignature Language="C#" Value="public TimeSpan UrgentFlushInterval { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.ConfigurationProperty("urgentFlushInterval", DefaultValue="00:00:00", Options=System.Configuration.ConfigurationPropertyOptions.IsRequired)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.InfiniteTimeSpanConverter))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This property must have a value greater than zero and less than or equal to the value of the <see cref="P:System.Web.Configuration.BufferModeSettings.RegularFlushInterval" /> property. Invalid values may cause an exception to be thrown when the configuration section is saved.</para>
|
|
<para>The default value varies based on the provider. The <see cref="T:System.Web.Configuration.BufferModeSettings" /> objects in the <see cref="P:System.Web.Configuration.HealthMonitoringSection.BufferModes" /> collection are referred to by name by the providers in the <see cref="P:System.Web.Configuration.HealthMonitoringSection.Providers" /> collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the minimum amount of time that can pass between buffer flushes. </para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="UrgentFlushThreshold">
|
|
<MemberSignature Language="C#" Value="public int UrgentFlushThreshold { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.ConfigurationProperty("urgentFlushThreshold", DefaultValue="2147483647", Options=System.Configuration.ConfigurationPropertyOptions.IsRequired)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Configuration.IntegerValidator(MinValue=1, MaxValue=2147483647)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.InfiniteIntConverter))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This property must have a value greater than zero and less than or equal to the value of the <see cref="P:System.Web.Configuration.BufferModeSettings.MaxBufferSize" /> property. Invalid values may cause an exception when the configuration section is saved.</para>
|
|
<para>The default value varies based on the provider. The <see cref="T:System.Web.Configuration.BufferModeSettings" /> objects in the <see cref="P:System.Web.Configuration.HealthMonitoringSection.BufferModes" /> collection are referred to by name by the providers in the <see cref="P:System.Web.Configuration.HealthMonitoringSection.Providers" /> collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the number of events that can be buffered before a flush is triggered.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |