/*gstinputstream.h - Header file for the GstClasspathPlugin
 Copyright (C) 2007 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath 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, or (at your option)
any later version.

GNU Classpath 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.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

#ifndef __GST_INPUT_STREAM_H__
#define __GST_INPUT_STREAM_H__

typedef struct _GstInputStream GstInputStream;
typedef struct _GstInputStreamPrivate GstInputStreamPrivate;

struct _GstInputStream
{
  /* instance members */
  GstInputStreamPrivate *priv;
};

/**
 * Clean the given instance of GstInputStream so that the garbage
 * collector can collect the cached Java classes.
 * Call this fuction when you don't need anymore to use this instance of
 * GstInputStream. Note that failure to call this routine will result in
 * memroy leaks.
 */
void gst_input_stream_clean (GstInputStream *self);

/**
 * Perform the "read" operation on this GstInputStream.
 */
int gst_input_stream_read (GstInputStream *self, int *data, int offset,
                           int length);

/**
 * Returns the number of byte currently available for read in this
 * GstInputStream.
 */
int gst_input_stream_available (GstInputStream *self);

#endif /* __GST_INPUT_STREAM_H__ */