Class

GioTlsInteraction

Description [src]

class Gio.TlsInteraction : GObject.Object {
  /* No available fields */
}

GTlsInteraction provides a mechanism for the TLS connection and database code to interact with the user. It can be used to ask the user for passwords.

To use a GTlsInteraction with a TLS connection use g_tls_connection_set_interaction().

Callers should instantiate a derived class that implements the various interaction methods to show the required dialogs.

Callers should use the ‘invoke’ functions like g_tls_interaction_invoke_ask_password() to run interaction methods. These functions make sure that the interaction is invoked in the main loop and not in the current thread, if the current thread is not running the main loop.

Derived classes can choose to implement whichever interactions methods they’d like to support by overriding those virtual methods in their class initialization function. Any interactions not implemented will return G_TLS_INTERACTION_UNHANDLED. If a derived class implements an async method, it must also implement the corresponding finish method.

Available since:2.30

Hierarchy

hierarchy this GTlsInteraction ancestor_0 GObject ancestor_0--this

Ancestors

Instance methods

g_tls_interaction_ask_password

Run synchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function.

Available since: 2.30

g_tls_interaction_ask_password_async

Run asynchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function.

Available since: 2.30

g_tls_interaction_ask_password_finish

Complete an ask password user interaction request. This should be once the g_tls_interaction_ask_password_async() completion callback is called.

Available since: 2.30

g_tls_interaction_invoke_ask_password

Invoke the interaction to ask the user for a password. It invokes this interaction in the main loop, specifically the GMainContext returned by g_main_context_get_thread_default() when the interaction is created. This is called by called by GTlsConnection or GTlsDatabase to ask the user for a password.

Available since: 2.30

g_tls_interaction_invoke_request_certificate

Invoke the interaction to ask the user to choose a certificate to use with the connection. It invokes this interaction in the main loop, specifically the GMainContext returned by g_main_context_get_thread_default() when the interaction is created. This is called by called by GTlsConnection when the peer requests a certificate during the handshake.

Available since: 2.40

g_tls_interaction_request_certificate

Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function.

Available since: 2.40

g_tls_interaction_request_certificate_async

Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function.

Available since: 2.40

g_tls_interaction_request_certificate_finish

Complete a request certificate user interaction request. This should be once the g_tls_interaction_request_certificate_async() completion callback is called.

Available since: 2.40

Methods inherited from GObject (43)

Signals

Signals inherited from GObject (1)

Class structure

struct GioTlsInteractionClass {
  GTlsInteractionResult (* ask_password) (
    GTlsInteraction* interaction,
    GTlsPassword* password,
    GCancellable* cancellable,
    GError** error
  );
  void (* ask_password_async) (
    GTlsInteraction* interaction,
    GTlsPassword* password,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer user_data
  );
  GTlsInteractionResult (* ask_password_finish) (
    GTlsInteraction* interaction,
    GAsyncResult* result,
    GError** error
  );
  GTlsInteractionResult (* request_certificate) (
    GTlsInteraction* interaction,
    GTlsConnection* connection,
    GTlsCertificateRequestFlags flags,
    GCancellable* cancellable,
    GError** error
  );
  void (* request_certificate_async) (
    GTlsInteraction* interaction,
    GTlsConnection* connection,
    GTlsCertificateRequestFlags flags,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer user_data
  );
  GTlsInteractionResult (* request_certificate_finish) (
    GTlsInteraction* interaction,
    GAsyncResult* result,
    GError** error
  );
  
}
Class members
ask_password
GTlsInteractionResult (* ask_password) (
    GTlsInteraction* interaction,
    GTlsPassword* password,
    GCancellable* cancellable,
    GError** error
  )
  No description available.
ask_password_async
void (* ask_password_async) (
    GTlsInteraction* interaction,
    GTlsPassword* password,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer user_data
  )
  No description available.
ask_password_finish
GTlsInteractionResult (* ask_password_finish) (
    GTlsInteraction* interaction,
    GAsyncResult* result,
    GError** error
  )
  No description available.
request_certificate
GTlsInteractionResult (* request_certificate) (
    GTlsInteraction* interaction,
    GTlsConnection* connection,
    GTlsCertificateRequestFlags flags,
    GCancellable* cancellable,
    GError** error
  )
  No description available.
request_certificate_async
void (* request_certificate_async) (
    GTlsInteraction* interaction,
    GTlsConnection* connection,
    GTlsCertificateRequestFlags flags,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer user_data
  )
  No description available.
request_certificate_finish
GTlsInteractionResult (* request_certificate_finish) (
    GTlsInteraction* interaction,
    GAsyncResult* result,
    GError** error
  )
  No description available.

Virtual methods

Gio.TlsInteractionClass.ask_password

Run synchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function.

Available since: 2.30

Gio.TlsInteractionClass.ask_password_async

Run asynchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function.

Available since: 2.30

Gio.TlsInteractionClass.ask_password_finish

Complete an ask password user interaction request. This should be once the g_tls_interaction_ask_password_async() completion callback is called.

Available since: 2.30

Gio.TlsInteractionClass.request_certificate

Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function.

Available since: 2.40

Gio.TlsInteractionClass.request_certificate_async

Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function.

Available since: 2.40

Gio.TlsInteractionClass.request_certificate_finish

Complete a request certificate user interaction request. This should be once the g_tls_interaction_request_certificate_async() completion callback is called.

Available since: 2.40