BufferModeSettings Class

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class BufferModeSettings sealed : System::Configuration::ConfigurationElement

public sealed class BufferModeSettings : System.Configuration.ConfigurationElement

type BufferModeSettings = class
    inherit ConfigurationElement

Public NotInheritable Class BufferModeSettings
Inherits ConfigurationElement

Inheritance: Object

ConfigurationElement
BufferModeSettings

Examples

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>

Remarks

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.

Constructors

BufferModeSettings(String, Int32, Int32, Int32, TimeSpan, TimeSpan, Int32)

Initializes a new instance of the BufferModeSettings class using specified settings.

Properties

CurrentConfiguration	Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement)
ElementInformation	Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement)
ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement)
EvaluationContext	Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement)
HasContext	Gets a value that indicates whether the CurrentConfiguration property is `null`. (Inherited from ConfigurationElement)
Item[ConfigurationProperty]	Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement)
Item[String]	Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement)
LockAllAttributesExcept	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockAllElementsExcept	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockAttributes	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockElements	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockItem	Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement)
MaxBufferSize	Gets or sets the maximum number of events that can be buffered at one time.
MaxBufferThreads	Gets or sets the maximum number of flushing threads that can be active at one time.
MaxFlushSize	Gets or sets the maximum number of events per flush.
Name	Gets or sets the name of the BufferModeSettings object.
Properties	Gets the collection of properties. (Inherited from ConfigurationElement)
RegularFlushInterval	Gets or sets the amount of time between buffer flushes.
UrgentFlushInterval	Gets or sets the minimum amount of time that can pass between buffer flushes.
UrgentFlushThreshold	Gets or sets the number of events that can be buffered before a flush is triggered.

Methods

DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
Equals(Object)	Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement)
GetHashCode()	Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement)
GetTransformedAssemblyString(String)	Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement)
GetTransformedTypeString(String)	Returns the transformed version of the specified type name. (Inherited from ConfigurationElement)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Init()	Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement)
InitializeDefault()	Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement)
IsModified()	Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement)
IsReadOnly()	Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement)
ListErrors(IList)	Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)	Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String)	Throws an exception when a required property is not found. (Inherited from ConfigurationElement)
PostDeserialize()	Called after deserialization. (Inherited from ConfigurationElement)
PreSerialize(XmlWriter)	Called before serialization. (Inherited from ConfigurationElement)
Reset(ConfigurationElement)	Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement)
ResetModified()	Resets the value of the IsModified() method to `false` when implemented in a derived class. (Inherited from ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Sets a property to the specified value. (Inherited from ConfigurationElement)
SetReadOnly()	Sets the IsReadOnly() property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement)

Applies to

Compartir vía