atomix-storage/src/main/java/io/atomix/storage/journal/ByteBufJournal.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 io.atomix.storage.journal;
  17
  18 import org.eclipse.jdt.annotation.NonNullByDefault;
  19
  20 /**
  21  * A journal of byte arrays. Provides the ability to write modify entries via {@link ByteBufWriter} and read them
  22  * back via {@link ByteBufReader}.
  23  */
  24 @NonNullByDefault
  25 public interface ByteBufJournal extends AutoCloseable {
  26     /**
  27      * Returns the journal writer.
  28      *
  29      * @return The journal writer.
  30      */
  31     ByteBufWriter writer();
  32
  33     /**
  34      * Opens a new {@link ByteBufReader} reading all entries.
  35      *
  36      * @param index The index at which to start the reader.
  37      * @return A new journal reader.
  38      */
  39     ByteBufReader openReader(long index);
  40
  41     /**
  42      * Opens a new {@link ByteBufReader} reading only committed entries.
  43      *
  44      * @param index The index at which to start the reader.
  45      * @return A new journal reader.
  46      */
  47     ByteBufReader openCommitsReader(long index);
  48
  49     @Override
  50     void close();
  51 }