com.caucho.v5.db.journal.JournalStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of baratine Show documentation

A reactive Java web server.

There is a newer version: 1.0.1

/*
 * Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
 *
 * This file is part of Baratine(TM)
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Baratine is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Baratine is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Baratine; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.v5.db.journal;

import java.io.IOException;

import com.caucho.v5.vfs.ReadStream;

/**
 * Interface to the low level stream.
 * 
 * Each record is:
 *   (short sublen, data, crc32)+
 */
public interface JournalStream
{
  long getReplaySequence();

  void replay(ReplayCallback callback);
  
  void write(byte []buffer, int offset, int length);
  
  void start();
  boolean complete();

  void flush();

  boolean isSaveRequired();
  
  boolean saveStart();
  boolean saveEnd();
  
  void close();
  
  interface ReplayCallback
  {
    void onItem(ReadStream is)
      throws IOException;
    
    void completed();
  }
}