gio/org.gtkkn.bindings.gio/FileDescriptorBased

FileDescriptorBased

interface FileDescriptorBased : Proxy(source)

GFileDescriptorBased is an interface for file descriptor based IO.

It is implemented by streams (implementations of class@Gio.InputStream or class@Gio.OutputStream) that are based on file descriptors.

Note that <gio/gfiledescriptorbased.h> belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file or the GioUnix-2.0 GIR namespace when using it.

Since

2.24

Inheritors

FileDescriptorBasedImpl

UnixInputStream

UnixOutputStream

Types

Companion

object Companion

FileDescriptorBasedImpl

class FileDescriptorBasedImpl(gioFileDescriptorBasedPointer: <Error class: unknown class><<Error class: unknown class>>) : FileDescriptorBased

The FileDescriptorBasedImpl type represents a native instance of the FileDescriptorBased interface.

Properties

gioFileDescriptorBasedPointer

abstract val gioFileDescriptorBasedPointer: <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().

getFd

open fun getFd(): <Error class: unknown class>

Gets the underlying file descriptor.

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().