/* Copyright (C) 2008 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see .
*/
#include
#include
#include
_DEFS(giomm,gio)
_PINCLUDE(giomm/private/filterinputstream_p.h)
namespace Gio
{
/** @defgroup Streams Stream Classes
*
*/
/** The buffered input stream implements FilterInputStream and provides for buffered reads.
* By default, BufferedInputStream's buffer size is set at 4 kilobytes, but you can specify
* this to the constructor.
*
* To get the size of a buffer within a buffered input stream, use get_buffer_size().
* To change the size of a buffered input stream's buffer, use set_buffer_size().
* Note that the buffer's size cannot be reduced below the size of the data within the buffer.
*
* @ingroup Streams
*
* @newin{2,16}
*/
class GIOMM_API BufferedInputStream : public Gio::FilterInputStream, public Gio::Seekable
{
_CLASS_GOBJECT(BufferedInputStream, GBufferedInputStream, G_BUFFERED_INPUT_STREAM, Gio::FilterInputStream, GFilterInputStream, , , GIOMM_API)
_IMPLEMENTS_INTERFACE(Seekable)
protected:
_WRAP_CTOR(BufferedInputStream(const Glib::RefPtr& base_stream), g_buffered_input_stream_new)
//Note that we rename the size parameter to buffer_size because that is the actual name of the property.
_WRAP_CTOR(BufferedInputStream(const Glib::RefPtr& base_stream, gsize buffer_size), g_buffered_input_stream_new_sized)
public:
/** Creates a new InputStream from the given base_stream, with a buffer set to the default size (4 kilobytes).
*
* @param base_stream An InputStream.
* @result an InputStream for the given base_stream.
*/
_WRAP_CREATE(const Glib::RefPtr& base_stream)
/** Creates a new InputStream from the given base_stream, with a buffer set to size.
*
* @param base_stream An InputStream.
* @param buffer_size A size.
* @result an InputStream for the given base_stream.
*/
static Glib::RefPtr create_sized(const Glib::RefPtr& base_stream, gsize buffer_size);
_WRAP_METHOD(gsize get_buffer_size() const, g_buffered_input_stream_get_buffer_size)
_WRAP_METHOD(void set_buffer_size(gsize size), g_buffered_input_stream_set_buffer_size)
_WRAP_METHOD(gsize get_available() const, g_buffered_input_stream_get_available)
_WRAP_METHOD(gsize peek(void* buffer, gsize offset, gsize count) const, g_buffered_input_stream_peek)
_WRAP_METHOD(const void* peek_buffer(gsize& count) const, g_buffered_input_stream_peek_buffer)
_WRAP_METHOD(gssize fill(gssize count, const Glib::RefPtr& cancellable{?}), g_buffered_input_stream_fill, errthrow)
_IGNORE(g_buffered_input_stream_fill_async)
/** Reads data into the stream's buffer asynchronously, up to @a count size.
* @a io_priority can be used to prioritize reads. For the synchronous version of
* this function, see fill().
*
* @param slot A AsyncReadyCallback.
* @param count The number of bytes to read.
* @param cancellable Cancellable object.
* @param io_priority the I/O priority of the request.
*/
void fill_async(const SlotAsyncReady& slot,
gssize count,
const Glib::RefPtr& cancellable,
int io_priority = Glib::PRIORITY_DEFAULT);
/** Reads data into the stream's buffer asynchronously, up to @a count size.
* @a io_priority can be used to prioritize reads. For the synchronous version of
* this function, see fill().
*
* @param slot A AsyncReadyCallback.
* @param count The number of bytes to read.
* @param io_priority the I/O priority of the request.
*/
void fill_async(const SlotAsyncReady& slot,
gssize count,
int io_priority = Glib::PRIORITY_DEFAULT);
_WRAP_METHOD(gssize fill_finish(const Glib::RefPtr& result), g_buffered_input_stream_fill_finish, errthrow)
_WRAP_METHOD(int read_byte(const Glib::RefPtr& cancellable{?}), g_buffered_input_stream_read_byte, errthrow)
_WRAP_PROPERTY("buffer-size", guint)
protected:
#m4 _CONVERSION(`GCancellable*', `const Glib::RefPtr&', `Glib::wrap($3, true)')
_WRAP_VFUNC(gssize fill(gssize count, const Glib::RefPtr& cancellable), fill, errthrow, err_return_value -1)
};
} // namespace Gio