Proxy

interface Proxy : Resource

Properties

connection

abstract val connection: Connection

Provides D-Bus connection used by the proxy

currentlyProcessedMessage

abstract val currentlyProcessedMessage: Message

Provides access to the currently processed D-Bus message

objectPath

abstract val objectPath: ObjectPath

Returns object path of the underlying DBus object

Functions

callMethod

abstract fun callMethod(message: MethodCall): MethodReply

abstract fun callMethod(message: MethodCall, timeout: ULong): MethodReply

Calls method on the remote D-Bus object

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

abstract suspend fun callMethodAsync(message: MethodCall): MethodReply

abstract fun callMethodAsync(message: MethodCall, asyncReplyCallback: AsyncReplyHandler): PendingAsyncCall

Calls method on the D-Bus object asynchronously

abstract suspend fun callMethodAsync(message: MethodCall, timeout: ULong): MethodReply

abstract fun callMethodAsync(message: MethodCall, asyncReplyCallback: AsyncReplyHandler, timeout: ULong): PendingAsyncCall

Calls method on the D-Bus object asynchronously, with custom timeout

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

createMethodCall

abstract fun createMethodCall(interfaceName: InterfaceName, methodName: MethodName): MethodCall

Creates a method call message

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

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

prop

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

propDelegate

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

registerSignalHandler

abstract fun registerSignalHandler(interfaceName: InterfaceName, signalName: SignalName, signalHandler: SignalHandler): Resource

Registers a handler for the desired signal emitted by the D-Bus object

release

abstract fun release()

Releases this resource and any child resources it may have.

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

signalFlow

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