An interval, in seconds, between processing runs for the dispatcher; during this time, the dispatcher remains idle and waits for incoming work. The value specified by this property can represent differing wait intervals depending on the class on which the property occurs, as follows:
- Except as noted below, represents a minimum wait interval, with a maximum wait interval defined by the LeaseDuration property.
- For the ICFSImportAgentConfiguration interface, represents a maximum wait interval. (The minimum interval is always 1 second and cannot be changed).
- For the IAsyncProcessingConfiguration interface, represents a fixed wait interval. (In effect, represents both the minimum and the maximum wait interval).
The interaction between the minimum and maximum intervals occurs in this manner: if in the previous processing run the dispatcher had work to perform, the duration of the subsequent wait interval that the dispatcher actually remains idle is the minimum interval; otherwise, if the dispatcher had no work to perform, the duration is the shorter of these two intervals: (a) Double the previous wait interval or (b) the maximum wait interval. As an example, assuming the minimum interval to be 35 seconds and the maximum as 120, the dispatcher remains idle for 35 seconds, detects no available work, remains idle for 70 seconds (double the previous wait interval), detects no available work, remains idle for 120 seconds (the maximum interval), detects no available work, remains idle for 120 seconds, detects incoming work and processes the work, remains idle for 35 seconds, and so on. Note that, when the minimal interval equals the maximum interval (as is always the case for the IAsyncProcessingConfiguration interface), this example can be simplified. If both the minimum and maximum interval is 35 seconds, the dispatcher remains idle for 35 seconds, detects no available work, remains idle for 35 seconds, detects incoming work and processes the work, remains idle for 35 seconds, and so on.
For the ICFSImportAgentConfiguration interface, this property, despite the name, applies to the importer sub-component known as the import agent and not to the import dispatcher; for information on the importer sub-components, see the ICFSImportAgentConfiguration interface.
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Property DispatcherWaitInterval As Nullable(Of Integer) |
C# |
---|
Nullable<int> DispatcherWaitInterval { get; set; } |
Visual C++ |
---|
property Nullable<int> DispatcherWaitInterval { Nullable<int> get (); void set (Nullable<int> value); } |
JavaScript |
---|
function get_dispatcherWaitInterval(); function set_dispatcherWaitInterval(value); |
Remarks
Metadata
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 180
PropertyMaximumInteger32: 10 * 60
PropertyMinimumInteger32: 5
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