WebEventBufferFlushInfo Class

Definition

Namespace:

System.Web.Management

Assembly:

System.Web.dll

Contains the parameters defining the flush buffer characteristics.

public ref class WebEventBufferFlushInfo sealed

public sealed class WebEventBufferFlushInfo

type WebEventBufferFlushInfo = class

Public NotInheritable Class WebEventBufferFlushInfo

Inheritance

Object

WebEventBufferFlushInfo

Examples

The following code example shows how to use the WebEventBufferFlushInfo class. This code example is part of a larger example provided for the BufferedWebEventProvider class.

// Processes the messages that have been buffered.
// It is called by the ASP.NET when the flushing of 
// the buffer is required.
public override void ProcessEventFlush(
    WebEventBufferFlushInfo flushInfo)
{

    // Customize event information to be sent to 
    // the Windows Event Viewer Application Log.
    customInfo.AppendLine(
        "SampleEventLogWebEventProvider buffer flush.");

    customInfo.AppendLine(
        string.Format("NotificationType: {0}",
        GetNotificationType(flushInfo)));

    customInfo.AppendLine(
        string.Format("EventsInBuffer: {0}",
        GetEventsInBuffer(flushInfo)));

    customInfo.AppendLine(
        string.Format(
        "EventsDiscardedSinceLastNotification: {0}",
        GetEventsDiscardedSinceLastNotification(flushInfo)));

    // Read each buffered event and send it to the
    // Application Log.
    foreach (WebBaseEvent eventRaised in flushInfo.Events)
        customInfo.AppendLine(eventRaised.ToString());

    // Store the information in the specified file.
    StoreToFile(customInfo, logFilePath, FileMode.Append);
}

    ' Processes the messages that have been buffered.
    ' It is called by the ASP.NET when the flushing of 
    ' the buffer is required according to the parameters 
    ' defined in the <bufferModes> element of the 
    ' <healthMonitoring> configuration section.
    Public Overrides Sub ProcessEventFlush(ByVal flushInfo _
    As WebEventBufferFlushInfo)

        ' Customize event information to be sent to 
        ' the Windows Event Viewer Application Log.
        customInfo.AppendLine( _
        "SampleEventLogWebEventProvider buffer flush.")

        customInfo.AppendLine(String.Format( _
        "NotificationType: {0}", _
        GetNotificationType(flushInfo)))

        customInfo.AppendLine(String.Format( _
        "EventsInBuffer: {0}", _
        GetEventsInBuffer(flushInfo)))

        customInfo.AppendLine(String.Format( _
        "EventsDiscardedSinceLastNotification: {0}", _
GetEventsDiscardedSinceLastNotification( _
flushInfo)))

        ' Read each buffered event and send it to the
        ' Application Log.
        Dim eventRaised As WebBaseEvent
        For Each eventRaised In flushInfo.Events
            customInfo.AppendLine(eventRaised.ToString())
        Next eventRaised
        ' Store the information in the specified file.
        StoreToFile(customInfo, logFilePath, _
        FileMode.Append)
    End Sub

Remarks

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.

The WebEventBufferFlushInfo class defines values that identify the buffer's current status. An instance of the class is passed as a parameter to the ProcessEventFlush method that processes the messages that have been buffered. ASP.NET health monitoring calls this method when the flushing of the buffer is required. This is determined by the parameters defined by the bufferModes element in the healthMonitoring configuration section.

Note

By design, the buffering mechanism might drop some events in order to keep pace with the incoming events. It is up to the user to adjust this mechanism by properly modifying the bufferModes element in the healthMonitoring configuration section.

Properties

Events	Gets the events collection in the current message.
EventsDiscardedSinceLastNotification	Gets the number of events dropped since the last notification.
EventsInBuffer	Gets the number of events in the buffer.
LastNotificationUtc	Gets the date and the time of the last notification.
NotificationSequence	Gets the message sequence in the current notification.
NotificationType	Gets the current notification type.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• ASP.NET Health Monitoring Overview