TlsInteraction

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.

Constructors

this
this(GTlsInteraction* gTlsInteraction, bool ownedRef = false)

Sets our main struct and passes it to the parent class.

Members

Functions

askPassword
GTlsInteractionResult askPassword(TlsPassword password, Cancellable cancellable)

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.

askPasswordAsync
void askPasswordAsync(TlsPassword password, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

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.

askPasswordFinish
GTlsInteractionResult askPasswordFinish(AsyncResultIF result)

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

getStruct
void* getStruct()

the main Gtk struct as a void*

getTlsInteractionStruct
GTlsInteraction* getTlsInteractionStruct(bool transferOwnership = false)

Get the main Gtk struct

invokeAskPassword
GTlsInteractionResult invokeAskPassword(TlsPassword password, Cancellable cancellable)

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.

invokeRequestCertificate
GTlsInteractionResult invokeRequestCertificate(TlsConnection connection, GTlsCertificateRequestFlags flags, Cancellable cancellable)

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.

requestCertificate
GTlsInteractionResult requestCertificate(TlsConnection connection, GTlsCertificateRequestFlags flags, Cancellable cancellable)

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.

requestCertificateAsync
void requestCertificateAsync(TlsConnection connection, GTlsCertificateRequestFlags flags, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

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.

requestCertificateFinish
GTlsInteractionResult requestCertificateFinish(AsyncResultIF result)

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

Static functions

getType
GType getType()

Variables

gTlsInteraction
GTlsInteraction* gTlsInteraction;

the main Gtk struct

Meta

Since

2.30