Export (0) Print
Expand All

BufferModeSettings Class

Configures the ASP.NET event-buffering settings for event providers. This class cannot be inherited.

System.Object
  System.Configuration.ConfigurationElement
    System.Web.Configuration.BufferModeSettings

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

public sealed class BufferModeSettings : ConfigurationElement

The BufferModeSettings type exposes the following members.

  NameDescription
Public methodBufferModeSettingsInitializes a new instance of the BufferModeSettings class using specified settings.
Top

  NameDescription
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected propertyItem[String]Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Public propertyMaxBufferSizeGets or sets the maximum number of events that can be buffered at one time.
Public propertyMaxBufferThreadsGets or sets the maximum number of flushing threads that can be active at one time.
Public propertyMaxFlushSizeGets or sets the maximum number of events per flush.
Public propertyNameGets or sets the name of the BufferModeSettings object.
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Public propertyRegularFlushIntervalGets or sets the amount of time between buffer flushes.
Public propertyUrgentFlushIntervalGets or sets the minimum amount of time that can pass between buffer flushes.
Public propertyUrgentFlushThresholdGets or sets the number of events that can be buffered before a flush is triggered.
Top

  NameDescription
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
Public methodGetHashCodeGets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodIsModifiedIndicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected methodResetResets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
Protected methodResetModifiedResets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeElementWrites the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlySets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeModifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)
Top

The 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 MaxBufferSize, MaxFlushSize, and UrgentFlushInterval properties small, whereas an Analysis role would set those properties to higher values.

This class corresponds to the bufferModes configuration-file element.

The following configuration file excerpt shows how to declaratively specify values for several properties of the BufferModeSettings class.

<healthMonitoring>
  <bufferModes>
    <add name="Critical Notification"
      maxBufferSize="100"
      maxFlushSize="20"
      urgentFlushThreshold="1"
      regularFlushInterval="Infinite"
      urgentFlushInterval="00:01:00"
      maxBufferThreads="1"
    />
    <add name="Notification"
      maxBufferSize="300"
      maxFlushSize="20"
      urgentFlushThreshold="1"
      regularFlushInterval="Infinite"
      urgentFlushInterval="00:01:00"
      maxBufferThreads="1"
    />
    <add name="Analysis"
      maxBufferSize="1000"
      maxFlushSize="100"
      urgentFlushThreshold="100"
      regularFlushInterval="00:05:00"
      urgentFlushInterval="00:01:00"
      maxBufferThreads="1"
    />
    <add name="Logging"
      maxBufferSize="1000"
      maxFlushSize="200"
      urgentFlushThreshold="800"
      regularFlushInterval="00:30:00"
      urgentFlushInterval="00:05:00"
      maxBufferThreads="1"
    />
  </bufferModes>
</healthMonitoring>

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft