Connection

---

Object Hierarchy:

Description:

Content:

Properties:

• public Framebuffer framebuffer { owned get; set; }

Creation methods:

• public Connection ()
  Create a new connection object, which is initially in the disconnected state.

Methods:

• public bool audio_disable ()
  Tell the server that it is no longer permitted to send audio.
• public bool audio_enable ()
  Tell the server that it is permitted to send audio data.
• public bool client_cut_text (void* data, size_t length)
• public bool framebuffer_update_request (bool incremental, uint16 x, uint16 y, uint16 width, uint16 height)
  Request that the server send a framebuffer update when the region positioned at (x, y) wth size (width, height) sees damage.
• public bool get_abs_pointer ()
  Determine if the remote server supports absolute pointer motion events.
• public unowned AudioFormat get_audio_format ()
  Get the current audio format specification
• public unowned Cursor get_cursor ()
  Get the cursor currently associated with the desktop, if any.
• public bool get_ext_key_event ()
  Determine if the remote server supports the extended keyboard event which transmits raw XT scancodes.
• public int get_height ()
  Get the height of the remote display.
• public int get_ledstate ()
  Get the current LED state bitmap.
• public unowned string get_name ()
  Get the name of the remote display.
• public unowned PixelFormat get_pixel_format ()
  Get a specification of the current pixel format
• public bool get_power_control ()
  Determine if the remote server supports power control.
• public bool get_shared ()
  Get the sharing state for the connection
• public int get_width ()
  Get the width of the remote display.
• public bool has_error ()
  Determine if the current connection is in an error state
• public bool is_initialized ()
  Determine if the connection to the remote desktop is fully initialized and thus receiving framebuffer updates.
• public bool is_open ()
  Check if the connection is currently open
• public bool key_event (bool down_flag, uint32 key, uint16 scancode)
  Send a key press/release event to the server.
• public bool open_addr (SocketAddress addr, string? hostname)
  Open a socket connection to server identified by addr.
• public bool open_fd (int fd)
  Open a connection using fd as the transport.
• public bool open_fd_with_hostname (int fd, string? hostname)
  Open a connection using fd as the transport.
• public bool open_host (string host, string port)
  Open a TCP connection to the remote desktop at host listening on port.
• public bool pointer_event (uint8 button_mask, uint16 x, uint16 y)
  Send a pointer event to the server, reflecting either movement of the pointer, or a change in state of its buttons, or both.
• public bool power_control (ConnectionPowerAction action)
  Perform a power control action on the remote server.
• public bool set_audio (Audio audio)
  Set the audio sink to use for playing back audio from the remote session.
• public bool set_audio_format (AudioFormat fmt)
  Set the audio format specification to use for playback from the remote session.
• public bool set_auth_subtype (uint type)
  If a multi-level authentication scheme was requested, this identifies which auth type to use for the second phase.
• public bool set_auth_type (uint type)
  Set the authentication type to use to complete the connection.
• public bool set_credential (int type, string data)
  Sets the value of the authentication credential type to the string data.
• public bool set_encodings (int32[] encoding)
  Inform the server of the list of encodings that it is allowed to send.
• public bool set_framebuffer (Framebuffer fb)
  Set the framebuffer object to which frame buffer updates will be written.
• public bool set_pixel_format (PixelFormat fmt)
  Tell the server what pixel format to use for framebuffer updates.
• public bool set_shared (bool shared)
  Set the shared state for the connection.
• public ConnectionResizeStatus set_size (uint width, uint height)
• public void shutdown ()
  Initiate a shutdown of the current connection by closing its socket

Signals:

• public virtual signal void vnc_auth_choose_subtype (uint type, ValueArray subtypes)
• public virtual signal void vnc_auth_choose_type (ValueArray types)
• public virtual signal void vnc_auth_credential (ValueArray creds)
• public virtual signal void vnc_auth_failure (string reason)
• public virtual signal void vnc_auth_unsupported (uint authType)
• public virtual signal void vnc_bell ()
• public virtual signal void vnc_connected ()
• public virtual signal void vnc_cursor_changed (Cursor? cursor)
  Emitted when the cursor is changed.
• public virtual signal void vnc_desktop_rename (string name)
• public virtual signal void vnc_desktop_resize (int width, int height)
• public virtual signal void vnc_disconnected ()
• public virtual signal void vnc_error (string message)
• public virtual signal void vnc_framebuffer_update (int x, int y, int width, int height)
• public virtual signal void vnc_initialized ()
• public virtual signal void vnc_led_state ()
• public virtual signal void vnc_pixel_format_changed (PixelFormat format)
• public virtual signal void vnc_pointer_mode_changed (bool absPointer)
• public virtual signal void vnc_power_control_failed ()
• public virtual signal void vnc_power_control_initialized ()
• public virtual signal void vnc_server_cut_text (string text)

Inherited Members: