data class MethodVTableItem(val name: MethodName, var inputSignature: Signature? = null, var inputParamNames: List<String> = emptyList(), var outputSignature: Signature? = null, var outputParamNames: List<String> = emptyList(), var callbackHandler: MethodCallback? = null, val flags: Flags = Flags()) : TypedMethodBuilderContext, VTableItem

MutablePropertyDelegate

class MutablePropertyDelegate<R, T : Any>(proxy: Proxy, interfaceName: InterfaceName, propertyName: PropertyName, serializer: KSerializer<T>, module: SerializersModule, signature: SdbusSig) : PropertyDelegate<R, T> , ReadWriteProperty<R, T>

Object

interface Object : Resource

Object class represents a D-Bus object instance identified by a specific object path. D-Bus object provides its interfaces, methods, signals and properties on a bus identified by a specific bus name.

ObjectManagerProxy

class ObjectManagerProxy(val proxy: Proxy)

Proxy for the ObjectManager interface, allows access to flows containing combinations of objects, their interfaces, and their properties.

ObjectPath

@Serializable(with = ObjectPath.Companion::class)

value class ObjectPath(val value: String)

PeerProxy

interface PeerProxy : ProxyHolder

PendingAsyncCall

expect class PendingAsyncCall : Resource

PendingAsyncCall represents a simple handle type to cancel the delivery of the asynchronous D-Bus call result to the application.

actual class PendingAsyncCall : Resource

PlainMessage

expect class PlainMessage : Message

Represents any of the message types, or just a message that serves as a container for data

actual class PlainMessage : Message

PrimitiveSig

data class PrimitiveSig<K, N : CVariable> : SdbusSig

PropertiesProxy

interface PropertiesProxy : ProxyHolder

PropertyDelegate

open class PropertyDelegate<R, T : Any>(proxy: Proxy, val interfaceName: InterfaceName, val propertyName: PropertyName, type: KSerializer<T>, module: SerializersModule, signature: SdbusSig) : ReadOnlyProperty<R, T>

PropertyGetCallback

typealias PropertyGetCallback = (msg: PropertyGetReply) -> Unit

PropertyGetReply

expect class PropertyGetReply : Message

actual class PropertyGetReply : Message

PropertyName

typealias PropertyName = MemberName

PropertySetCall

expect class PropertySetCall : Message

actual class PropertySetCall : Message

PropertySetCallback

typealias PropertySetCallback = (msg: PropertySetCall) -> Unit

PropertyVTableItem

data class PropertyVTableItem(val name: PropertyName, var signature: Signature? = null, var getter: PropertyGetCallback? = null, var setter: PropertySetCallback? = null, val flags: Flags = Flags()) : VTableItem

Proxy

interface Proxy : Resource

ProxyHolder

interface ProxyHolder

Resource

interface Resource

A handle to resource that may be manually released.

SdbusSig

expect sealed class SdbusSig

actual sealed class SdbusSig

ServiceConnection

class ServiceConnection(val connection: Connection, val serviceName: ServiceName)

A Simple wrapper around a connection that avoids repeating the service name when creating proxies.

ServiceName

typealias ServiceName = BusName

Signal

expect class Signal : Message

actual class Signal : Message

SignalEmitter

data class SignalEmitter(var interfaceName: InterfaceName = InterfaceName(""), var signalName: SignalName = SignalName(""), var typedMethodArguments: TypedArguments? = null) : TypedArgumentsBuilderContext

SignalHandler

typealias SignalHandler = (signal: Signal) -> Unit

SignalName

typealias SignalName = MemberName

SignalSubscriber

class SignalSubscriber : TypedMethodBuilderContext

SignalVTableItem

data class SignalVTableItem(val name: SignalName, var signature: Signature = Signature(""), var paramNames: List<String> = emptyList(), val flags: Flags = Flags()) : VTableItem

Signature

@Serializable(with = Signature.Companion::class)

value class Signature(val value: String)

Strong type representing the D-Bus object path

StructSig

data class StructSig(val signatures: List<SdbusSig>) : SdbusSig

Typed

data class Typed<T : Any>

A reference to a type that can be serialized within a d-bus message.

TypedArguments

data class TypedArguments

A reference to a method argument types and their values that can be serialized within a d-bus message.

TypedArgumentsBuilder

typealias TypedArgumentsBuilder = TypedArgumentsBuilderContext.() -> TypedArguments

TypedArgumentsBuilderContext

open class TypedArgumentsBuilderContext

This is a builder context allowing for easy construction of a TypedArguments.

TypedMethodBuilderContext

open class TypedMethodBuilderContext

This is a builder context allowing for easy construction of a TypedMethodCall.

TypedMethodCall

sealed class TypedMethodCall<T : TypedMethodCall<T>>

The definition of a reference to a callback/method invocation.

UnixFd

expect class UnixFd(fd: Int, adoptFd: Unit) : Resource

UnixFd is a representation of file descriptor D-Bus type that owns the underlying fd, provides access to it, and closes the fd when the UnixFd goes out of scope.

@Serializable(with = UnixFd.Companion::class)

