This document is archived and information here might be outdated.  Recommended version.

IServerObjectConfiguration.RecycleProperties Property (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Server > ESRI.ArcGIS.Server > Interfaces > IS > IServerObjectConfiguration Interface > IServerObjectConfiguration.RecycleProperties Property
ArcGIS Developer Help

IServerObjectConfiguration.RecycleProperties Property

The recycling properties for the server object configuration.

[Visual Basic .NET]
Public Property RecycleProperties As IPropertySet
public IPropertySet RecycleProperties {get; set;}
HRESULT get_RecycleProperties(
  IPropertySet** props
HRESULT putref_RecycleProperties(
  IPropertySet* props
props [out, retval]

props is a parameter of type IPropertySet** props [in]
props is a parameter of type IPropertySet*

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Pooled server objects are typically shared between multiple applications and users of those applications. Through reuse, a number of things can happen to a server object to make them unavailable for use by applications. For example, an application may incorrectly modify a server objects state, or an application may incorrectly hold a reference to a server object, making it unavailable to other applications or sessions. In some cases, server object may become corrupted and unusable.

Recycling allows for server objects that have become un-usable to be destroyed and replaced with fresh server objects, and to reclaim resources taken up by stale server objects. This process allows you to keep the pool of server objects fresh, and cycle out stale or unusable server objects.

You can get the recycling properties and change them using the RecyclingProperties property on the server object configuration. The RecyclingProperties property returns an IPropertySet. Use GetProperty, SetProperty on IPropertySet to get and set these properties. If you change these properties, you must call UpdateConfiguration to change them in the server object configuration.

You also use the RecyclingProperties property to get a reference on the PropertySet for a new server object configuration to set its properties before adding it to the server by calling AddConfiguration.

The properties associated with recylcing are:

StartTime which is time at which the recycling interval is initialized. The time specified is in 24 notation. For example, to set the start time at 2pm, the StartTime property would be 14:00.

Interval which defines the the time between recycling operations in seconds. For example, to recycle the configuration every hour, this property would be set to 3600.

See Also

IServerObjectConfiguration Interface | IPropertySet Interface