Paul Davis
a73d15e989
git-svn-id: svn://localhost/ardour2/branches/3.0@5306 d708f5d6-7413-0410-9779-e7cbd77b26cf
720 lines
30 KiB
C++
720 lines
30 KiB
C++
// -*- c++ -*-
|
|
// Generated by gtkmmproc -- DO NOT MODIFY!
|
|
#ifndef _GIOMM_OUTPUTSTREAM_H
|
|
#define _GIOMM_OUTPUTSTREAM_H
|
|
|
|
|
|
#include <glibmm.h>
|
|
|
|
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
|
|
/* Copyright (C) 2007 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 <glibmm/object.h>
|
|
#include <giomm/asyncresult.h>
|
|
#include <giomm/cancellable.h>
|
|
#include <giomm/inputstream.h>
|
|
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
typedef struct _GOutputStream GOutputStream;
|
|
typedef struct _GOutputStreamClass GOutputStreamClass;
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
|
|
namespace Gio
|
|
{ class OutputStream_Class; } // namespace Gio
|
|
namespace Gio
|
|
{
|
|
|
|
/** @addtogroup giommEnums Enums and Flags */
|
|
|
|
/**
|
|
* @ingroup giommEnums
|
|
* @par Bitwise operators:
|
|
* <tt>%OutputStreamSpliceFlags operator|(OutputStreamSpliceFlags, OutputStreamSpliceFlags)</tt><br>
|
|
* <tt>%OutputStreamSpliceFlags operator&(OutputStreamSpliceFlags, OutputStreamSpliceFlags)</tt><br>
|
|
* <tt>%OutputStreamSpliceFlags operator^(OutputStreamSpliceFlags, OutputStreamSpliceFlags)</tt><br>
|
|
* <tt>%OutputStreamSpliceFlags operator~(OutputStreamSpliceFlags)</tt><br>
|
|
* <tt>%OutputStreamSpliceFlags& operator|=(OutputStreamSpliceFlags&, OutputStreamSpliceFlags)</tt><br>
|
|
* <tt>%OutputStreamSpliceFlags& operator&=(OutputStreamSpliceFlags&, OutputStreamSpliceFlags)</tt><br>
|
|
* <tt>%OutputStreamSpliceFlags& operator^=(OutputStreamSpliceFlags&, OutputStreamSpliceFlags)</tt><br>
|
|
*/
|
|
enum OutputStreamSpliceFlags
|
|
{
|
|
OUTPUT_STREAM_SPLICE_NONE = 0,
|
|
OUTPUT_STREAM_SPLICE_CLOSE_SOURCE = 1 << 0,
|
|
OUTPUT_STREAM_SPLICE_CLOSE_TARGET = 1 << 1
|
|
};
|
|
|
|
/** @ingroup giommEnums */
|
|
inline OutputStreamSpliceFlags operator|(OutputStreamSpliceFlags lhs, OutputStreamSpliceFlags rhs)
|
|
{ return static_cast<OutputStreamSpliceFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
|
|
|
|
/** @ingroup giommEnums */
|
|
inline OutputStreamSpliceFlags operator&(OutputStreamSpliceFlags lhs, OutputStreamSpliceFlags rhs)
|
|
{ return static_cast<OutputStreamSpliceFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
|
|
|
|
/** @ingroup giommEnums */
|
|
inline OutputStreamSpliceFlags operator^(OutputStreamSpliceFlags lhs, OutputStreamSpliceFlags rhs)
|
|
{ return static_cast<OutputStreamSpliceFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
|
|
|
|
/** @ingroup giommEnums */
|
|
inline OutputStreamSpliceFlags operator~(OutputStreamSpliceFlags flags)
|
|
{ return static_cast<OutputStreamSpliceFlags>(~static_cast<unsigned>(flags)); }
|
|
|
|
/** @ingroup giommEnums */
|
|
inline OutputStreamSpliceFlags& operator|=(OutputStreamSpliceFlags& lhs, OutputStreamSpliceFlags rhs)
|
|
{ return (lhs = static_cast<OutputStreamSpliceFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
|
|
|
|
/** @ingroup giommEnums */
|
|
inline OutputStreamSpliceFlags& operator&=(OutputStreamSpliceFlags& lhs, OutputStreamSpliceFlags rhs)
|
|
{ return (lhs = static_cast<OutputStreamSpliceFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
|
|
|
|
/** @ingroup giommEnums */
|
|
inline OutputStreamSpliceFlags& operator^=(OutputStreamSpliceFlags& lhs, OutputStreamSpliceFlags rhs)
|
|
{ return (lhs = static_cast<OutputStreamSpliceFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
|
|
|
|
|
|
/** Base class for implementing streaming output.
|
|
*
|
|
* @ingroup Streams
|
|
*
|
|
* @newin2p16
|
|
*/
|
|
|
|
class OutputStream : public Glib::Object
|
|
{
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
|
|
public:
|
|
typedef OutputStream CppObjectType;
|
|
typedef OutputStream_Class CppClassType;
|
|
typedef GOutputStream BaseObjectType;
|
|
typedef GOutputStreamClass BaseClassType;
|
|
|
|
private: friend class OutputStream_Class;
|
|
static CppClassType outputstream_class_;
|
|
|
|
private:
|
|
// noncopyable
|
|
OutputStream(const OutputStream&);
|
|
OutputStream& operator=(const OutputStream&);
|
|
|
|
protected:
|
|
explicit OutputStream(const Glib::ConstructParams& construct_params);
|
|
explicit OutputStream(GOutputStream* castitem);
|
|
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
public:
|
|
virtual ~OutputStream();
|
|
|
|
#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.
|
|
GOutputStream* gobj() { return reinterpret_cast<GOutputStream*>(gobject_); }
|
|
|
|
///Provides access to the underlying C GObject.
|
|
const GOutputStream* gobj() const { return reinterpret_cast<GOutputStream*>(gobject_); }
|
|
|
|
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
|
GOutputStream* gobj_copy();
|
|
|
|
private:
|
|
|
|
|
|
public:
|
|
|
|
|
|
/** Tries to write @a count bytes from @a buffer into the stream. Will block
|
|
* during the operation.
|
|
*
|
|
* If count is zero returns zero and does nothing. A value of @a count
|
|
* larger than MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown.
|
|
*
|
|
* On success, the number of bytes written to the stream is returned.
|
|
* It is not an error if this is not the same as the requested size, as it
|
|
* can happen e.g. on a partial i/o error, or if there is not enough
|
|
* storage in the stream. All writes either block until at least one byte
|
|
* is written, so zero is never returned (unless @a count is zero).
|
|
*
|
|
* 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 buffer The buffer containing the data to write.
|
|
* @param count The number of bytes to write.
|
|
* @param cancellable Cancellable object.
|
|
* @return Number of bytes written, or -1 on error.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
gssize write(const void* buffer, gsize count, const Glib::RefPtr<Cancellable>& cancellable);
|
|
#else
|
|
gssize write(const void* buffer, gsize count, const Glib::RefPtr<Cancellable>& cancellable, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
/** Tries to write @a count bytes from @a buffer into the stream. Will block
|
|
* during the operation.
|
|
*
|
|
* If count is zero returns zero and does nothing. A value of @a count
|
|
* larger than MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown.
|
|
*
|
|
* On success, the number of bytes written to the stream is returned.
|
|
* It is not an error if this is not the same as the requested size, as it
|
|
* can happen e.g. on a partial i/o error, or if the there is not enough
|
|
* storage in the stream. All writes either block until at least one byte
|
|
* is written, so zero is never returned (unless @a count is zero).
|
|
*
|
|
* On error -1 is returned.
|
|
* @param buffer The buffer containing the data to write.
|
|
* @param count The number of bytes to write.
|
|
* @return Number of bytes written, or -1 on error.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
gssize write(const void* buffer, gsize count);
|
|
#else
|
|
gssize write(const void* buffer, gsize count, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
/** Tries to write @a count bytes from @a buffer into the stream. Will block
|
|
* during the operation.
|
|
*
|
|
* If count is zero returns zero and does nothing. A value of @a count
|
|
* larger than MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown.
|
|
*
|
|
* On success, the number of bytes written to the stream is returned.
|
|
* It is not an error if this is not the same as the requested size, as it
|
|
* can happen e.g. on a partial i/o error, or if the there is not enough
|
|
* storage in the stream. All writes either block until at least one byte
|
|
* is written, so zero is never returned (unless @a count is zero).
|
|
*
|
|
* On error -1 is returned.
|
|
* @param buffer The buffer containing the data to write.
|
|
* @param cancellable Cancellable object.
|
|
* @return Number of bytes written, or -1 on error.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
gssize write(const std::string& buffer, const Glib::RefPtr<Cancellable>& cancellable);
|
|
#else
|
|
gssize write(const std::string& buffer, const Glib::RefPtr<Cancellable>& cancellable, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
/** Tries to write @a count bytes from @a buffer into the stream. Will block
|
|
* during the operation.
|
|
*
|
|
* If string that is larger than MAXSSIZE bytes will cause a Gio::Error with INVALID_ARGUMENT to be thrown.
|
|
*
|
|
* On success, the number of bytes written to the stream is returned.
|
|
* It is not an error if this is not the same as the requested size, as it
|
|
* can happen e.g. on a partial i/o error, or if the there is not enough
|
|
* storage in the stream. All writes either block until at least one byte
|
|
* is written, so zero is never returned (unless @a count is zero).
|
|
*
|
|
* On error -1 is returned.
|
|
* @param buffer The buffer containing the data to write.
|
|
* @return Number of bytes written, or -1 on error.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
gssize write(const std::string& buffer);
|
|
#else
|
|
gssize write(const std::string& buffer, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
/** Tries to write @a count bytes from @a buffer into the stream. Will block
|
|
* during the operation.
|
|
*
|
|
* This function is similar to g_output_stream_write(), except it tries to
|
|
* write as many bytes as requested, only stopping on an error.
|
|
*
|
|
* On a successful write of @a count bytes, <tt>true</tt> is returned, and @a bytes_written
|
|
* is set to @a count.
|
|
*
|
|
* If there is an error during the operation <tt>false</tt> is returned and @a error
|
|
* is set to indicate the error status, @a bytes_written is updated to contain
|
|
* the number of bytes written into the stream before the error occurred.
|
|
* @param buffer The buffer containing the data to write.
|
|
* @param count The number of bytes to write.
|
|
* @param bytes_written Location to store the number of bytes that was
|
|
* written to the stream.
|
|
* @param cancellable Optional Cancellable object, <tt>0</tt> to ignore.
|
|
* @return <tt>true</tt> on success, <tt>false</tt> if there was an error.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
bool write_all(const void* buffer, gsize count, gsize& bytes_written, const Glib::RefPtr<Cancellable>& cancellable);
|
|
#else
|
|
bool write_all(const void* buffer, gsize count, gsize& bytes_written, const Glib::RefPtr<Cancellable>& cancellable, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
/** Tries to write @a count bytes from @a buffer into the stream. Will block
|
|
* during the operation.
|
|
*
|
|
* This function is similar to write(), except it tries to
|
|
* write as many bytes as requested, only stopping on an error.
|
|
*
|
|
* On a successful write of @a count bytes, <tt>true</tt> is returned, and @a bytes_written
|
|
* is set to @a count .
|
|
*
|
|
* If there is an error during the operation <tt>false</tt> is returned and @a error
|
|
* is set to indicate the error status, @a bytes_written is updated to contain
|
|
* the number of bytes written into the stream before the error occured.
|
|
* @param buffer The buffer containing the data to write.
|
|
* @param count The number of bytes to write.
|
|
* @param bytes_written Location to store the number of bytes that was
|
|
* written to the stream.
|
|
* @return <tt>true</tt> on success, <tt>false</tt> if there was an error.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
bool write_all(const void* buffer, gsize count, gsize& bytes_written);
|
|
#else
|
|
bool write_all(const void* buffer, gsize count, gsize& bytes_written, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
/** Tries to write @a count bytes from @a buffer into the stream. Will block
|
|
* during the operation.
|
|
*
|
|
* This function is similar to write(), except it tries to
|
|
* write as many bytes as requested, only stopping on an error.
|
|
*
|
|
* On a successful write of @a count bytes, <tt>true</tt> is returned, and @a bytes_written
|
|
* is set to @a count .
|
|
*
|
|
* If there is an error during the operation <tt>false</tt> is returned and @a error
|
|
* is set to indicate the error status, @a bytes_written is updated to contain
|
|
* the number of bytes written into the stream before the error occured.
|
|
* @param buffer The buffer containing the data to write.
|
|
* @param bytes_written Location to store the number of bytes that was
|
|
* written to the stream.
|
|
* @param cancellable Cancellable object.
|
|
* @return <tt>true</tt> on success, <tt>false</tt> if there was an error.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
bool write_all(const std::string& buffer, gsize& bytes_written, const Glib::RefPtr<Cancellable>& cancellable);
|
|
#else
|
|
bool write_all(const std::string& buffer, gsize& bytes_written, const Glib::RefPtr<Cancellable>& cancellable, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
/** Tries to write @a count bytes from @a buffer into the stream. Will block
|
|
* during the operation.
|
|
*
|
|
* This function is similar to write(), except it tries to
|
|
* write as many bytes as requested, only stopping on an error.
|
|
*
|
|
* On a successful write of @a count bytes, <tt>true</tt> is returned, and @a bytes_written
|
|
* is set to @a count .
|
|
*
|
|
* If there is an error during the operation <tt>false</tt> is returned and @a error
|
|
* is set to indicate the error status, @a bytes_written is updated to contain
|
|
* the number of bytes written into the stream before the error occured.
|
|
* @param buffer The buffer containing the data to write.
|
|
* @param bytes_written Location to store the number of bytes that was
|
|
* written to the stream.
|
|
* @return <tt>true</tt> on success, <tt>false</tt> if there was an error.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
bool write_all(const std::string& buffer, gsize& bytes_written);
|
|
#else
|
|
bool write_all(const std::string& buffer, gsize& bytes_written, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
/** Splices an input stream into an output stream.
|
|
*
|
|
* @param source An InputStream.
|
|
* @param flags A set of OutputStreamSpliceFlags.
|
|
* @param cancellable A Cancellable object.
|
|
* ignore.
|
|
* @return A #gssize containing the size of the data spliced.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
gssize splice(const Glib::RefPtr<InputStream>& source, const Glib::RefPtr<Cancellable>& cancellable, OutputStreamSpliceFlags flags = OUTPUT_STREAM_SPLICE_NONE);
|
|
#else
|
|
gssize splice(const Glib::RefPtr<InputStream>& source, const Glib::RefPtr<Cancellable>& cancellable, OutputStreamSpliceFlags flags, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
/** Splices an input stream into an output stream.
|
|
*
|
|
* @param source An InputStream.
|
|
* @param flags A set of OutputStreamSpliceFlags.
|
|
* ignore.
|
|
* @return A #gssize containing the size of the data spliced.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
gssize splice(const Glib::RefPtr<InputStream>& source, OutputStreamSpliceFlags flags = OUTPUT_STREAM_SPLICE_NONE);
|
|
#else
|
|
gssize splice(const Glib::RefPtr<InputStream>& source, OutputStreamSpliceFlags flags, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
/** Flushed any outstanding buffers in the stream. Will block during
|
|
* the operation. Closing the stream will implicitly cause a flush.
|
|
*
|
|
* This function is optional for inherited classes.
|
|
*
|
|
* 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.
|
|
* @param cancellable Cancellable object.
|
|
* @return <tt>true</tt> on success, <tt>false</tt> on error.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
bool flush(const Glib::RefPtr<Cancellable>& cancellable);
|
|
#else
|
|
bool flush(const Glib::RefPtr<Cancellable>& cancellable, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
/** Flushed any outstanding buffers in the stream. Will block during
|
|
* the operation. Closing the stream will implicitly cause a flush.
|
|
*
|
|
* This function is optional for inherited classes.
|
|
*
|
|
* The operation can be cancelled by
|
|
* triggering the cancellable object from another thread. If the operation
|
|
* was cancelled, a Gio::Error with CANCELLED will be thrown.
|
|
* @param cancellable Optional cancellable object.
|
|
* @return <tt>true</tt> on success, <tt>false</tt> on error.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
bool flush();
|
|
#else
|
|
bool flush(std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
/** Closes the stream, releasing resources related to it.
|
|
*
|
|
* Once the stream is closed, all other operations will throw a Gio::Error with
|
|
* CLOSED. Closing a stream multiple times will not cause an error to be
|
|
* thrown.
|
|
*
|
|
* Closing a stream will automatically flush any outstanding buffers in the
|
|
* stream.
|
|
*
|
|
* Streams will be automatically closed when the last reference
|
|
* is dropped, but you might want to call this function to make sure
|
|
* resources are released as early as possible.
|
|
*
|
|
* Some streams might keep the backing store of the stream (e.g. a file descriptor)
|
|
* open after the stream is closed. See the documentation for the individual
|
|
* stream for details.
|
|
*
|
|
* On failure the first error that happened will be reported, but the close
|
|
* operation will finish as much as possible. A stream that failed to
|
|
* close will still throw a Gio::Error with CLOSED for all operations. Still, it
|
|
* is important to check and report the error to the user, otherwise
|
|
* there might be a loss of data as all data might not be written.
|
|
*
|
|
* 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.
|
|
* Cancelling a close will still leave the stream closed, but there some streams
|
|
* can use a faster close that doesn't block to e.g. check errors. On
|
|
* cancellation (as with any error) there is no guarantee that all written
|
|
* data will reach the target.
|
|
* @param cancellable Cancellable object.
|
|
* @return <tt>true</tt> on success, <tt>false</tt> on failure.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
bool close(const Glib::RefPtr<Cancellable>& cancellable);
|
|
#else
|
|
bool close(const Glib::RefPtr<Cancellable>& cancellable, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
/** Closes the stream, releasing resources related to it.
|
|
*
|
|
* Once the stream is closed, all other operations will throw a Gio::Error with CLOSED.
|
|
* Closing a stream multiple times will not return an error.
|
|
*
|
|
* Closing a stream will automatically flush any outstanding buffers in the
|
|
* stream.
|
|
*
|
|
* Streams will be automatically closed when the last reference
|
|
* is dropped, but you might want to call make sure resources
|
|
* are released as early as possible.
|
|
*
|
|
* Some streams might keep the backing store of the stream (e.g. a file descriptor)
|
|
* open after the stream is closed. See the documentation for the individual
|
|
* stream for details.
|
|
*
|
|
* On failure the first error that happened will be reported, but the close
|
|
* operation will finish as much as possible. A stream that failed to
|
|
* close will still throw a Gio::Error with CLOSED for all operations. Still, it
|
|
* is important to check and report the error to the user, otherwise
|
|
* there might be a loss of data as all data might not be written.
|
|
*
|
|
* The operation can be cancelled by
|
|
* triggering the cancellable object from another thread. If the operation
|
|
* was cancelled, a Gio::Error with CANCELLED will be thrown.
|
|
* Cancelling a close will still leave the stream closed, but there some streams
|
|
* can use a faster close that doesn't block to e.g. check errors. On
|
|
* cancellation (as with any error) there is no guarantee that all written
|
|
* data will reach the target.
|
|
* @param cancellable Optional cancellable object.
|
|
* @return <tt>true</tt> on success, <tt>false</tt> on failure.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
bool close();
|
|
#else
|
|
bool close(std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
/** Request an asynchronous write of @a count bytes from @a buffer into
|
|
* the stream. When the operation is finished @a slot will be called.
|
|
* You can then call write_finish() to get the result of the
|
|
* operation.
|
|
*
|
|
* During an async request no other sync and async calls are allowed,
|
|
* and will result in Gio::Error with PENDING being thrown.
|
|
*
|
|
* A value of @a count larger than MAXSSIZE will cause a Gio::Error with
|
|
* NVALID_ARGUMENT to be thrown.
|
|
*
|
|
* On success, the number of bytes written will be passed to the
|
|
* callback @a slot. It is not an error if this is not the same as the
|
|
* requested size, as it can happen e.g. on a partial I/O error,
|
|
* but generally we try to write as many bytes as requested.
|
|
*
|
|
* Any outstanding I/O request with higher priority (lower numerical
|
|
* value) will be executed before an outstanding request with lower
|
|
* priority. Default priority is Glib::PRIORITY_DEFAULT.
|
|
*
|
|
* The asyncronous methods have a default fallback that uses threads
|
|
* to implement asynchronicity, so they are optional for inheriting
|
|
* classes. However, if you override one you must override all.
|
|
*
|
|
* For the synchronous, blocking version of this function, see
|
|
* write().
|
|
*
|
|
* @param buffer The buffer containing the data to write.
|
|
* @param count The number of bytes to write
|
|
* @param slot Callback slot to call when the request is satisfied.
|
|
* @param cancellable Cancellable object.
|
|
* @param io_priority The io priority of the request.
|
|
*/
|
|
void write_async(const void* buffer, gsize count, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT);
|
|
|
|
/** Request an asynchronous write of @a count bytes from @a buffer into
|
|
* the stream. When the operation is finished @a slot will be called.
|
|
* You can then call write_finish() to get the result of the
|
|
* operation.
|
|
*
|
|
* During an async request no other sync and async calls are allowed,
|
|
* and will result in Gio::Error with PENDING being thrown.
|
|
*
|
|
* A value of @a count larger than MAXSSIZE will cause a Gio::Error with
|
|
* INVALID_ARGUMENT to be thrown.
|
|
*
|
|
* On success, the number of bytes written will be passed to the
|
|
* callback @a slot. It is not an error if this is not the same as the
|
|
* requested size, as it can happen e.g. on a partial I/O error,
|
|
* but generally we try to write as many bytes as requested.
|
|
*
|
|
* Any outstanding I/O request with higher priority (lower numerical
|
|
* value) will be executed before an outstanding request with lower
|
|
* priority. Default priority is Glib::PRIORITY_DEFAULT.
|
|
*
|
|
* The asyncronous methods have a default fallback that uses threads
|
|
* to implement asynchronicity, so they are optional for inheriting
|
|
* classes. However, if you override one you must override all.
|
|
*
|
|
* For the synchronous, blocking version of this function, see
|
|
* write().
|
|
*
|
|
* @param buffer The buffer containing the data to write.
|
|
* @param count The number of bytes to write
|
|
* @param slot Callback slot to call when the request is satisfied.
|
|
* @param io_priority The io priority of the request.
|
|
*/
|
|
void write_async(const void* buffer, gsize count, const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT);
|
|
|
|
|
|
/** Finishes a stream write operation.
|
|
* @param result A AsyncResult.
|
|
* @return A #gssize containing the number of bytes written to the stream.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
gssize write_finish(const Glib::RefPtr<AsyncResult>& result);
|
|
#else
|
|
gssize write_finish(const Glib::RefPtr<AsyncResult>& result, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
/** Splices a stream asynchronously.
|
|
* When the operation is finished @a slot will be called.
|
|
* You can then call splice_finish() to get the result of the
|
|
* operation.
|
|
*
|
|
* For the synchronous, blocking version of this function, see
|
|
* splice().
|
|
*
|
|
* @param source An InputStream.
|
|
* @param slot Callback slot to call when the request is satisfied.
|
|
* @param cancellable Cancellable object.
|
|
* @param io_priority The io priority of the request.
|
|
*/
|
|
void splice_async(const Glib::RefPtr<InputStream>& source, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, OutputStreamSpliceFlags flags = OUTPUT_STREAM_SPLICE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
|
|
|
|
/** Splices a stream asynchronously.
|
|
* When the operation is finished @a slot will be called.
|
|
* You can then call splice_finish() to get the result of the
|
|
* operation.
|
|
*
|
|
* For the synchronous, blocking version of this function, see
|
|
* splice().
|
|
*
|
|
* @param source An InputStream.
|
|
* @param slot Callback slot to call when the request is satisfied.
|
|
* @param io_priority The io priority of the request.
|
|
*/
|
|
void splice_async(const Glib::RefPtr<InputStream>& source, const SlotAsyncReady& slot, OutputStreamSpliceFlags flags = OUTPUT_STREAM_SPLICE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
|
|
|
|
|
|
/** Finishes an asynchronous stream splice operation.
|
|
* @param result A AsyncResult.
|
|
* @return A #gssize of the number of bytes spliced.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
gssize splice_finish(const Glib::RefPtr<AsyncResult>& result);
|
|
#else
|
|
gssize splice_finish(const Glib::RefPtr<AsyncResult>& result, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
/** Flushes a stream asynchronously.
|
|
* When the operation is finished the @a slot will be called, giving the results.
|
|
* You can then call flush_finish() to get the result of the operation.
|
|
* For behaviour details see flush().
|
|
*
|
|
* @param slot Callback slot to call when the request is satisfied.
|
|
* @param cancellable Cancellable object.
|
|
* @param io_priority The io priority of the request.
|
|
*/
|
|
void flush_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT);
|
|
|
|
/** Flushes a stream asynchronously.
|
|
* When the operation is finished the @a slot will be called, giving the results.
|
|
* You can then call flush_finish() to get the result of the operation.
|
|
* For behaviour details see flush().
|
|
*
|
|
* @param slot Callback slot to call when the request is satisfied.
|
|
* @param io_priority The io priority of the request.
|
|
*/
|
|
void flush_async(const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT);
|
|
|
|
|
|
/** Finishes flushing an output stream.
|
|
* @param result A GAsyncResult.
|
|
* @return <tt>true</tt> if flush operation suceeded, <tt>false</tt> otherwise.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
bool flush_finish(const Glib::RefPtr<AsyncResult>& result);
|
|
#else
|
|
bool flush_finish(const Glib::RefPtr<AsyncResult>& result, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
/** Requests an asynchronous close of the stream, releasing resources related to it.
|
|
* When the operation is finished the @a slot will be called, giving the results.
|
|
* You can then call close_finish() to get the result of the operation.
|
|
* For behaviour details see close().
|
|
*
|
|
* The asyncronous methods have a default fallback that uses threads to implement asynchronicity,
|
|
* so they are optional for inheriting classes. However, if you override one you must override all.
|
|
*
|
|
* @param slot Callback slot to call when the request is satisfied.
|
|
* @param cancellable Cancellable object.
|
|
* @param io_priority The io priority of the request.
|
|
*/
|
|
void close_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT);
|
|
|
|
/** Requests an asynchronous close of the stream, releasing resources related to it.
|
|
* When the operation is finished the @a slot will be called, giving the results.
|
|
* You can then call close_finish() to get the result of the operation.
|
|
* For behaviour details see close().
|
|
*
|
|
* The asyncronous methods have a default fallback that uses threads to implement asynchronicity,
|
|
* so they are optional for inheriting classes. However, if you override one you must override all.
|
|
*
|
|
* @param slot Callback slot to call when the request is satisfied.
|
|
* @param io_priority The io priority of the request.
|
|
*/
|
|
void close_async(const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT);
|
|
|
|
|
|
/** Closes an output stream.
|
|
* @param result A AsyncResult.
|
|
* @return <tt>true</tt> if stream was successfully closed, <tt>false</tt> otherwise.
|
|
*/
|
|
#ifdef GLIBMM_EXCEPTIONS_ENABLED
|
|
bool close_finish(const Glib::RefPtr<AsyncResult>& result);
|
|
#else
|
|
bool close_finish(const Glib::RefPtr<AsyncResult>& result, std::auto_ptr<Glib::Error>& error);
|
|
#endif //GLIBMM_EXCEPTIONS_ENABLED
|
|
|
|
|
|
// These are private inside the module (for implementations)
|
|
|
|
|
|
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::OutputStream
|
|
*/
|
|
Glib::RefPtr<Gio::OutputStream> wrap(GOutputStream* object, bool take_copy = false);
|
|
}
|
|
|
|
|
|
#endif /* _GIOMM_OUTPUTSTREAM_H */
|
|
|