Top | ![]() |
![]() |
![]() |
![]() |
SpiceSession * | spice_session_new () |
gboolean | spice_session_connect () |
gboolean | spice_session_open_fd () |
void | spice_session_disconnect () |
GList * | spice_session_get_channels () |
gboolean | spice_session_get_read_only () |
gboolean | spice_session_has_channel_type () |
SpiceURI * | spice_session_get_proxy_uri () |
GOptionGroup * | spice_get_option_group () |
void | spice_set_session_option () |
GQuark | spice_client_error_quark () |
GByteArray * | ca | Read / Write |
gchar * | ca-file | Read / Write |
gint | cache-size | Read / Write |
gchar * | cert-subject | Read / Write |
gchar * | ciphers | Read / Write |
gboolean | client-sockets | Read / Write |
gint | color-depth | Read / Write |
GStrv | disable-effects | Read / Write |
gboolean | enable-audio | Read / Write / Construct |
gboolean | enable-smartcard | Read / Write |
gboolean | enable-usbredir | Read / Write / Construct |
gint | glz-window-size | Read / Write |
gchar * | host | Read / Write / Construct |
gboolean | inhibit-keyboard-grab | Read / Write |
SpiceSessionMigration | migration-state | Read |
gchar * | name | Read |
gchar * | password | Read / Write |
gchar * | port | Read / Write |
gint | protocol | Read / Write / Construct |
gchar * | proxy | Read / Write |
GByteArray * | pubkey | Read / Write |
gboolean | read-only | Read / Write / Construct |
GStrv | secure-channels | Read / Write |
gchar * | shared-dir | Read / Write / Construct |
GStrv | smartcard-certificates | Read / Write |
gchar * | smartcard-db | Read / Write |
gchar * | tls-port | Read / Write |
gchar * | uri | Read / Write |
gpointer | uuid | Read |
SpiceSessionVerify | verify | Read / Write / Construct |
SpiceSession | |
SpiceSessionClass | |
enum | SpiceSessionMigration |
enum | SpiceSessionVerify |
enum | SpiceClientError |
#define | SPICE_CLIENT_ERROR |
GEnum ╰── SpiceSessionMigration GFlags ╰── SpiceSessionVerify GObject ╰── SpiceSession
The SpiceSession class handles all the SpiceChannel connections. It's also the class that contains connections informations, such as “host” and “port”.
You can simply set the property “uri” to something like "spice://127.0.0.1?port=5930" to configure your connection details.
You may want to connect to “channel-new” signal, to be informed of the availability of channels and to interact with them.
For example, when the SpiceInputsChannel is available and get the
event SPICE_CHANNEL_OPENED, you can send key events with
spice_inputs_key_press()
. When the SpiceMainChannel is available,
you can start sharing the clipboard... .
Once SpiceSession properties set, you can call
spice_session_connect()
to start connecting and communicating with
a Spice server.
gboolean spice_session_open_fd (SpiceSession *session
,int fd
);
Open the session using the provided fd
socket file
descriptor. This is useful if you create the fd yourself, for
example to setup a SSH tunnel.
If fd
is -1, a valid fd will be requested later via the
SpiceChannel::open-fd signal.
void
spice_session_disconnect (SpiceSession *session
);
Disconnect the session
, and destroy all channels.
GList *
spice_session_get_channels (SpiceSession *session
);
Get the list of current channels associated with this session
.
gboolean spice_session_has_channel_type (SpiceSession *session
,gint type
);
See if there is a type
channel in the channels associated with this
session
.
SpiceURI *
spice_session_get_proxy_uri (SpiceSession *session
);
Since 0.24
GOptionGroup *
spice_get_option_group (void
);
a GOptionGroup for the commandline
arguments specific to Spice. You have to call
spice_set_session_option()
after to set the options on a
SpiceSession.
[transfer full]
void
spice_set_session_option (SpiceSession *session
);
Set various properties on session
, according to the commandline
arguments given to spice_get_option_group()
option group.
typedef struct { GObjectClass parent_class; /* signals */ void (*channel_new)(SpiceSession *session, SpiceChannel *channel); void (*channel_destroy)(SpiceSession *session, SpiceChannel *channel); } SpiceSessionClass;
“ca”
property “ca” GByteArray *
CA certificates in PEM format. The text data can contain several CA certificates identified by:
-----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE-----
Flags: Read / Write
Since 0.15
“ca-file”
property “ca-file” gchar *
File holding the CA certificates for the host the client is connecting to
Flags: Read / Write
Default value: NULL
“cache-size”
property “cache-size” gint
Images cache size. If 0, don't set.
Flags: Read / Write
Allowed values: >= 0
Default value: 0
Since 0.9
“cert-subject”
property “cert-subject” gchar *
Certificate subject to check.
Flags: Read / Write
Default value: NULL
“client-sockets”
property “client-sockets” gboolean
Sockets are provided by the client.
Flags: Read / Write
Default value: FALSE
“color-depth”
property “color-depth” gint
Display color depth to set on new display channels. If 0, don't set.
Flags: Read / Write
Allowed values: [0,32]
Default value: 0
Since 0.7
“disable-effects”
property “disable-effects” GStrv
A string array of effects to disable. The settings will be applied on new display channels. The following effets can be disabled "wallpaper", "font-smooth", "animation", and "all", which will disable all the effects. If NULL, don't apply changes.
Flags: Read / Write
Since 0.7
“enable-audio”
property “enable-audio” gboolean
If set to TRUE, the audio channels will be enabled for playback and recording.
Flags: Read / Write / Construct
Default value: TRUE
Since 0.8
“enable-smartcard”
property “enable-smartcard” gboolean
If set to TRUE, the smartcard channel will be enabled and smartcard events will be forwarded to the guest
Flags: Read / Write
Default value: FALSE
Since 0.7
“enable-usbredir”
property “enable-usbredir” gboolean
If set to TRUE, the usbredir channel will be enabled and USB devices can be redirected to the guest
Flags: Read / Write / Construct
Default value: TRUE
Since 0.8
“glz-window-size”
property “glz-window-size” gint
Glz window size. If 0, don't set.
Flags: Read / Write
Allowed values: [0,134217728]
Default value: 0
Since 0.9
“host”
property “host” gchar *
URL of the SPICE host to connect to
Flags: Read / Write / Construct
Default value: "localhost"
“inhibit-keyboard-grab”
property “inhibit-keyboard-grab” gboolean
Request that SpiceDisplays don't grab the keyboard.
Flags: Read / Write
Default value: FALSE
“migration-state”
property“migration-state” SpiceSessionMigration
SpiceSessionMigration bit field indicating if a migration is in progress
Flags: Read
Default value: SPICE_SESSION_MIGRATION_NONE
“password”
property “password” gchar *
TLS password to use
Flags: Read / Write
Default value: NULL
“port”
property “port” gchar *
Port to connect to for unencrypted sessions
Flags: Read / Write
Default value: NULL
“protocol”
property “protocol” gint
Version of the SPICE protocol to use
Flags: Read / Write / Construct
Allowed values: [1,2]
Default value: 2
“proxy”
property “proxy” gchar *
URI to the proxy server to use when doing network connection. of the form [protocol://]<host>[:port]
Flags: Read / Write
Default value: NULL
Since 0.17
“read-only”
property “read-only” gboolean
Whether this connection is read-only mode.
Flags: Read / Write / Construct
Default value: FALSE
Since 0.8
“secure-channels”
property “secure-channels” GStrv
A string array of channel types to be secured.
Flags: Read / Write
Since 0.20
“shared-dir”
property “shared-dir” gchar *
Location of the shared directory
Flags: Read / Write / Construct
Default value: NULL
Since 0.24
“smartcard-certificates”
property “smartcard-certificates” GStrv
This property is used when one wants to simulate a smartcard with no
hardware smartcard reader. If it's set to a NULL-terminated string
array containing the names of 3 valid certificates, these will be
used to simulate a smartcard in the guest
See also spice_smartcard_manager_insert_card()
Flags: Read / Write
Since 0.7
“smartcard-db”
property “smartcard-db” gchar *
Path to the NSS certificate database containing the certificates to use to simulate a software smartcard
Flags: Read / Write
Default value: NULL
Since 0.7
“tls-port”
property “tls-port” gchar *
Port to connect to for TLS sessions
Flags: Read / Write
Default value: NULL
“uri”
property “uri” gchar *
URI of the SPICE host to connect to. The URI is of the form spice://hostname?port=XXX or spice://hostname?tls_port=XXX
Flags: Read / Write
Default value: NULL
“verify”
property“verify” SpiceSessionVerify
SpiceSessionVerify bit field indicating which parts of the peer certificate should be checked
Flags: Read / Write / Construct
Default value: SPICE_SESSION_VERIFY_HOSTNAME
“channel-destroy”
signalvoid user_function (SpiceSession *session, SpiceChannel *channel, gpointer user_data)
The “channel-destroy” signal is emitted each time a SpiceChannel is destroyed.
session |
the session that emitted the signal |
|
channel |
the destroyed SpiceChannel |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“channel-new”
signalvoid user_function (SpiceSession *session, SpiceChannel *channel, gpointer user_data)
The “channel-new” signal is emitted each time a SpiceChannel is created.
session |
the session that emitted the signal |
|
channel |
the new SpiceChannel |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
“mm-time-reset”
signalvoid user_function (SpiceSession *session, gpointer user_data)
The “mm-time-reset” is emitted when we identify discontinuity in mm-time
Since 0.20
session |
the session that emitted the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First