/*
 * Copyright (C) 2012 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed 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.jboss.errai.bus.server.io.buffers;

import java.io.IOException;
import java.io.InputStream;
import java.util.concurrent.TimeUnit;

import org.jboss.errai.bus.server.io.ByteWriteAdapter;

/**
 * @author Mike Brock
 */
public interface Buffer {
  public void write(InputStream inputStream, BufferColor bufferColor) throws IOException;

  public void write(int writeSize, InputStream inputStream, BufferColor bufferColor) throws IOException;

  public boolean read(ByteWriteAdapter outputStream, BufferColor bufferColor) throws IOException;

  public boolean read(ByteWriteAdapter outputStream, BufferColor bufferColor, BufferFilter callback) throws IOException;

  public boolean read(ByteWriteAdapter outputStream, BufferColor bufferColor, BufferFilter callback, long sequence)
          throws IOException;
  

  public boolean readWait(ByteWriteAdapter outputStream, BufferColor bufferColor)
          throws IOException, InterruptedException;

  public boolean readWait(TimeUnit unit, long time, ByteWriteAdapter outputStream, BufferColor bufferColor)
          throws IOException, InterruptedException;

  public boolean readWait(ByteWriteAdapter outputStream, BufferColor bufferColor, BufferFilter callback)
          throws IOException, InterruptedException;

  public boolean readWait(TimeUnit unit, long time, ByteWriteAdapter outputStream, BufferColor bufferColor,
                          BufferFilter callback) throws IOException, InterruptedException;

  public long getHeadSequence();
  
  public int getHeadPositionBytes();
  
  public int getBufferSize();
  
  public int getTotalSegments();
  
  public int getSegmentSize();
  
}