content: /*
   * Licensed to the Apache Software Foundation (ASF) under one
   * or more contributor license agreements.  See the NOTICE file
   * distributed with this work for additional information
   * regarding copyright ownership.  The ASF licenses this file
   * to you under the Apache License, Version 2.0 (the
   * "License"); you may not use this file except in compliance
   * with the License.  You may obtain a copy of the License at
   *
   *     http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.distributedlog.api;
  
  import java.util.List;
  import java.util.concurrent.CompletableFuture;
  import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
  import org.apache.bookkeeper.common.annotation.InterfaceStability.Evolving;
  import org.apache.distributedlog.DLSN;
  import org.apache.distributedlog.LogRecord;
  import org.apache.distributedlog.io.AsyncAbortable;
  import org.apache.distributedlog.io.AsyncCloseable;
  
  /**
   * AsyncLogWriter.
   */
  @Public
  @Evolving
  public interface AsyncLogWriter extends AsyncCloseable, AsyncAbortable {
  
      /**
       * Get the last committed transaction id.
       *
       * @return last committed transaction id.
       */
      long getLastTxId();
  
      /**
       * Write a log record to the stream.
       *
       * @param record single log record
       * @return A Future which contains a DLSN if the record was successfully written
       * or an exception if the write fails
       */
      CompletableFuture<DLSN> write(LogRecord record);
  
      /**
       * Write log records to the stream in bulk. Each future in the list represents the result of
       * one write operation. The size of the result list is equal to the size of the input list.
       * Buffers are written in order, and the list of result futures has the same order.
       *
       * @param record set of log records
       * @return A Future which contains a list of Future DLSNs if the record was successfully written
       * or an exception if the operation fails.
       */
      CompletableFuture<List<CompletableFuture<DLSN>>> writeBulk(List<LogRecord> record);
  
      /**
       * Truncate the log until <i>dlsn</i>.
       *
       * @param dlsn
       *          dlsn to truncate until.
       * @return A Future indicates whether the operation succeeds or not, or an exception
       * if the truncation fails.
       */
      CompletableFuture<Boolean> truncate(DLSN dlsn);
  
      /**
       * Seal the log stream.
       *
       * @return a future indicates whether the stream is sealed or not. The final transaction id is returned
       *         if the stream is sealed, otherwise an exception is returned.
       */
      CompletableFuture<Long> markEndOfStream();
  
      /**
       * Get the name of the stream this writer writes data to.
       */
      String getStreamName();
  }
  