Blame docs/libvirt-gobject/html/GVirStream.html

Packit a07778
Packit a07778
<html>
Packit a07778
<head>
Packit a07778
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit a07778
<title>GVirStream: Libvirt-gobject Reference Manual</title>
Packit a07778
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit a07778
<link rel="home" href="index.html" title="Libvirt-gobject Reference Manual">
Packit a07778
<link rel="up" href="ch01.html" title="Libvirt-gobject">
Packit a07778
<link rel="prev" href="GVirStorageVol.html" title="GVirStorageVol">
Packit a07778
<link rel="next" href="object-tree.html" title="Object Hierarchy">
Packit a07778
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
Packit a07778
<link rel="stylesheet" href="style.css" type="text/css">
Packit a07778
</head>
Packit a07778
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit a07778
Packit a07778
Packit a07778
Top  | 
Packit a07778
                  Description  | 
Packit a07778
                  Object Hierarchy  | 
Packit a07778
                  Properties
Packit a07778
Packit a07778
Home
Packit a07778
Up
Packit a07778
Prev
Packit a07778
Next
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

GVirStream

Packit a07778

GVirStream

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Functions

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gint
Packit a07778
Packit a07778
Packit a07778
(*GVirStreamSinkFunc) ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gint
Packit a07778
Packit a07778
Packit a07778
(*GVirStreamSourceFunc) ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gboolean
Packit a07778
Packit a07778
Packit a07778
(*GVirStreamIOFunc) ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
guint
Packit a07778
Packit a07778
Packit a07778
gvir_stream_add_watch ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
guint
Packit a07778
Packit a07778
Packit a07778
gvir_stream_add_watch_full ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gssize
Packit a07778
Packit a07778
Packit a07778
gvir_stream_receive_all ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gssize
Packit a07778
Packit a07778
Packit a07778
gvir_stream_receive ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gssize
Packit a07778
Packit a07778
Packit a07778
gvir_stream_send_all ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gssize
Packit a07778
Packit a07778
Packit a07778
gvir_stream_send ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Properties

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
GVirStreamHandle *
Packit a07778
handle
Packit a07778
Read / Write / Construct Only
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Types and Values

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
enum
Packit a07778
GVirStreamIOCondition
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Object Hierarchy

Packit a07778
    GObject
Packit a07778
    ╰── GIOStream
Packit a07778
        ╰── GVirStream
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Description

Packit a07778
Packit a07778
Packit a07778

Functions

Packit a07778
Packit a07778

GVirStreamSinkFunc ()

Packit a07778
gint
Packit a07778
(*GVirStreamSinkFunc) (GVirStream *stream,
Packit a07778
                       const gchar *buf,
Packit a07778
                       gsize nbytes,
Packit a07778
                       gpointer user_data);
Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

stream

Packit a07778

a GVirStream

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

buf

Packit a07778

data pointer.

Packit a07778
[out][array length=nbytes][transfer none]
Packit a07778
Packit a07778
Packit a07778

nbytes

Packit a07778

data size

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

user_data

Packit a07778

user data passed to the function

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

the number of bytes filled, 0 upon end

Packit a07778
of file, or -1 upon error

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

GVirStreamSourceFunc ()

Packit a07778
gint
Packit a07778
(*GVirStreamSourceFunc) (GVirStream *stream,
Packit a07778
                         gchar *buf,
Packit a07778
                         gsize nbytes,
Packit a07778
                         gpointer user_data);
Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

stream

Packit a07778

a GVirStream

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

buf

Packit a07778

data pointer.

Packit a07778
[out][array length=nbytes][transfer none]
Packit a07778
Packit a07778
Packit a07778

nbytes

Packit a07778

data size

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

user_data

Packit a07778

user data passed to the function

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

the number of bytes filled, 0 upon end

Packit a07778
of file, or -1 upon error

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

GVirStreamIOFunc ()

Packit a07778
gboolean
Packit a07778
(*GVirStreamIOFunc) (GVirStream *stream,
Packit a07778
                     GVirStreamIOCondition cond,
Packit a07778
                     gpointer opaque);
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_stream_add_watch ()

Packit a07778
guint
Packit a07778
gvir_stream_add_watch (GVirStream *stream,
Packit a07778
                       GVirStreamIOCondition cond,
Packit a07778
                       GVirStreamIOFunc func,
Packit a07778
                       gpointer opaque);
Packit a07778

Adds a watch for stream

Packit a07778
 to the mainloop

Packit a07778

[skip]

Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

stream

Packit a07778

the stream

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

cond

Packit a07778

the conditions to watch for (bitfield of GVirStreamIOCondition)

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

func

Packit a07778

the function to call when the condition is satisfied.

Packit a07778
[closure opaque]
Packit a07778
Packit a07778
Packit a07778

opaque

Packit a07778

user data to pass to func

Packit a07778
. 

Packit a07778
[closure]
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

the event source id

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_stream_add_watch_full ()

Packit a07778
guint
Packit a07778
gvir_stream_add_watch_full (GVirStream *stream,
Packit a07778
                            gint priority,
Packit a07778
                            GVirStreamIOCondition cond,
Packit a07778
                            GVirStreamIOFunc func,
Packit a07778
                            gpointer opaque,
Packit a07778
                            GDestroyNotify notify);
Packit a07778

Adds a watch for stream

Packit a07778
 to the mainloop

Packit a07778

[rename-to gvir_stream_add_watch]

Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

stream

Packit a07778

the stream

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

priority

Packit a07778

the priority of the GVirStream source

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

cond

Packit a07778

the conditions to watch for (bitfield of GVirStreamIOCondition)

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

func

Packit a07778

the function to call when the condition is satisfied.

Packit a07778
[closure opaque]
Packit a07778
Packit a07778
Packit a07778

opaque

Packit a07778

user data to pass to func

Packit a07778
. 

Packit a07778
[closure]
Packit a07778
Packit a07778
Packit a07778

notify

Packit a07778

the function to call when the source is removed

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

the event source id

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_stream_receive_all ()

Packit a07778
gssize
Packit a07778
gvir_stream_receive_all (GVirStream *stream,
Packit a07778
                         GCancellable *cancellable,
Packit a07778
                         GVirStreamSinkFunc func,
Packit a07778
                         gpointer user_data,
Packit a07778
                         GError **error);
Packit a07778

Receive the entire data stream, sending the data to the

Packit a07778
requested data sink. This is simply a convenient alternative
Packit a07778
to virStreamRecv, for apps that do blocking-I/o.

Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

stream

Packit a07778

the stream

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

cancellable

Packit a07778

cancellation notifier

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

func

Packit a07778

the callback for writing data to application.

Packit a07778
[scope notified]
Packit a07778
Packit a07778
Packit a07778

user_data

Packit a07778

data to be passed to callback

Packit a07778
. 

Packit a07778
[closure]
Packit a07778
Packit a07778
Packit a07778

error

Packit a07778

GError for error reporting, or NULL to ignore.

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

the number of bytes consumed or -1 upon error

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_stream_receive ()

Packit a07778
gssize
Packit a07778
gvir_stream_receive (GVirStream *stream,
Packit a07778
                     gchar *buffer,
Packit a07778
                     gsize size,
Packit a07778
                     GCancellable *cancellable,
Packit a07778
                     GError **error);
Packit a07778

Receive data (up to size

Packit a07778
 bytes) from a stream.
Packit a07778
On error -1 is returned and error
Packit a07778
 is set accordingly.

Packit a07778

gvir_stream_receive() can return any number of bytes, up to

Packit a07778
size
Packit a07778
. If more than size
Packit a07778
 bytes have been received, the additional
Packit a07778
data will be returned in future calls to gvir_stream_receive().

Packit a07778

