// -*- c++ -*- // Generated by gtkmmproc -- DO NOT MODIFY! #ifndef _GIOMM_BUFFEREDINPUTSTREAM_H #define _GIOMM_BUFFEREDINPUTSTREAM_H #include // -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*- /* 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 Library General Public * License as published by the Free Software Foundation; either * version 2 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 * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the Free * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ #include #include #ifndef DOXYGEN_SHOULD_SKIP_THIS typedef struct _GBufferedInputStream GBufferedInputStream; typedef struct _GBufferedInputStreamClass GBufferedInputStreamClass; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gio { class BufferedInputStream_Class; } // namespace Gio 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 * * @newin2p16 */ class BufferedInputStream : public Gio::FilterInputStream { #ifndef DOXYGEN_SHOULD_SKIP_THIS public: typedef BufferedInputStream CppObjectType; typedef BufferedInputStream_Class CppClassType; typedef GBufferedInputStream BaseObjectType; typedef GBufferedInputStreamClass BaseClassType; private: friend class BufferedInputStream_Class; static CppClassType bufferedinputstream_class_; private: // noncopyable BufferedInputStream(const BufferedInputStream&); BufferedInputStream& operator=(const BufferedInputStream&); protected: explicit BufferedInputStream(const Glib::ConstructParams& construct_params); explicit BufferedInputStream(GBufferedInputStream* castitem); #endif /* DOXYGEN_SHOULD_SKIP_THIS */ public: virtual ~BufferedInputStream(); #ifndef DOXYGEN_SHOULD_SKIP_THIS static GType get_type() G_GNUC_CONST; static GType get_base_type() G_GNUC_CONST; #endif ///Provides access to the underlying C GObject. GBufferedInputStream* gobj() { return reinterpret_cast(gobject_); } ///Provides access to the underlying C GObject. const GBufferedInputStream* gobj() const { return reinterpret_cast(gobject_); } ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. GBufferedInputStream* gobj_copy(); private: protected: explicit BufferedInputStream(const Glib::RefPtr& base_stream); explicit BufferedInputStream(const Glib::RefPtr& base_stream, gsize size); public: static Glib::RefPtr create(const Glib::RefPtr& base_stream); static Glib::RefPtr create_sized(const Glib::RefPtr& base_stream, gsize size); /** Gets the size of the input buffer. * @return The current buffer size. */ gsize get_buffer_size() const; /** Sets the size of the internal buffer of @a stream to @a size, or to the * size of the contents of the buffer. The buffer can never be resized * smaller than its current contents. * @param size A #gsize. */ void set_buffer_size(gsize size); /** Gets the size of the available data within the stream. * @return Size of the available stream. */ gsize get_available() const; /** Peeks in the buffer, copying data of size @a count into @a buffer, * offset @a offset bytes. * @param buffer A pointer to an allocated chunk of memory. * @param offset A #gsize. * @param count A #gsize. * @return A #gsize of the number of bytes peeked, or %-1 on error. */ gsize peek(void* buffer, gsize offset, gsize count) const; /** Returns: read-only buffer * @param count A #gsize to get the number of bytes available in the buffer. * @return Read-only buffer. */ const void* peek_buffer(gsize& count) const; /** Tries to read @a count bytes from the stream into the buffer. * Will block during this read. * * If @a count is zero, returns zero and does nothing. A value of @a count * larger than MAXSSIZE will cause a Gio::Error to be thrown, with INVALID_ARGUMENT. * * On success, the number of bytes read into the buffer is returned. * It is not an error if this is not the same as the requested size, as it * can happen e.g. near the end of a file. Zero is returned on end of file * (or if @a count is zero), but never otherwise. * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error will be thrown with CANCELLED. If an * operation was partially finished when the operation was cancelled the * partial result will be returned, without an error. * * * * For the asynchronous, non-blocking, version of this function, see * g_buffered_input_stream_fill_async(). * @param count The number of bytes that will be read from the stream. * @param cancellable Cancellable object. * @return The number of bytes read into @a stream's buffer, up to @a count, * or -1 on error. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED gssize fill(gssize count, const Glib::RefPtr& cancellable); #else gssize fill(gssize count, const Glib::RefPtr& cancellable, std::auto_ptr& error); #endif //GLIBMM_EXCEPTIONS_ENABLED /** non-cancellable version of fill() */ #ifdef GLIBMM_EXCEPTIONS_ENABLED gssize fill(gssize count); #else gssize fill(gssize count, std::auto_ptr& error); #endif //GLIBMM_EXCEPTIONS_ENABLED /** 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); /** Finishes an asynchronous read. * @param result A AsyncResult. * @return A #gssize of the read stream, or %-1 on an error. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED gssize fill_finish(const Glib::RefPtr& result); #else gssize fill_finish(const Glib::RefPtr& result, std::auto_ptr& error); #endif //GLIBMM_EXCEPTIONS_ENABLED /** Tries to read a single byte from the stream or the buffer. Will block * during this read. * * On success, the byte read from the stream is returned. On end of stream * -1 is returned but it's not an exceptional error and @a error is not set. * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error will be thrown with CANCELLED. If an * operation was partially finished when the operation was cancelled the * partial result will be returned, without an error. * @param cancellable Cancellable object. * @return The byte read from the @a stream, or -1 on end of stream or error. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED int read_byte(const Glib::RefPtr& cancellable); #else int read_byte(const Glib::RefPtr& cancellable, std::auto_ptr& error); #endif //GLIBMM_EXCEPTIONS_ENABLED /** Non-cancellable version of read_byte. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED int read_byte(); #else int read_byte(std::auto_ptr& error); #endif //GLIBMM_EXCEPTIONS_ENABLED protected: //_WRAP_VFUNC(gssize fill(gssize count, const Glib::RefPtr& cancellable, GError** error), "fill") public: public: //C++ methods used to invoke GTK+ virtual functions: #ifdef GLIBMM_VFUNCS_ENABLED #endif //GLIBMM_VFUNCS_ENABLED protected: //GTK+ Virtual Functions (override these to change behaviour): #ifdef GLIBMM_VFUNCS_ENABLED #endif //GLIBMM_VFUNCS_ENABLED //Default Signal Handlers:: #ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED #endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED }; } // namespace Gio namespace Glib { /** A Glib::wrap() method for this object. * * @param object The C instance. * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref. * @result A C++ instance that wraps this C instance. * * @relates Gio::BufferedInputStream */ Glib::RefPtr wrap(GBufferedInputStream* object, bool take_copy = false); } #endif /* _GIOMM_BUFFEREDINPUTSTREAM_H */