bookkeeper-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From si...@apache.org
Subject [bookkeeper] branch master updated: ISSUE #367: [DOCUMENTATION] add api readUnconfirmedEntries in website doc
Date Sat, 05 Aug 2017 06:13:54 GMT
This is an automated email from the ASF dual-hosted git repository.

sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git


The following commit(s) were added to refs/heads/master by this push:
     new 31960b0  ISSUE #367: [DOCUMENTATION] add api readUnconfirmedEntries in website doc
31960b0 is described below

commit 31960b027f391ee8ca7400cb3e647c20864966a3
Author: zhaijack <zhaijia03@gmail.com>
AuthorDate: Fri Aug 4 23:13:48 2017 -0700

    ISSUE #367: [DOCUMENTATION] add api readUnconfirmedEntries in website doc
    
    Descriptions of the changes in this PR:
    
    add api readUnconfirmedEntries in website doc
    
    ---
    Be sure to do all of the following to help us incorporate your contribution
    quickly and easily:
    
    - [X] Make sure the PR title is formatted like:
        `<Issue # or BOOKKEEPER-#>: Description of pull request`
        `e.g. Issue 123: Description ...`
        `e.g. BOOKKEEPER-1234: Description ...`
    - [ ] Make sure tests pass via `mvn clean apache-rat:check install findbugs:check`.
    - [X] Replace `<Issue # or BOOKKEEPER-#>` in the title with the actual Issue/JIRA
number.
    
    ---
    
    Author: zhaijack <zhaijia03@gmail.com>
    
    Reviewers: Enrico Olivelli <eolivelli@gmail.com>, Sijie Guo <sijie@apache.org>
    
    This closes #371 from zhaijack/issue367, closes #367
---
 site/docs/api/ledger-api.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/site/docs/api/ledger-api.md b/site/docs/api/ledger-api.md
index bb6cb77..3d47de2 100644
--- a/site/docs/api/ledger-api.md
+++ b/site/docs/api/ledger-api.md
@@ -152,6 +152,24 @@ while (entries.hasNextElement()) {
 }
 ```
 
+### Reading entries after the LastAddConfirmed range
+
+`readUnconfirmedEntries` allowing to read after the LastAddConfirmed range.
+It lets the client read without checking the local value of LastAddConfirmed, so that it
is possible to read entries for which the writer has not received the acknowledge yet
+For entries which are within the range 0..LastAddConfirmed BookKeeper guarantees that the
writer has successfully received the acknowledge.
+For entries outside that range it is possible that the writer never received the acknowledge
and so there is the risk that the reader is seeing entries before the writer and this could
result in a consistency issue in some cases.
+With this method you can even read entries before the LastAddConfirmed and entries after
it with one call, the expected consistency will be as described above.
+
+```java
+Enumerator<LedgerEntry> entries =
+  handle.readUnconfirmedEntries(0, lastEntryIdExpectedToRead);
+
+while (entries.hasNextElement()) {
+    LedgerEntry entry = entries.nextElement();
+    System.out.println("Successfully read entry " + entry.getId());
+}
+```
+
 ## Deleting ledgers
 
 {% pop Ledgers %} can also be deleted synchronously or asynchronously.

-- 
To stop receiving notification emails like this one, please contact
['"commits@bookkeeper.apache.org" <commits@bookkeeper.apache.org>'].

Mime
View raw message