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 org.eclipse.jdt.annotation.NonNullByDefault;
  19
  20 /**
  21  * A writer of {@link ByteBufJournal} entries.
  22  */
  23 @NonNullByDefault
  24 public interface ByteBufWriter {
  25     /**
  26      * Returns the next index to be written.
  27      *
  28      * @return The next index to be written
  29      */
  30     long nextIndex();
  31
  32     /**
  33      * Appends an entry to the journal.
  34      *
  35      * @param mapper a {@link ByteBufMapper} to use with entry
  36      * @param entry entry to append
  37      * @return the on-disk size of the entry
  38      */
  39     // FIXME: throws IOException
  40     <T> int append(ByteBufMapper<T> mapper, T entry);
  41
  42     /**
  43      * Commits entries up to the given index.
  44      *
  45      * @param index The index up to which to commit entries.
  46      */
  47     void commit(long index);
  48
  49     /**
  50      * Resets the head of the journal to the given index.
  51      *
  52      * @param index the next index to write
  53      * @throws IndexOutOfBoundsException if the journal cannot be reset to specified index
  54      */
  55     // FIXME: throws IOException
  56     void reset(long index);
  57
  58     /**
  59      * Flushes written entries to disk.
  60      */
  61     // FIXME: throws IOException
  62     void flush();
  63 }