atomix-storage/src/main/java/org/opendaylight/controller/raft/journal/EntryReader.java

   1 /*
   2  * Copyright (c) 2024 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   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 org.opendaylight.controller.raft.journal;
  17
  18 import org.eclipse.jdt.annotation.NonNullByDefault;
  19 import org.eclipse.jdt.annotation.Nullable;
  20
  21 /**
  22  * A reader of {@link RaftJournal} entries.
  23  */
  24 @NonNullByDefault
  25 public interface EntryReader extends AutoCloseable {
  26     /**
  27      * Returns the next reader index.
  28      *
  29      * @return The next reader index
  30      */
  31     long nextIndex();
  32
  33     /**
  34      * Try to move to the next binary data block.
  35      *
  36      * @param mapper callback to be invoked on binary data
  37      * @return processed binary data, or {@code null}
  38      */
  39     <T> @Nullable T tryNext(FromByteBufMapper<T> mapper);
  40
  41     /**
  42      * Resets the reader to the start.
  43      */
  44     void reset();
  45
  46     /**
  47      * Resets the reader to the given index.
  48      *
  49      * @param index the next index to read
  50      */
  51     void reset(long index);
  52
  53     @Override
  54     void close();
  55 }