From d4f63d89d3c797325865b7ac1281593f5d192982 Mon Sep 17 00:00:00 2001 From: Brad Fitzpatrick Date: Wed, 11 May 2011 06:11:44 -0700 Subject: [PATCH] Clarify enumerate docs: after and maxWaitSec are mutually exclusive --- doc/protocol/blob-enumerate-protocol.txt | 4 ++++ lib/go/camli/blobserver/interface.go | 3 +++ 2 files changed, 7 insertions(+) diff --git a/doc/protocol/blob-enumerate-protocol.txt b/doc/protocol/blob-enumerate-protocol.txt index cb88419b0..d4b44c9b4 100644 --- a/doc/protocol/blob-enumerate-protocol.txt +++ b/doc/protocol/blob-enumerate-protocol.txt @@ -14,6 +14,8 @@ URL GET parameters: after optional If provided, only blobs GREATER THAN this value are returned. + Can't be used in combination with 'maxwaitsec' + limit optional Limit the number of returned blobrefs. The server may have its own lower limit, however, so be sure to pay attention to the presence @@ -35,6 +37,8 @@ URL GET parameters: 'maxwaitsec' and wait for less time than requested by the client. + Can't be used in combination with 'after'. + Response: diff --git a/lib/go/camli/blobserver/interface.go b/lib/go/camli/blobserver/interface.go index 55794fa61..c53b063a6 100644 --- a/lib/go/camli/blobserver/interface.go +++ b/lib/go/camli/blobserver/interface.go @@ -83,6 +83,9 @@ type BlobEnumerator interface { // or 0 for no delay. // EnumerateBlobs must close the channel. (even if limit // was hit and more blobs remain) + // + // after and waitSeconds can't be used together. One must be + // its zero value. EnumerateBlobs(dest chan<- blobref.SizedBlobRef, after string, limit uint,