glibmm  2.32.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions
Gio::DataOutputStream Class Reference

An implementation of BufferedOutputStream that allows for high-level data manipulation of arbitrary data (including binary operations). More...

#include <giomm/dataoutputstream.h>

Inheritance diagram for Gio::DataOutputStream:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~DataOutputStream ()
GDataOutputStream* gobj ()
 Provides access to the underlying C GObject.
const GDataOutputStream* gobj () const
 Provides access to the underlying C GObject.
GDataOutputStream* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void set_byte_order (DataStreamByteOrder order)
 Sets the byte order of the data output stream to order.
DataStreamByteOrder get_byte_order () const
 Gets the byte order for the stream.
bool put_byte (guchar data, const Glib::RefPtr< Cancellable >& cancellable)
 Puts a byte into the output stream.
bool put_byte (guchar data)
 non-cancellable version of put_byte()
bool put_int16 (gint16 data, const Glib::RefPtr< Cancellable >& cancellable)
 Puts a signed 16-bit integer into the output stream.
bool put_int16 (gint16 data)
 non-cancellable version of put_int16()
bool put_uint16 (guint16 data, const Glib::RefPtr< Cancellable >& cancellable)
 Puts an unsigned 16-bit integer into the output stream.
bool put_uint16 (guint16 data)
 non-cancellable version of put_uint16()
bool put_int32 (gint32 data, const Glib::RefPtr< Cancellable >& cancellable)
 Puts a signed 32-bit integer into the output stream.
bool put_int32 (gint32 data)
 non-cancellable version of put_int32()
bool put_uint32 (guint32 data, const Glib::RefPtr< Cancellable >& cancellable)
 Puts an unsigned 32-bit integer into the stream.
bool put_uint32 (guint32 data)
 non-cancellable version of put_uint32()
bool put_int64 (gint64 data, const Glib::RefPtr< Cancellable >& cancellable)
 Puts a signed 64-bit integer into the stream.
bool put_int64 (gint64 data)
 non-cancellable version of put_int64()
bool put_uint64 (guint64 data, const Glib::RefPtr< Cancellable >& cancellable)
 Puts an unsigned 64-bit integer into the stream.
bool put_uint64 (guint64 data)
 non-cancellable version of put_uint64()
bool put_string (std::string str, const Glib::RefPtr< Cancellable >& cancellable)
 Puts a string into the output stream.
bool put_string (std::string str)
 non-cancellable version of put_string()
Glib::PropertyProxy
< DataStreamByteOrder
property_byte_order ()
 The byte order.
Glib::PropertyProxy_ReadOnly
< DataStreamByteOrder
property_byte_order () const
 The byte order.

Static Public Member Functions

static Glib::RefPtr
< DataOutputStream
create (const Glib::RefPtr< OutputStream >& base_stream)
 Creates a new buffered output stream for a base stream.

Protected Member Functions

 DataOutputStream (const Glib::RefPtr< OutputStream >& base_stream)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr
< Gio::DataOutputStream
wrap (GDataOutputStream* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

An implementation of BufferedOutputStream that allows for high-level data manipulation of arbitrary data (including binary operations).

Since glibmm 2.16:

Constructor & Destructor Documentation

Gio::DataOutputStream::DataOutputStream ( const Glib::RefPtr< OutputStream >&  base_stream) [explicit, protected]

Member Function Documentation

Creates a new buffered output stream for a base stream.

Parameters:
base_streamAn InputStream.
Returns:
an OutputStream for the given base stream.

Reimplemented from Gio::BufferedOutputStream.

Gets the byte order for the stream.

Returns:
The DataStreamByteOrder for the stream.
GDataOutputStream* Gio::DataOutputStream::gobj ( ) [inline]

Provides access to the underlying C GObject.

Reimplemented from Gio::BufferedOutputStream.

const GDataOutputStream* Gio::DataOutputStream::gobj ( ) const [inline]

Provides access to the underlying C GObject.

Reimplemented from Gio::BufferedOutputStream.

GDataOutputStream* Gio::DataOutputStream::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Reimplemented from Gio::BufferedOutputStream.

The byte order.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

The byte order.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
bool Gio::DataOutputStream::put_byte ( guchar  data,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Puts a byte into the output stream.

Parameters:
dataA #guchar.
cancellableOptional Cancellable object, 0 to ignore.
Returns:
true if data was successfully added to the stream.
bool Gio::DataOutputStream::put_byte ( guchar  data)

non-cancellable version of put_byte()

bool Gio::DataOutputStream::put_int16 ( gint16  data,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Puts a signed 16-bit integer into the output stream.

Parameters:
dataA #gint16.
cancellableOptional Cancellable object, 0 to ignore.
Returns:
true if data was successfully added to the stream.
bool Gio::DataOutputStream::put_int16 ( gint16  data)

non-cancellable version of put_int16()

bool Gio::DataOutputStream::put_int32 ( gint32  data,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Puts a signed 32-bit integer into the output stream.

Parameters:
dataA #gint32.
cancellableOptional Cancellable object, 0 to ignore.
Returns:
true if data was successfully added to the stream.
bool Gio::DataOutputStream::put_int32 ( gint32  data)

non-cancellable version of put_int32()

bool Gio::DataOutputStream::put_int64 ( gint64  data,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Puts a signed 64-bit integer into the stream.

Parameters:
dataA #gint64.
cancellableOptional Cancellable object, 0 to ignore.
Returns:
true if data was successfully added to the stream.
bool Gio::DataOutputStream::put_int64 ( gint64  data)

non-cancellable version of put_int64()

bool Gio::DataOutputStream::put_string ( std::string  str,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Puts a string into the output stream.

Parameters:
strA string.
cancellableOptional Cancellable object, 0 to ignore.
Returns:
true if string was successfully added to the stream.

non-cancellable version of put_string()

bool Gio::DataOutputStream::put_uint16 ( guint16  data,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Puts an unsigned 16-bit integer into the output stream.

Parameters:
dataA #guint16.
cancellableOptional Cancellable object, 0 to ignore.
Returns:
true if data was successfully added to the stream.
bool Gio::DataOutputStream::put_uint16 ( guint16  data)

non-cancellable version of put_uint16()

bool Gio::DataOutputStream::put_uint32 ( guint32  data,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Puts an unsigned 32-bit integer into the stream.

Parameters:
dataA #guint32.
cancellableOptional Cancellable object, 0 to ignore.
Returns:
true if data was successfully added to the stream.
bool Gio::DataOutputStream::put_uint32 ( guint32  data)

non-cancellable version of put_uint32()

bool Gio::DataOutputStream::put_uint64 ( guint64  data,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Puts an unsigned 64-bit integer into the stream.

Parameters:
dataA #guint64.
cancellableOptional Cancellable object, 0 to ignore.
Returns:
true if data was successfully added to the stream.
bool Gio::DataOutputStream::put_uint64 ( guint64  data)

non-cancellable version of put_uint64()

Sets the byte order of the data output stream to order.

Parameters:
orderA DataStreamByteOrder.

Friends And Related Function Documentation

Glib::RefPtr< Gio::DataOutputStream > wrap ( GDataOutputStream *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.