actual class UnixFd(val fd: Int, adoptFd: Unit) : Resource

Variant

@Serializable(with = Variant.Companion::class)

class Variant

VTableBuilder

value class VTableBuilder(val items: MutableList<VTableItem>)

VTableItem

sealed interface VTableItem

Properties

asSignature

val SerialDescriptor.asSignature: SdbusSig

BoolSig

expect val BoolSig: SdbusSig

actual val BoolSig: SdbusSig

DBUS_PROPERTIES_INTERFACE_NAME

val DBUS_PROPERTIES_INTERFACE_NAME: InterfaceName

DoubleSig

expect val DoubleSig: SdbusSig

actual val DoubleSig: SdbusSig

IntSig

expect val IntSig: SdbusSig

actual val IntSig: SdbusSig

LongSig

expect val LongSig: SdbusSig

actual val LongSig: SdbusSig

ObjectPathSig

expect val ObjectPathSig: SdbusSig

actual val ObjectPathSig: SdbusSig

ShortSig

expect val ShortSig: SdbusSig

actual val ShortSig: SdbusSig

SignatureSig

expect val SignatureSig: SdbusSig

actual val SignatureSig: SdbusSig

StringSig

expect val StringSig: SdbusSig

actual val StringSig: SdbusSig

UByteSig

expect val UByteSig: SdbusSig

actual val UByteSig: SdbusSig

UIntSig

expect val UIntSig: SdbusSig

actual val UIntSig: SdbusSig

ULongSig

expect val ULongSig: SdbusSig

actual val ULongSig: SdbusSig

UnixFdSig

expect val UnixFdSig: SdbusSig

actual val UnixFdSig: SdbusSig

UShortSig

expect val UShortSig: SdbusSig

actual val UShortSig: SdbusSig

VariantSig

expect val VariantSig: SdbusSig

actual val VariantSig: SdbusSig

VoidSig

expect val VoidSig: SdbusSig

actual val VoidSig: SdbusSig

Functions

addVTable

inline fun Object.addVTable(interfaceName: InterfaceName, builder: VTableBuilder.() -> Unit): Resource

Adds a declaration of methods, properties and signals of the object at a given interface

buildArgs

inline fun buildArgs(builder: TypedArgumentsBuilder): TypedArguments

callMethod

inline fun Proxy.callMethod(message: MethodCall, timeout: Duration): MethodReply

inline fun <R : Any> Proxy.callMethod(interfaceName: InterfaceName, methodName: MethodName, builder: MethodInvoker.() -> Unit): R

Calls method on the D-Bus object

callMethodAsync

inline suspend fun Proxy.callMethodAsync(message: MethodCall, timeout: Duration): MethodReply

inline fun Proxy.callMethodAsync(message: MethodCall, noinline asyncReplyCallback: AsyncReplyHandler, timeout: Duration): PendingAsyncCall

inline suspend fun <R : Any> Proxy.callMethodAsync(interfaceName: InterfaceName, methodName: MethodName, builder: MethodInvoker.() -> Unit): R

Calls method on the D-Bus object asynchronously

containsValueOfType

inline fun <T> Variant.containsValueOfType(): Boolean

createBusConnection

expect fun createBusConnection(): Connection

Creates/opens D-Bus session bus connection when in a user context, and a system bus connection, otherwise.

expect fun createBusConnection(name: ServiceName): Connection

Creates/opens D-Bus session bus connection with a name when in a user context, and a system bus connection with a name, otherwise.

actual fun createBusConnection(): Connection

actual fun createBusConnection(name: ServiceName): Connection

createDirectBusConnection

expect fun createDirectBusConnection(fd: Int): Connection

Opens direct D-Bus connection at the given file descriptor

expect fun createDirectBusConnection(address: String): Connection

Opens direct D-Bus connection at a custom address

actual fun createDirectBusConnection(fd: Int): Connection

actual fun createDirectBusConnection(address: String): Connection

createError

expect fun createError(errNo: Int, customMsg: String): Error

actual fun createError(errNo: Int, customMsg: String): Error

createObject

expect fun createObject(connection: Connection, objectPath: ObjectPath): Object

Creates instance representing a D-Bus object

actual fun createObject(connection: Connection, objectPath: ObjectPath): Object

createProxy

expect fun createProxy(destination: ServiceName, objectPath: ObjectPath, dontRunEventLoopThread: Boolean = false): Proxy

expect fun createProxy(connection: Connection, destination: ServiceName, objectPath: ObjectPath, dontRunEventLoopThread: Boolean = false): Proxy

Creates a proxy object for a specific remote D-Bus object

actual fun createProxy(destination: ServiceName, objectPath: ObjectPath, dontRunEventLoopThread: Boolean): Proxy

actual fun createProxy(connection: Connection, destination: ServiceName, objectPath: ObjectPath, dontRunEventLoopThread: Boolean): Proxy

createRemoteSystemBusConnection

expect fun createRemoteSystemBusConnection(host: String): Connection

Creates/opens D-Bus system connection on a remote host using ssh

