BufferedWebEventProvider Class

 

Provides the base functionality for creating event providers that require buffering.

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


public ref class BufferedWebEventProvider abstract : WebEventProvider

NameDescription
System_CAPS_protmethodBufferedWebEventProvider()

Initializes a new instance of the BufferedWebEventProvider class.

NameDescription
System_CAPS_pubpropertyBufferMode

Gets a value indicating the buffering mode used by the provider.

System_CAPS_pubpropertyDescription

Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).(Inherited from ProviderBase.)

System_CAPS_pubpropertyName

Gets the friendly name used to refer to the provider during configuration.(Inherited from ProviderBase.)

System_CAPS_pubpropertyUseBuffering

Gets a value indicating whether the provider is in buffered mode.

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFlush()

Moves the events from the provider's buffer into the event log. (Overrides WebEventProvider::Flush().)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitialize(String^, NameValueCollection^)

Sets the initial values for this object.(Overrides ProviderBase::Initialize(String^, NameValueCollection^).)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodProcessEvent(WebBaseEvent^)

Processes the event passed to the provider.(Overrides WebEventProvider::ProcessEvent(WebBaseEvent^).)

System_CAPS_pubmethodProcessEventFlush(WebEventBufferFlushInfo^)

Processes the buffered events.

System_CAPS_pubmethodShutdown()

Performs tasks associated with shutting down the provider.(Overrides WebEventProvider::Shutdown().)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

ASP.NET health monitoring allows production and operations staff to manage deployed Web applications. The System.Web.Management namespace contains the health-event types responsible for packaging application health-status data and the provider types responsible for processing this data. It also contains supporting types that help during the management of health events.

If you want to customize the health-event processing, you can derive from the BufferedWebEventProvider class to create your own custom buffered provider.

System_CAPS_noteNote

In most cases you will be able to use the ASP.NET health-monitoring types as implemented, and you will control the health-monitoring system by specifying values in the healthMonitoring configuration section. You can also derive from the health-monitoring types to create your own custom events and providers. For an example of creating a custom provider, see How to: Implement the Health Monitoring Custom Provider Example.

The following code example shows how to derive from the BufferedWebEventProvider class to create a custom provider that writes the configured events to a local file for which appropriate access rights must be granted.

No code example is currently available or this language may not be supported.

The following configuration file excerpt shows a healthMonitoring configuration section that enables ASP.NET to use the custom provider defined above to process all health-monitoring events.

<healthMonitoring  
  heartBeatInterval="0" enabled="true">

  <bufferModes>
    <add name ="Custom Notification"
      maxBufferSize="10"
      maxFlushSize="5"
      urgentFlushThreshold="10"
      regularFlushInterval="Infinite"
      urgentFlushInterval="00:00:30"
      maxBufferThreads="1"
/>
  </bufferModes>

  <providers>
    <clear/>
    <add name="SampleBufferedWebEventProvider" 
      type="SamplesAspNet.SampleBufferedWebEventProvider, bufferedwebeventprovider, Version=1.0.1785.14700, Culture=neutral, PublicKeyToken=d31491bf33b55954, processorArchitecture=MSIL" 
      buffer="true"
      bufferMode="Custom Notification"
/>
  </providers>

  <profiles>
    <add name="Custom" 
      minInstances="1" 
      maxLimit="Infinite" 
      minInterval="00:00:00" />
  </profiles>

  <rules>
    <clear />
      <add name="Custom Buffered Web Event Provider" 
        eventName="All Events"
        provider="SampleBufferedWebEventProvider" 
        profile="Custom" />
  </rules>

</healthMonitoring>

.NET Framework
Available since 2.0

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

Return to top
Show: