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

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

GVirStream

Packit Service ea0369

GVirStream

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Functions

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

Properties

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
GVirStreamHandle *
Packit Service ea0369
handle
Packit Service ea0369
Read / Write / Construct Only
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Types and Values

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
enum
Packit Service ea0369
GVirStreamIOCondition
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Object Hierarchy

Packit Service ea0369
    GObject
Packit Service ea0369
    ╰── GIOStream
Packit Service ea0369
        ╰── GVirStream
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Description

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Functions

Packit Service ea0369
Packit Service ea0369

GVirStreamSinkFunc ()

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

Parameters

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

stream

Packit Service ea0369

a GVirStream

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

buf

Packit Service ea0369

data pointer.

Packit Service ea0369
[out][array length=nbytes][transfer none]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

nbytes

Packit Service ea0369

data size

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

user_data

Packit Service ea0369

user data passed to the function

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Returns

Packit Service ea0369

the number of bytes filled, 0 upon end

Packit Service ea0369
of file, or -1 upon error

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Packit Service ea0369
Packit Service ea0369

GVirStreamSourceFunc ()

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

Parameters

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

stream

Packit Service ea0369

a GVirStream

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

buf

Packit Service ea0369

data pointer.

Packit Service ea0369
[out][array length=nbytes][transfer none]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

nbytes

Packit Service ea0369

data size

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

user_data

Packit Service ea0369

user data passed to the function

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Returns

Packit Service ea0369

the number of bytes filled, 0 upon end

Packit Service ea0369
of file, or -1 upon error

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Packit Service ea0369
Packit Service ea0369

GVirStreamIOFunc ()

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

Packit Service ea0369
Packit Service ea0369

gvir_stream_add_watch ()

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

Adds a watch for stream

Packit Service ea0369
 to the mainloop

Packit Service ea0369

[skip]

Packit Service ea0369
Packit Service ea0369

Parameters

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

stream

Packit Service ea0369

the stream

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

cond

Packit Service ea0369

the conditions to watch for (bitfield of GVirStreamIOCondition)

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

func

Packit Service ea0369

the function to call when the condition is satisfied.

Packit Service ea0369
[closure opaque]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

opaque

Packit Service ea0369

user data to pass to func

Packit Service ea0369
. 

Packit Service ea0369
[closure]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Returns

Packit Service ea0369

the event source id

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Packit Service ea0369
Packit Service ea0369

gvir_stream_add_watch_full ()

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

Adds a watch for stream

Packit Service ea0369
 to the mainloop

Packit Service ea0369

[rename-to gvir_stream_add_watch]

Packit Service ea0369
Packit Service ea0369

Parameters

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

stream

Packit Service ea0369

the stream

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

priority

Packit Service ea0369

the priority of the GVirStream source

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

cond

Packit Service ea0369

the conditions to watch for (bitfield of GVirStreamIOCondition)

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

func

Packit Service ea0369

the function to call when the condition is satisfied.

Packit Service ea0369
[closure opaque]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

opaque

Packit Service ea0369

user data to pass to func

Packit Service ea0369
. 

Packit Service ea0369
[closure]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

notify

Packit Service ea0369

the function to call when the source is removed

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Returns

Packit Service ea0369

the event source id

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Packit Service ea0369
Packit Service ea0369

gvir_stream_receive_all ()

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

Receive the entire data stream, sending the data to the

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

Packit Service ea0369
Packit Service ea0369

Parameters

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

stream

Packit Service ea0369

the stream

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

cancellable

Packit Service ea0369

cancellation notifier

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

func

Packit Service ea0369

the callback for writing data to application.

Packit Service ea0369
[scope notified]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

user_data

Packit Service ea0369

data to be passed to callback

Packit Service ea0369
. 

Packit Service ea0369
[closure]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

error

Packit Service ea0369

GError for error reporting, or NULL to ignore.

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Returns

Packit Service ea0369

the number of bytes consumed or -1 upon error

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Packit Service ea0369
Packit Service ea0369

gvir_stream_receive ()

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

Receive data (up to size

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

Packit Service ea0369

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

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

Packit Service ea0369

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

Packit Service ea0369
returned.

Packit Service ea0369
Packit Service ea0369

Parameters

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

stream

Packit Service ea0369

the stream

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

buffer

Packit Service ea0369

a buffer

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

Packit Service ea0369
[array length=size][element-type guint8]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

size

Packit Service ea0369

the number of bytes you want to read from the stream

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

cancellable

Packit Service ea0369

a GCancellable or NULL.

Packit Service ea0369
[allow-none]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

error

Packit Service ea0369

GError for error reporting, or NULL to ignore.

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Returns

Packit Service ea0369

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

Packit Service ea0369
or -1 on error.

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Packit Service ea0369
Packit Service ea0369

gvir_stream_send_all ()

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

Send the entire data stream, sending the data to the

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

Packit Service ea0369
Packit Service ea0369

Parameters

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

stream

Packit Service ea0369

the stream

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

cancellable

Packit Service ea0369

cancellation notifier

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

func

Packit Service ea0369

the callback for writing data to application.

Packit Service ea0369
[scope notified]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

user_data

Packit Service ea0369

data to be passed to callback

Packit Service ea0369
. 

Packit Service ea0369
[closure]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

error

Packit Service ea0369

GError for error reporting, or NULL to ignore.

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Returns

Packit Service ea0369

the number of bytes consumed or -1 upon error

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Packit Service ea0369
Packit Service ea0369

gvir_stream_send ()

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

Send data (up to size

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

Packit Service ea0369

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

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

Packit Service ea0369

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

Packit Service ea0369
returned.

Packit Service ea0369
Packit Service ea0369

Parameters

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

stream

Packit Service ea0369

the stream

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

buffer

Packit Service ea0369

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

Packit Service ea0369
bytes long).

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

size

Packit Service ea0369

the number of bytes you want to write to the stream

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

cancellable

Packit Service ea0369

a GCancellable or NULL.

Packit Service ea0369
[allow-none]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

error

Packit Service ea0369

GError for error reporting, or NULL to ignore.

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Returns

Packit Service ea0369

Number of bytes written.

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Types and Values

Packit Service ea0369
Packit Service ea0369

enum GVirStreamIOCondition

Packit Service ea0369
Packit Service ea0369

Members

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

GVIR_STREAM_IO_CONDITION_READABLE

Packit Service ea0369
 
Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

GVIR_STREAM_IO_CONDITION_WRITABLE

Packit Service ea0369
 
Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

GVIR_STREAM_IO_CONDITION_HANGUP

Packit Service ea0369
 
Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

GVIR_STREAM_IO_CONDITION_ERROR

Packit Service ea0369
 
Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Property Details

Packit Service ea0369
Packit Service ea0369

The “handle” property

Packit Service ea0369
  “handle”                   GVirStreamHandle *
Packit Service ea0369

The stream handle.

Packit Service ea0369

Flags: Read / Write / Construct Only

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

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