Session

---

Object Hierarchy:

Description:

Content:

Properties:

• public ByteArray ca { owned get; set; }
  CA certificates in PEM format.
• public string ca_file { owned get; set; }
  File holding the CA certificates for the host the client is connecting to
• public int cache_size { get; set; }
  Images cache size.
• public string cert_subject { owned get; set; }
• public string ciphers { owned get; set; }
• public bool client_sockets { get; set; }
• public int color_depth { get; set; }
  Display color depth to set on new display channels.
• public string[] disable_effects { owned get; set; }
  A string array of effects to disable.
• public bool enable_audio { get; set construct; }
  If set to TRUE, the audio channels will be enabled for playback and recording.
• public bool enable_smartcard { get; set; }
  If set to TRUE, the smartcard channel will be enabled and smartcard events will be forwarded to the guest
• public bool enable_usbredir { get; set construct; }
  If set to TRUE, the usbredir channel will be enabled and USB devices can be redirected to the guest
• public bool gl_scanout { get; set construct; }
  Whether to enable gl-scanout (Unix only).
• public int glz_window_size { get; set; }
  Glz window size.
• public string host { owned get; set construct; }
  URL of the SPICE host to connect to
• public bool inhibit_keyboard_grab { get; set; }
• public SessionMigration migration_state { get; }
  SessionMigration bit field indicating if a migration is in progress
• public string name { owned get; }
  Spice server name.
• public string password { owned get; set; }
  TLS password to use
• public string port { owned get; set; }
  Port to connect to for unencrypted sessions
• public int protocol { get; set construct; }
  Version of the SPICE protocol to use
• public string proxy { owned get; set; }
  URI to the proxy server to use when doing network connection.
• public ByteArray pubkey { owned get; set; }
• public bool read_only { get; set construct; }
  Whether this connection is read-only mode.
• public string[] secure_channels { owned get; set; }
  A string array of channel types to be secured.
• public bool share_dir_ro { get; set construct; }
  Whether to share the directory read-only.
• public string shared_dir { owned get; set construct; }
  Location of the shared directory
• public string[] smartcard_certificates { owned get; set; }
  This property is used when one wants to simulate a smartcard with no hardware smartcard reader.
• public string smartcard_db { owned get; set; }
  Path to the NSS certificate database containing the certificates to use to simulate a software smartcard
• public string tls_port { owned get; set; }
  Port to connect to for TLS sessions
• public string unix_path { owned get; set construct; }
  Path of the Unix socket to connect to
• public string uri { owned get; set; }
  URI of the SPICE host to connect to.
• public string username { owned get; set; }
  Username to use
• public void* uuid { get; }
  Spice server uuid.
• public SessionVerify verify { get; set construct; }
  SessionVerify bit field indicating which parts of the peer certificate should be checked

Creation methods:

• public Session ()
  Creates a new Spice session.

Methods:

• public bool connect ()
  Open the session using the host and port.
• public void disconnect ()
  Disconnect the this, and destroy all channels.
• public List<unowned Channel> get_channels ()
  Get the list of current channels associated with this this.
• public unowned URI get_proxy_uri ()
  Gets the this proxy uri.
• public bool get_read_only ()
  Checks whether the this is read-only.
• public bool has_channel_type (int type)
  See if there is a type channel in the channels associated with this this.
• public bool is_for_migration ()
  During seamless migration, channels may be created to establish a connection with the target, but they are temporary and should only handle migration steps.
• public bool open_fd (int fd)
  Open the session using the provided fd socket file descriptor.

Signals:

• public virtual signal void channel_destroy (Channel channel)
  The channel_destroy signal is emitted each time a Channel is destroyed.
• public virtual signal void channel_new (Channel channel)
  The channel_new signal is emitted each time a Channel is created.
• public signal void disconnected ()
  The disconnected signal is emitted when all channels have been destroyed.
• public signal void mm_time_reset ()
  The mm_time_reset is emitted when we identify discontinuity in mm-time

Inherited Members: