PreventPipeOverflow Method (IEventPipe2 Interface)

                    

 

Not Implemented

This method provides a mechanism to instruct the EventPipe to only retrieve events from the server if there is still room in the EventPipe for them.  An EventPipe has a MaxCount property which limits the number of events the pipe will hold.  Under ordinary conditions, the PI-SDK periodically retrieves events from the server and puts them into the EventPipe.  An application pulls these events from the EventPipe when it is ready to process them.  If an application does not retrieve events frequently enough from the EventPipe the pipe will overflow and the PI-SDK will toss the events it has retrieved from the server that won't fit into the pipe.  This design avoids problems on the server when applications retrieve EventPipes but do not empty them, leaving the server to provide storage for these requested events that are not picked up. 

In rare circumstances, an application may know it won't be able to service its EventPipe in a reasonable time due to other work it must perform for some short period.  This method allows such an application to force the server to store any events that won't fit into the EventPipe during this time period.  To use this method, the application should pass TRUE at the beginning of such a time period, perform the application specific work, process the events in the EventPipe, then call the method again passing FALSE to return to normal operation.

 

 Syntax

object.PreventPipeOverflow bPreventOverflow

 

The PreventPipeOverflow method syntax has these parts:

Part

Description

object

An object expression that evaluates to an IEventPipe2  interface.

bPreventOverflow

A boolean indicating whether the prevention should be turned on (TRUE) or off (FALSE).  By default the prevention is off.


Enabling Operational Intelligence