gio/org.gtkkn.bindings.gio/UnixConnection

UnixConnection

open class UnixConnection(pointer: <Error class: unknown class><<Error class: unknown class>>) : SocketConnection

This is the subclass of class@Gio.SocketConnection that is created for UNIX domain sockets.

It contains functions to do some of the UNIX socket specific functionality like passing file descriptors.

Since GLib 2.72, GUnixConnection is available on all platforms. It requires underlying system support (such as Windows 10 with AF_UNIX) at run time.

Before GLib 2.72, <gio/gunixconnection.h> belonged to the UNIX-specific GIO interfaces, thus you had to use the gio-unix-2.0.pc pkg-config file when using it. This is no longer necessary since GLib 2.72.

Since

2.22

Constructors

UnixConnection

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

Types

Companion

object Companion

Properties

gioIOStreamPointer

val gioIOStreamPointer: <Error class: unknown class><<Error class: unknown class>>

gioSocketConnectionPointer

val gioSocketConnectionPointer: <Error class: unknown class><<Error class: unknown class>>

gioUnixConnectionPointer

val gioUnixConnectionPointer: <Error class: unknown class><<Error class: unknown class>>

inputStream

open val inputStream: InputStream

The class@Gio.InputStream to read from.

outputStream

open val outputStream: OutputStream

The class@Gio.OutputStream to write to.

socket

open val socket: Socket

The underlying class@Gio.Socket.

Functions

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. This will also close the individual input and output streams, if they are not already closed.

closeAsync

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

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

closeFinish

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

Closes a stream.

connect

open fun connect(address: SocketAddress, cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Connect @connection to the specified remote address.

connectAsync

open fun connectAsync(address: SocketAddress, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Asynchronously connect @connection to the specified remote address.

connectFinish

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

Gets the result of a g_socket_connection_connect_async() call.

getInputStream

open fun getInputStream(): InputStream

Gets the input stream for this object. This is used for reading.

getLocalAddress

open fun getLocalAddress(): <Error class: unknown class><SocketAddress>

Try to get the local address of a socket connection.

getOutputStream

open fun getOutputStream(): OutputStream

Gets the output stream for this object. This is used for writing.

getRemoteAddress

open fun getRemoteAddress(): <Error class: unknown class><SocketAddress>

Try to get the remote address of a socket connection.

getSocket

open fun getSocket(): Socket

Gets the underlying #GSocket object of the connection. This can be useful if you want to do something unusual on it not supported by the #GSocketConnection APIs.

hasPending

open fun hasPending(): Boolean

Checks if a stream has pending actions.

isClosed

open fun isClosed(): Boolean

Checks if a stream is closed.

isConnected

open fun isConnected(): Boolean

Checks if @connection is connected. This is equivalent to calling g_socket_is_connected() on @connection's underlying #GSocket.

receiveCredentials

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

Receives credentials from the sending end of the connection. The sending end has to call g_unix_connection_send_credentials() (or similar) for this to work.

receiveCredentialsAsync

open fun receiveCredentialsAsync(cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Asynchronously receive credentials.

receiveCredentialsFinish

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

Finishes an asynchronous receive credentials operation started with g_unix_connection_receive_credentials_async().

receiveFd

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

Receives a file descriptor from the sending end of the connection. The sending end has to call g_unix_connection_send_fd() for this to work.

sendCredentials

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

Passes the credentials of the current user the receiving side of the connection. The receiving end has to call g_unix_connection_receive_credentials() (or similar) to accept the credentials.

sendCredentialsAsync

open fun sendCredentialsAsync(cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Asynchronously send credentials.

sendCredentialsFinish

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

Finishes an asynchronous send credentials operation started with g_unix_connection_send_credentials_async().

sendFd

open fun sendFd(fd: Int, cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Passes a file descriptor to the receiving side of the connection. The receiving end has to call g_unix_connection_receive_fd() to accept the file descriptor.

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

spliceAsync

open fun spliceAsync(stream2: IOStream, flags: IOStreamSpliceFlags, ioPriority: Int, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Asynchronously splice the output stream of @stream1 to the input stream of