atomix-storage/src/main/java/io/atomix/storage/journal/JournalWriter.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 /**
  19  * Log writer.
  20  *
  21  * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
  22  */
  23 public interface JournalWriter<E> {
  24   /**
  25    * Returns the last written index.
  26    *
  27    * @return The last written index.
  28    */
  29   long getLastIndex();
  30
  31   /**
  32    * Returns the last entry written.
  33    *
  34    * @return The last entry written.
  35    */
  36   Indexed<E> getLastEntry();
  37
  38   /**
  39    * Returns the next index to be written.
  40    *
  41    * @return The next index to be written.
  42    */
  43   long getNextIndex();
  44
  45   /**
  46    * Appends an entry to the journal.
  47    *
  48    * @param entry The entry to append.
  49    * @return The appended indexed entry.
  50    */
  51   <T extends E> Indexed<T> append(T entry);
  52
  53   /**
  54    * Commits entries up to the given index.
  55    *
  56    * @param index The index up to which to commit entries.
  57    */
  58   void commit(long index);
  59
  60   /**
  61    * Resets the head of the journal to the given index.
  62    *
  63    * @param index the index to which to reset the head of the journal
  64    */
  65   void reset(long index);
  66
  67   /**
  68    * Truncates the log to the given index.
  69    *
  70    * @param index The index to which to truncate the log.
  71    */
  72   void truncate(long index);
  73
  74   /**
  75    * Flushes written entries to disk.
  76    */
  77   void flush();
  78 }