Channel

---

Object Hierarchy:

Description:

Content:

Properties:

• public int channel_id { get; construct; }
• public int channel_type { get; construct; }
• public Socket socket { owned get; }
  Get the underlying Socket .
• public Session spice_session { owned get; construct; }
• public ulong total_read_bytes { get; }

Static methods:

• public static int string_to_type (string str)
  Convert a channel-type property value to a string.
• public static unowned string type_to_string (int type)
  Convert a channel-type property value to a string.

Creation methods:

• public Channel (Session s, int type, int id)
  Create a new Channel of type type, and channel ID id.

Methods:

• public virtual void channel_reset (bool migrating)
• public virtual void channel_send_migration_handshake ()
• public virtual void channel_up ()
• public bool connect ()
  Connect the channel, using Session connection informations
• public void destroy ()
  Disconnect and unref the this.
• public void disconnect (ChannelEvent reason)
  Close the socket and reset connection specific data.
• public async bool flush_async (Cancellable? cancellable) throws Error
  Forces an asynchronous write of all user-space buffered data for the given channel.
• public unowned Error get_error ()
  Retrieves the Error currently set on channel, if the Channel is in error state and can provide additional error details.
• public virtual void handle_msg (MsgIn msg)
• public virtual void iterate_read ()
• public virtual void iterate_write ()
• public void set_capability (uint32 cap)
  Enable specific channel-kind capability.
• public bool test_capability (uint32 cap)
  Test availability of remote "channel kind capability".
• public bool test_common_capability (uint32 cap)
  Test availability of remote "common channel capability".

Signals:

• public virtual signal void channel_event (ChannelEvent event)
  The channel_event signal is emitted when the state of the connection is changed.
• public virtual signal void open_fd (int with_tls)
  The open_fd signal is emitted when a new connection is requested.

Inherited Members: