C.3. Enumerator Next
The Enumerator Next command is a request for the next objects in an enumeration which was
previously initiated with an Enumerator Start command. For performance reasons Publisher does
not attempt to retrieve elements in a specific order.
The format of the request is as follows:
GET /<Enumerator UUID>?maxItems=<max-objects-to-retrieve> HTTP/1.1
Host: <publisherhost>
Note the maxItems query argument is only supported for the UUID and Event enumerator types. A
maxItems argument supplied for a Metadata enumerator will be ignored.
C.3.1. Enumerator Next Query Arguments
The following optional query arguments are defined for the Next command only and used to convey
status information about the Enumerator to the Publisher. The Publisher will use some but not all of
this information to update Enumerator status on the Publisher console. See also the Configuration
and Status Query Arguments section below for additional optional arguments that are shared with
the Start method:
Argument Name
upTime
backLog
inProgress
dropped
syncToken
Copyright © 2010 Caringo, Inc.
All rights reserved
Description
Number of seconds since the subscriber was
started.
Number of items the subscriber is holding that it
has not begun processing.
Number of items the subscriber is actively
processing.
Number of items that the subscriber has failed
to process. The dropped query argument
provides the subscriber a way to report possible
trouble conditions to the Publisher. Subscribers
should take care to only "drop" events after
sufficient retries. Note: Dropped events will
not be resent by the Publisher without manual
intervention using the Republish or Republish
All commands from the Publisher Console.
The value of the Content-Sync-Token header
from the last successfully received Start or Next
response. The Content-Sync-Token is used to
confirm with the Publisher that a request was
successfully received and ensure UUIDs are
not missed due to a network or connectivity
issue. If the syncToken matches the one
expected by the Publisher from the previous
request, the next set of requested UUIDs will
be sent. If the syncToken does not match, the
Publisher will resend the previous set of UUIDs.
If the syncToken is not present on the request,
the Publisher will automatically send the next
set of requested UUIDs.
36
Version 2.2
December 2010
ページを印刷する