gio/org.gtkkn.bindings.gio/Initable

Initable

GInitable is implemented by objects that can fail during initialization. If an object implements this interface then it must be initialized as the first thing after construction, either via method@Gio.Initable.init or method@Gio.AsyncInitable.init_async (the latter is only available if it also implements iface@Gio.AsyncInitable).

If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with func@GLib.critical or func@GLib.warning, but this must not be relied on.

Users of objects implementing this are not intended to use the interface method directly, instead it will be used automatically in various ways. For C applications you generally just call func@Gio.Initable.new directly, or indirectly via a foo_thing_new() wrapper. This will call method@Gio.Initable.init under the cover, returning NULL and setting a GError on failure (at which point the instance is unreferenced).

For bindings in languages where the native constructor supports exceptions the binding could check for objects implementing GInitable during normal construction and automatically initialize them, throwing an exception on failure.

Skipped during bindings generation

function new: Varargs parameter is not supported
parameter var_args: va_list type is not supported
parameter parameters: Array parameter of type GObject.Parameter is not supported

Since

2.22

Inheritors

CharsetConverter

DBusConnection

DBusObjectManagerClient

Types

Companion

object Companion

InitableImpl

class InitableImpl(gioInitablePointer: <Error class: unknown class><<Error class: unknown class>>) : Initable

The InitableImpl type represents a native instance of the Initable interface.

Properties

gioInitablePointer

abstract val gioInitablePointer: <Error class: unknown class><<Error class: unknown class>>

gioProxyPointer

abstract val gioProxyPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

connect

open fun connect(connection: IoStream, proxyAddress: ProxyAddress, cancellable: Cancellable? = null): <Error class: unknown class><IoStream>

Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload.

connectAsync

open fun connectAsync(connection: IoStream, proxyAddress: ProxyAddress, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Asynchronous version of g_proxy_connect().

connectFinish

open fun connectFinish(result: AsyncResult): <Error class: unknown class><IoStream>

See g_proxy_connect().

init

open fun init(cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Initializes the object implementing the interface.

supportsHostname

open fun supportsHostname(): Boolean

Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return false if @proxy is implementing such a protocol. When false is returned, the caller should resolve the destination hostname first, and then pass a #GProxyAddress containing the stringified IP address to g_proxy_connect() or g_proxy_connect_async().