atomix-storage/src/main/java/io/atomix/storage/journal/JournalReader.java

   1 /*
   2  * Copyright 2017-present Open Networking Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package io.atomix.storage.journal;
  17
  18 import org.eclipse.jdt.annotation.Nullable;
  19
  20 /**
  21  * Log reader.
  22  *
  23  * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
  24  */
  25 public interface JournalReader<E> extends AutoCloseable {
  26     /**
  27      * Raft log reader mode.
  28      */
  29     enum Mode {
  30         /**
  31          * Reads all entries from the log.
  32          */
  33         ALL,
  34         /**
  35          * Reads committed entries from the log.
  36          */
  37         COMMITS,
  38     }
  39
  40     /**
  41      * Returns the first index in the journal.
  42      *
  43      * @return the first index in the journal
  44      */
  45     long getFirstIndex();
  46
  47     /**
  48      * Returns the current reader index.
  49      *
  50      * @return The current reader index.
  51      */
  52     long getCurrentIndex();
  53
  54     /**
  55      * Returns the last read entry.
  56      *
  57      * @return The last read entry.
  58      */
  59     Indexed<E> getCurrentEntry();
  60
  61     /**
  62      * Returns the next reader index.
  63      *
  64      * @return The next reader index.
  65      */
  66     long getNextIndex();
  67
  68     /**
  69      * Try to move to the next entry.
  70      *
  71      * @return The next entry in the reader, or {@code null} if there is no next entry.
  72      */
  73     @Nullable Indexed<E> tryNext();
  74
  75     /**
  76      * Resets the reader to the start.
  77      */
  78     void reset();
  79
  80     /**
  81      * Resets the reader to the given index.
  82      *
  83      * @param index The index to which to reset the reader.
  84      */
  85     void reset(long index);
  86
  87     @Override
  88     void close();
  89 }