atomix-storage/src/main/java/io/atomix/storage/journal/ByteBufWriter.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 io.netty.buffer.ByteBuf;
  19 import org.eclipse.jdt.annotation.NonNullByDefault;
  20
  21 /**
  22  * A writer of {@link ByteBufJournal} entries.
  23  */
  24 @NonNullByDefault
  25 public interface ByteBufWriter {
  26     /**
  27      * Returns the last written index.
  28      *
  29      * @return The last written index
  30      */
  31     long lastIndex();
  32
  33     /**
  34      * Returns the next index to be written.
  35      *
  36      * @return The next index to be written
  37      */
  38     long nextIndex();
  39
  40     /**
  41      * Appends an entry to the journal.
  42      *
  43      * @param bytes Data block to append
  44      * @return The index of appended data block
  45      */
  46     // FIXME: throws IOException
  47     long append(ByteBuf bytes);
  48
  49     /**
  50      * Commits entries up to the given index.
  51      *
  52      * @param index The index up to which to commit entries.
  53      */
  54     void commit(long index);
  55
  56     /**
  57      * Resets the head of the journal to the given index.
  58      *
  59      * @param index the next index to write
  60      * @throws IndexOutOfBoundsException if the journal cannot be reset to specified index
  61      */
  62     // FIXME: throws IOException
  63     void reset(long index);
  64
  65     /**
  66      * Truncates the log to the given index.
  67      *
  68      * @param index The index to which to truncate the log.
  69      * @throws IndexOutOfBoundsException if the journal cannot be reset to specified index
  70      */
  71     // FIXME: reconcile with reset()
  72     // FIXME: throws IOException
  73     void truncate(long index);
  74
  75     /**
  76      * Flushes written entries to disk.
  77      */
  78     // FIXME: throws IOException
  79     void flush();
  80 }