spice_channel_new ()

SpiceChannel *
spice_channel_new (SpiceSession *s,
                   int type,
                   int id);

Create a new SpiceChannel of type type , and channel ID id .

spice_channel_destroy ()

void
spice_channel_destroy (SpiceChannel *channel);

Disconnect and unref the channel .

spice_channel_connect ()

gboolean
spice_channel_connect (SpiceChannel *channel);

Connect the channel, using SpiceSession connection informations

spice_channel_open_fd ()

gboolean
spice_channel_open_fd (SpiceChannel *channel,
                       int fd);

Connect the channel using fd socket.

If fd is -1, a valid fd will be requested later via the SpiceChannel::open-fd signal.

spice_channel_disconnect ()

void
spice_channel_disconnect (SpiceChannel *channel,
                          SpiceChannelEvent reason);

Close the socket and reset connection specific data. Finally, emit reason “channel-event” on main context if not SPICE_CHANNEL_NONE.

spice_channel_test_capability ()

gboolean
spice_channel_test_capability (SpiceChannel *channel,
                               guint32 cap);

Test availability of remote "channel kind capability".

spice_channel_test_common_capability ()

gboolean
spice_channel_test_common_capability (SpiceChannel *channel,
                                      guint32 cap);

Test availability of remote "common channel capability".

spice_channel_type_to_string ()

const gchar *
spice_channel_type_to_string (gint type);

Convert a channel-type property value to a string.

Since: 0.20

spice_channel_string_to_type ()

gint
spice_channel_string_to_type (const gchar *str);

Convert a channel-type property value to a string.

Since: 0.21

spice_channel_set_capability ()

void
spice_channel_set_capability (SpiceChannel *channel,
                              guint32 cap);

Enable specific channel-kind capability.

spice_channel_flush_async ()

void
spice_channel_flush_async (SpiceChannel *channel,
                           GCancellable *cancellable,
                           GAsyncReadyCallback callback,
                           gpointer user_data);

Forces an asynchronous write of all user-space buffered data for the given channel.

When the operation is finished callback will be called. You can then call spice_channel_flush_finish() to get the result of the operation.

Since: 0.15

spice_channel_flush_finish ()

gboolean
spice_channel_flush_finish (SpiceChannel *channel,
                            GAsyncResult *result,
                            GError **error);

Finishes flushing a channel.

Since: 0.15

spice_channel_get_error ()

const GError *
spice_channel_get_error (SpiceChannel *channel);

Retrieves the GError currently set on channel, if the SpiceChannel is in error state and can provide additional error details.

Since: 0.24

enum SpiceChannelEvent

An event, emitted by “channel-event” signal.

SpiceChannel

typedef struct _SpiceChannel SpiceChannel;

The SpiceChannel struct is opaque and should not be accessed directly.

SpiceChannelClass

typedef struct {
    GObjectClass parent_class;

    /* signals, main context */
    void (*channel_event)(SpiceChannel *channel, SpiceChannelEvent event);
    void (*open_fd)(SpiceChannel *channel, int with_tls);
} SpiceChannelClass;

Class structure for SpiceChannel.

The “channel-id” property

  “channel-id”               gint

Channel ID.

Flags: Read / Write / Construct Only

Allowed values: >= -1

Default value: -1

The “channel-type” property

  “channel-type”             gint

Channel type.

Flags: Read / Write / Construct Only

Allowed values: >= -1

Default value: -1

The “socket” property

  “socket”                   GSocket *

Get the underlying GSocket. Note that you should not read or write any data to it directly since this will likely corrupt the channel stream. This property is mainly useful to get some connections details.

Flags: Read

Since: 0.33

The “spice-session” property

  “spice-session”            SpiceSession *

Spice session.

Flags: Read / Write / Construct Only

The “total-read-bytes” property

  “total-read-bytes”         gulong

Total read bytes.

Flags: Read

The “channel-event” signal

void
user_function (SpiceChannel     *channel,
               SpiceChannelEvent event,
               gpointer          user_data)

The “channel-event” signal is emitted when the state of the connection is changed. In case of errors, spice_channel_get_error() may provide additional informations on the source of the error.

Flags: Run First

The “open-fd” signal

void
user_function (SpiceChannel *channel,
               gint          with_tls,
               gpointer      user_data)

The “open-fd” signal is emitted when a new connection is requested. This signal is emitted when the connection is made with spice_session_open_fd().

Flags: Run First