gio/org.gtkkn.bindings.gio/PollableInputStream

PollableInputStream

interface PollableInputStream : Proxy(source)

GPollableInputStream is implemented by class@Gio.InputStreams that can be polled for readiness to read. This can be used when interfacing with a non-GIO API that expects UNIX-file-descriptor-style asynchronous I/O rather than GIO-style.

Some classes may implement GPollableInputStream but have only certain instances of that class be pollable. If method@Gio.PollableInputStream.can_poll returns false, then the behavior of other GPollableInputStream methods is undefined.

Skipped during bindings generation

parameter buffer: buffer: Out parameter is not supported

Since

2.28

Inheritors

ConverterInputStream

MemoryInputStream

PollableInputStreamImpl

UnixInputStream

Types

Companion

object Companion

PollableInputStreamImpl

class PollableInputStreamImpl( gioPollableInputStreamPointer: <Error class: unknown class><<Error class: unknown class>>) : InputStream, PollableInputStream

The PollableInputStreamImpl type represents a native instance of the PollableInputStream interface.

Properties

gioPollableInputStreamPointer

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

gioProxyPointer

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

Functions

canPoll

open fun canPoll(): Boolean

Checks if @stream is actually pollable. Some classes may implement #GPollableInputStream but have only certain instances of that class be pollable. If this method returns false, then the behavior of other #GPollableInputStream methods is undefined.

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

createSource

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

Creates a #GSource that triggers when @stream can be read, or

isReadable

open fun isReadable(): Boolean

Checks if @stream can be read.

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