gio/org.gtkkn.bindings.gio/UnixSocketAddress

UnixSocketAddress

open class UnixSocketAddress( val gioUnixSocketAddressPointer: <Error class: unknown class><<Error class: unknown class>>) : SocketAddress(source)

Support for UNIX-domain (also known as local) sockets, corresponding to struct sockaddr_un.

UNIX domain sockets are generally visible in the filesystem. However, some systems support abstract socket names which are not visible in the filesystem and not affected by the filesystem permissions, visibility, etc. Currently this is only supported under Linux. If you attempt to use abstract sockets on other systems, function calls may return G_IO_ERROR_NOT_SUPPORTED errors. You can use func@Gio.UnixSocketAddress.abstract_names_supported to see if abstract names are supported.

Since GLib 2.72, GUnixSocketAddress 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/gunixsocketaddress.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.

Skipped during bindings generation

method abstract: Property has no getter nor setter
method path-as-array: Property has no getter nor setter
parameter path: Array parameter of type gchar is not supported
parameter path: Array parameter of type gchar is not supported

Constructors

UnixSocketAddress

constructor(path: String)

Creates a new #GUnixSocketAddress for @path.

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

Types

Companion

object Companion

Properties

addressType

open val addressType: UnixSocketAddressType

The type of Unix socket address.

family

open val family: SocketFamily

The family of the socket address.

gioProxyPointer

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

gioSocketAddressPointer

val gioSocketAddressPointer: <Error class: unknown class><<Error class: unknown class>>

gioSocketConnectablePointer

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

gioUnixSocketAddressPointer

val gioUnixSocketAddressPointer: <Error class: unknown class><<Error class: unknown class>>

path

open val path: String

Unix socket path.

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

enumerate

open fun enumerate(): SocketAddressEnumerator

Creates a #GSocketAddressEnumerator for @connectable.

getIsAbstract

open fun getIsAbstract(): Boolean

This is deprecated.

getNativeSize

open fun getNativeSize(): Long

Gets the size of @address's native struct sockaddr. You can use this to allocate memory to pass to g_socket_address_to_native().

getPathLen

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

Gets the length of @address's path.

proxyEnumerate

open fun proxyEnumerate(): SocketAddressEnumerator

Creates a #GSocketAddressEnumerator for @connectable that will return a #GProxyAddress for each of its addresses that you must connect to via a proxy.

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

toNative

open fun toNative(dest: <Error class: unknown class>? = null, destlen: <Error class: unknown class>): <Error class: unknown class><Boolean>

Converts a #GSocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind().

toStringSocketConnectable

open fun toStringSocketConnectable(): String

Format a #GSocketConnectable as a string. This is a human-readable format for use in debugging output, and is not a stable serialization format. It is not suitable for use in user interfaces as it exposes too much information for a user.