gio/org.gtkkn.bindings.gio/UnixInputStream

UnixInputStream

open class UnixInputStream(pointer: <Error class: unknown class><<Error class: unknown class>>) : InputStream, FileDescriptorBased, PollableInputStream

#GUnixInputStream implements #GInputStream for reading from a UNIX file descriptor, including asynchronous operations. (If the file descriptor refers to a socket or pipe, this will use poll() to do asynchronous I/O. If it refers to a regular file, it will fall back to doing asynchronous I/O in another thread.)

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

Constructors

UnixInputStream

constructor(fd: Int, closeFd: Boolean)

Creates a new #GUnixInputStream for the given @fd.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

closeFd

open var closeFd: Boolean

Whether to close the file descriptor when the stream is closed.

open val fd: Int

The file descriptor that the stream reads from.

gioFileDescriptorBasedPointer

open override val gioFileDescriptorBasedPointer: <Error class: unknown class><<Error class: unknown class>>

gioInputStreamPointer

val gioInputStreamPointer: <Error class: unknown class><<Error class: unknown class>>

gioPollableInputStreamPointer

open override val gioPollableInputStreamPointer: <Error class: unknown class><<Error class: unknown class>>

gioUnixInputStreamPointer

val gioUnixInputStreamPointer: <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.

clearPending

open fun clearPending()

Clears the pending flag on @stream.

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

Closes the stream, releasing resources related to it.

closeAsync

open fun closeAsync(ioPriority: Int, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Requests an asynchronous closes of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_input_stream_close_finish() to get the result of the operation.

closeFinish

open fun closeFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes closing a stream asynchronously, started from g_input_stream_close_async().

createSource

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

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

getCloseFd

open fun getCloseFd(): Boolean

Returns whether the file descriptor of @stream will be closed when the stream is closed.

getFd

open fun getFd(): Int

Gets the underlying file descriptor.

getFd_

open fun getFd_(): Int

Return the UNIX file descriptor that the stream reads from.

hasPending

open fun hasPending(): Boolean

Checks if an input stream has pending actions.

isClosed

open fun isClosed(): Boolean

Checks if an input stream is closed.

isReadable

open fun isReadable(): Boolean

Checks if @stream can be read.

readBytes

open fun readBytes(count: <Error class: unknown class>, cancellable: Cancellable? = null): <Error class: unknown class><<Error class: unknown class>>

Like g_input_stream_read(), this tries to read @count bytes from the stream in a blocking fashion. However, rather than reading into a user-supplied buffer, this will create a new #GBytes containing the data that was read. This may be easier to use from language bindings.

readBytesAsync

open fun readBytesAsync(count: <Error class: unknown class>, ioPriority: Int, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Request an asynchronous read of @count bytes from the stream into a new #GBytes. When the operation is finished @callback will be called. You can then call g_input_stream_read_bytes_finish() to get the result of the operation.

readBytesFinish

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

Finishes an asynchronous stream read-into-#GBytes operation.

readFinish

open fun readFinish(result: AsyncResult): <Error class: unknown class><Long>

Finishes an asynchronous stream read operation.

setCloseFd

open fun setCloseFd(closeFd: Boolean)

Sets whether the file descriptor of @stream shall be closed when the stream is closed.

setPending

open fun setPending(): <Error class: unknown class><Boolean>

Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return false and set

skip

open fun skip(count: <Error class: unknown class>, cancellable: Cancellable? = null): <Error class: unknown class><Long>

Tries to skip @count bytes from the stream. Will block during the operation.

skipAsync

open fun skipAsync(count: <Error class: unknown class>, ioPriority: Int, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Request an asynchronous skip of @count bytes from the stream. When the operation is finished @callback will be called. You can then call g_input_stream_skip_finish() to get the result of the operation.

skipFinish

open fun skipFinish(result: AsyncResult): <Error class: unknown class><Long>

Finishes a stream skip operation.