NamedCacheEnableObjectExpirationEventHandling Property

ScaleOut Software NamedCache API
Gets or sets a value indicating whether this NamedCache instance is enabled for StateServer object expiration events.

Namespace:  Soss.Client
Assembly:  soss_namedcache (in soss_namedcache.dll) Version: 6.1.0.0
Syntax

public bool EnableObjectExpirationEventHandling { get; set; }

Property Value

Type: Boolean
Remarks

When retrieving the value of EnableObjectExpirationEventHandling, the value returned indicates whether StateServer object expiration events are being received for this NamedCache's StateServer application (for any reason). More specifically, the value true will be returned from this property if any of the following are true:

  • EnableObjectExpirationEventHandling has previously been set to true and has not subsequently been set to false.
  • an ObjectExpired event handler has been established on this NamedCache
  • Parallel method invocations are in use on this NamedCache instance.
  • In ScaleOut ComputeServer, the EnableMethodInvocationEventHandling property has been set to true and has not subsequently been set to false.

Conversely, if all of the above are false, EnableObjectExpirationEventHandling will return false.

Note that it is not necessary to set this property to true to begin receiving object expiration notifications on your event handler. Simply registering for the event is sufficient.

See Also

Reference