actual fun createRemoteSystemBusConnection(host: String): Connection

createServerBus

expect fun createServerBus(fd: Int): Connection

Opens direct D-Bus connection at fd as a server

actual fun createServerBus(fd: Int): Connection

createSessionBusConnection

expect fun createSessionBusConnection(): Connection

Creates/opens D-Bus session bus connection

expect fun createSessionBusConnection(name: ServiceName): Connection

Creates/opens D-Bus session bus connection with a name

actual fun createSessionBusConnection(): Connection

actual fun createSessionBusConnection(name: ServiceName): Connection

createSessionBusConnectionWithAddress

expect fun createSessionBusConnectionWithAddress(address: String): Connection

Creates/opens D-Bus session bus connection at a custom address

actual fun createSessionBusConnectionWithAddress(address: String): Connection

createSystemBusConnection

expect fun createSystemBusConnection(): Connection

Creates/opens D-Bus system bus connection

expect fun createSystemBusConnection(name: ServiceName): Connection

Creates/opens D-Bus system bus connection with a name

actual fun createSystemBusConnection(): Connection

actual fun createSystemBusConnection(name: ServiceName): Connection

deserialize

actual fun <T : Any> Message.deserialize(serializer: DeserializationStrategy<T>, module: SerializersModule): T

emit

fun Object.emit(signal: SignalEmitter)

emitSignal

inline fun Object.emitSignal(interfaceName: InterfaceName = InterfaceName(""), signalName: SignalName = SignalName(""), builder: SignalEmitter.() -> Unit)

Emits signal on D-Bus

getAllProperties

inline fun Proxy.getAllProperties(): AllPropertiesGetter

Gets values of all properties of the D-Bus object

getAllPropertiesAsync

inline fun Proxy.getAllPropertiesAsync(): AsyncAllPropertiesGetter

Gets values of all properties of the D-Bus object asynchronously

getProperty

inline fun <T : Any> Proxy.getProperty(interfaceName: InterfaceName, propertyName: PropertyName): T

Gets value of a property of the D-Bus object

getPropertyAsync

inline fun Proxy.getPropertyAsync(propertyName: PropertyName): AsyncPropertyGetter

Gets value of a property of the D-Bus object asynchronously

interfaceFlags

inline fun VTableBuilder.interfaceFlags(builder: InterfaceFlagsVTableItem.() -> Unit)

maybeDegrouped

fun Signature.maybeDegrouped(groupedReturn: Boolean): Signature

fun <T> KSerializer<T>.maybeDegrouped(groupedReturn: Boolean): KSerializer<T>

Since we combine multiple output arguments into a single struct for methods, we need to modify their serialization to not expect a struct to be wrapping them, degrouping does that wrapping a trickery to avoid it.

method

fun VTableBuilder.method(methodName: MethodName, builder: MethodVTableItem.() -> Unit)

Builds a method to be added to the vtable in progress.

mutableDelegate

inline fun <R, T : Any> Proxy.mutableDelegate(interfaceName: InterfaceName, propertyName: PropertyName): MutablePropertyDelegate<R, T>

onSignal

inline fun Proxy.onSignal(interfaceName: InterfaceName, signalName: SignalName, builder: SignalSubscriber.() -> Unit): Resource

Registers signal handler for a given signal of the D-Bus object

PeerProxy

fun PeerProxy(proxy: Proxy): PeerProxy

prop

inline fun <R, T : Any> Proxy.prop(interfaceName: InterfaceName, propertyName: PropertyName): ReadWriteProperty<R, T>

inline fun VTableBuilder.prop(propertyName: PropertyName, builder: PropertyVTableItem.() -> Unit)

propDelegate

inline fun <R, T : Any> Proxy.propDelegate(interfaceName: InterfaceName, propertyName: PropertyName): PropertyDelegate<R, T>

PropertiesProxy

fun PropertiesProxy(proxy: Proxy): PropertiesProxy

registerProperty

fun registerProperty(propertyName: PropertyName): PropertyVTableItem

serialize

actual fun <T> Message.serialize(serializer: SerializationStrategy<T>, module: SerializersModule, arg: T)

setProperty

inline fun <T : Any> Proxy.setProperty(interfaceName: InterfaceName, propertyName: PropertyName, value: T, dontExpectReply: Boolean = false)

setPropertyAsync

inline fun Proxy.setPropertyAsync(propertyName: PropertyName): AsyncPropertySetter

Sets value of a property of the D-Bus object asynchronously

signal

inline fun VTableBuilder.signal(signal: SignalName, builder: SignalVTableItem.() -> Unit)

Builds a signal into the given vtable builder.

signalFlow

inline fun <T> Proxy.signalFlow(interfaceName: InterfaceName, signalName: SignalName, builder: SignalSubscriber.() -> Unit): Flow<T>

signatureOf

inline fun <T> signatureOf(): SdbusSig

fun signatureOf(type: KType): SdbusSig

Variant

inline fun <T : Any> Variant(value: T): Variant

withService

fun Connection.withService(serviceName: ServiceName): ServiceConnection

Convenient way to unify setup of destination.