If there is no data available, a G_IO_ERROR_WOULD_BLOCK error will be

Packit a07778
returned.

Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

stream

Packit a07778

the stream

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

buffer

Packit a07778

a buffer

Packit a07778
to read data into (which should be at least size
Packit a07778
bytes long). 

Packit a07778
[array length=size][element-type guint8]
Packit a07778
Packit a07778
Packit a07778

size

Packit a07778

the number of bytes you want to read from the stream

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

cancellable

Packit a07778

a GCancellable or NULL.

Packit a07778
[allow-none]
Packit a07778
Packit a07778
Packit a07778

error

Packit a07778

GError for error reporting, or NULL to ignore.

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

Number of bytes read, or 0 if the end of stream reached,

Packit a07778
or -1 on error.

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_stream_send_all ()

Packit a07778
gssize
Packit a07778
gvir_stream_send_all (GVirStream *stream,
Packit a07778
                      GCancellable *cancellable,
Packit a07778
                      GVirStreamSourceFunc func,
Packit a07778
                      gpointer user_data,
Packit a07778
                      GError **error);
Packit a07778

Send the entire data stream, sending the data to the

Packit a07778
requested data source. This is simply a convenient alternative
Packit a07778
to virStreamRecv, for apps that do blocking-I/o.

Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

stream

Packit a07778

the stream

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

cancellable

Packit a07778

cancellation notifier

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

func

Packit a07778

the callback for writing data to application.

Packit a07778
[scope notified]
Packit a07778
Packit a07778
Packit a07778

user_data

Packit a07778

data to be passed to callback

Packit a07778
. 

Packit a07778
[closure]
Packit a07778
Packit a07778
Packit a07778

error

Packit a07778

GError for error reporting, or NULL to ignore.

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

the number of bytes consumed or -1 upon error

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_stream_send ()

Packit a07778
gssize
Packit a07778
gvir_stream_send (GVirStream *stream,
Packit a07778
                  const gchar *buffer,
Packit a07778
                  gsize size,
Packit a07778
                  GCancellable *cancellable,
Packit a07778
                  GError **error);
Packit a07778

Send data (up to size

Packit a07778
 bytes) from a stream.
Packit a07778
On error -1 is returned and error
Packit a07778
 is set accordingly.

Packit a07778

gvir_stream_send() can return any number of bytes, up to

Packit a07778
size
Packit a07778
. If more than size
Packit a07778
 bytes have been sendd, the additional
Packit a07778
data will be returned in future calls to gvir_stream_send().

Packit a07778

If there is no data available, a G_IO_ERROR_WOULD_BLOCK error will be

Packit a07778
returned.

Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

stream

Packit a07778

the stream

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

buffer

Packit a07778

a buffer to write data from (which should be at least size

Packit a07778
bytes long).

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

size

Packit a07778

the number of bytes you want to write to the stream

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

cancellable

Packit a07778

a GCancellable or NULL.

Packit a07778
[allow-none]
Packit a07778
Packit a07778
Packit a07778

error

Packit a07778

GError for error reporting, or NULL to ignore.

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

Number of bytes written.

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Types and Values

Packit a07778
Packit a07778

enum GVirStreamIOCondition

Packit a07778
Packit a07778

Members

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

GVIR_STREAM_IO_CONDITION_READABLE

Packit a07778
 
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

GVIR_STREAM_IO_CONDITION_WRITABLE

Packit a07778
 
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

GVIR_STREAM_IO_CONDITION_HANGUP

Packit a07778
 
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

GVIR_STREAM_IO_CONDITION_ERROR

Packit a07778
 
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Property Details

Packit a07778
Packit a07778

The “handle” property

Packit a07778
  “handle”                   GVirStreamHandle *
Packit a07778

The stream handle.

Packit a07778

Flags: Read / Write / Construct Only

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Generated by GTK-Doc V1.29
Packit a07778
</body>
Packit a07778
</html>