platform_framework_api_ipc_binder/com.tomtom.ivi.platform.framework.api.ipc.binder

Package com.tomtom.ivi.platform.framework.api.ipc.binder

This module contains internal utilities related to Android's binder IPC mechanism.

Types

AggregatableBinderInterface

interface AggregatableBinderInterface<T>

Interface for binder interfaces that can be aggregated as part of other binder interfaces.

AsyncCapableBinderInterface

interface AsyncCapableBinderInterface : IInterface

Base interface for IBinder interfaces that require async replies.

AsyncReplyProvider

typealias AsyncReplyProvider = suspend () -> AsyncReplyWriter

Lambda prototype that can provide a reply through the returned AsyncReplyWriter.

AsyncReplyReceiver

interface AsyncReplyReceiver : OneWayBinderInterface

Receives replies asynchronously over an IBinder interface.

AsyncReplyWriter

typealias AsyncReplyWriter = (Parcel) -> Unit

A lambda that writes a reply to a the given Parcel.

data class AsyncRequestId(val id: Int) : RegistrationToken

Identifies an async request.

class BinderContext( lifecycleOwner: LifecycleOwner, val messageDispatchFailureListener: BinderMessageDispatchFailureListener, val syncBinderTransactionScope: CoroutineScope? = null)

Groups some properties that are needed in the binder interface implementations.

BinderMessageDispatchFailureListener

fun interface BinderMessageDispatchFailureListener

Called when dispatching a binder transaction resulted in an Exception.

KillableLifecycleOwner

class KillableLifecycleOwner(parentLifecycleOwner: LifecycleOwner, mainScopeProvider: MainScopeProvider) : LifecycleOwner

LifecycleOwner which is destroyed when it catches a DeadObjectException.

MainScopeProvider

typealias MainScopeProvider = (() -> Unit) -> Unit

OneWayBinderInterface

interface OneWayBinderInterface : IInterface

Interface for binder interfaces that can use one way transaction.

RegistrationToken

abstract class RegistrationToken(val id: Int) : Parcelable

Base class for registration token.

RegistrationTokenMap

class RegistrationTokenMap<T : RegistrationToken, V>(tokenFactory: (Int) -> T)

Utility class to generate unique tokens of type T and associate a value of type V to this token. Tokens are created by using the tokenFactory.

RemoteCancellationException

class RemoteCancellationException : CancellationException

Thrown when remote's BinderContext.mainCoroutineScope is cancelled while an async reply is pending.

SequencedAction

typealias SequencedAction = () -> Unit

SequencerReceiverHelper

class SequencerReceiverHelper

Helper class for the receiving side on one way binder transactions.

SequencerSenderHelper

class SequencerSenderHelper

The counter part of the SequencerReceiverHelper on the sender side.

Functions

withMessageDispatchFailureListener

inline fun <R> BinderMessageDispatchFailureListener.withMessageDispatchFailureListener( interfaceDescriptor: String, transactionName: String, block: () -> R): R

Calls BinderMessageDispatchFailureListener.onFailure when block throws an Exception. Any caught exception is rethrown.