Enumerator Timeout; Configuration And Status Query Arguments - Dell DX6000 Setup And Configuration Manual

If for any reason the request is not successful, a 404 response code will be returned with a
descriptive message in the response body as to the encountered problem.
C.5. Enumerator Timeout
The DX Content Router Publisher will repurpose the existing configuration parameter called
subscriberTimeout. If an enumerator is not accessed using GET for a time period equal to
subscriberTimeout seconds, it will be automatically terminated and removed. The timeout period
applies to enumerators created for any channel of a Publisher service. It is configurable in the
publisher.cfg file, with a default value of 90000 seconds (25 hrs).
An individual Enumerator may override the publisher timeout value. This is done by including a
timeout query arg on the POST request, as follows:
POST /<channel>?start=<date-time1>&end=<date-time2>&type=UUID&timeout=86400 HTTP/1.1
C.6. Configuration and Status Query Arguments
The following can be supplied on either an enumerator Start or Next command:
Argument Name
version
context
maxItems
offlineAfter
errOfflineAfter
Copyright © 2010 Caringo, Inc.
All rights reserved
Description
Enumerator client's software version string.
When provided, this value will be displayed on
the Publisher console in association with the
channel/subscription rule set name.
The descriptive name for an enumerator
instance of a particular channel. When
provided, this value will be displayed onthe
Publisher console in the expandable section
with enumerator details.
Maximum number of items to send in this
request response. Sending a value of 0 is a
logical pause that changes the enumerator's
state to "Paused" on the Publisher console.
The enumerator will remain paused until a non-
zero maxItems value is received. If neither the
enumerator start or a next request specifies a
value for the maxItems parameter, Publisher
sets the maxItems value to 5000. A negative or
non-integer value is interpreted as a 0.
Number of seconds the Publisher should
wait after the last enumerator query before
declaring the enumerator as offline. When
used, this parameter should be some multiple
of the expected interval between enumerator
queries. When not specified, a default value for
offlineAfter will be derived from the Publisher's
"subscriberOfflineAfter" configuration value.
Number of seconds the Publisher should
wait after the last enumerator query before
showing an offline error. When used, this
parameter should be some multiple of the
38
Version 2.2
December 2010