platform_framework_api_ipc_iviservice/com.tomtom.ivi.platform.framework.api.ipc.iviservice.internal

Package-level declarations

General internal API of TomTom Digital Cockpit's IPC framework.

Note: The API provided by this package is not guaranteed to be backward compatible. Do not import anything from this package.

Types

AnyIviServiceConnectionManagerImpl

typealias AnyIviServiceConnectionManagerImpl = IviServiceConnectionManagerImpl<*, *, *, *, *>

AnyIviServiceConnectionManagerRegistrationInfo

typealias AnyIviServiceConnectionManagerRegistrationInfo = IviServiceConnectionManagerRegistrationInfo<*, *, *, *, *>

AnyIviServiceInterfaceRegistration

typealias AnyIviServiceInterfaceRegistration = IviServiceInterfaceRegistration<*, *, *, *, *>

ConnectionFactory

typealias ConnectionFactory<D, C> = (D) -> C

enum ConnectionType : Enum<ConnectionType>

Connection types.

InvalidIviServiceGenerationIdException

class InvalidIviServiceGenerationIdException : Exception

IviAndroidServiceBinderInterface

interface IviAndroidServiceBinderInterface : IInterface

Generic Binder interface for any IVI service host.

IviServiceBinderConnectionBase

abstract class IviServiceBinderConnectionBase<B : IviServiceBinderInterface, P, PO : IviServicePropertiesObserver>(connectionData: IviServiceBinderConnectionData) : IviServiceConnectionBase<P, PO>

Base class for <Interface>BinderConnection classes.

IviServiceBinderConnectionData

class IviServiceBinderConnectionData(val serviceId: IviServiceId, val connectionScope: CoroutineScope, val syncBinderTransactionScope: CoroutineScope, acquireAndReleaseInterface: IviServiceBinderConnectionData.AcquireAndReleaseInterface, val ipcMessageDispatchFailureListener: IpcMessageDispatchFailureListener) : IviServiceConnectionData

Data to construct the IviServiceBinderConnectionBase class.

IviServiceBinderInterface

interface IviServiceBinderInterface : IInterface

Binder interface of an IVI service.

IviServiceConnectionBase

abstract class IviServiceConnectionBase<P, PO : IviServicePropertiesObserver>(connectionData: IviServiceConnectionData) : IviServiceConnection<P, PO> , LifecycleOwner

Base class for any <Interface>Connection interface implementation.

IviServiceConnectionData

abstract class IviServiceConnectionData(val serviceId: IviServiceId, val connectionScope: CoroutineScope)

Data required to construct a IviServiceConnectionBase class.

IviServiceConnectionManagerContext

data class IviServiceConnectionManagerContext(val lifecycleOwner: LifecycleOwner)

Information about the environment that an IviServiceConnectionManager runs in.

IviServiceConnectionManagerImpl

class IviServiceConnectionManagerImpl<C : IviServiceConnection<P, PO>, D : IviServiceConnectionData, P : Any, PO : IviServicePropertiesObserver, LP : IviServiceLiveDataPropertiesBase<P, PO>> : IviServiceConnectionManagerRegistrationInfo<C, D, P, PO, LP> , IviServiceConnectionManager<C, LP>

The IVI service connection managers.

IviServiceConnectionManagerRegistrationInfo

interface IviServiceConnectionManagerRegistrationInfo<C : IviServiceConnection<P, PO>, D : IviServiceConnectionData, P : Any, PO : IviServicePropertiesObserver, LP : IviServiceLiveDataPropertiesBase<P, PO>>

The registration info of an IVI service connection manager.

IviServiceDirectConnectionBase

abstract class IviServiceDirectConnectionBase<S : IviServiceBase<P, PO>, P : Any, PO : IviServicePropertiesObserver>(connectionData: IviServiceDirectConnectionData<S>) : IviServiceConnectionBase<P, PO>

Base class for <Interface>DirectConnection classes.

IviServiceDirectConnectionData

class IviServiceDirectConnectionData<T>(val serviceId: IviServiceId, val connectionScope: CoroutineScope, serviceProvider: () -> T) : IviServiceConnectionData

Data to construct the IviServiceDirectConnectionBase class.

IviServiceHostManagerBase

abstract class IviServiceHostManagerBase(val serviceHostId: IviServiceHostId, serviceConnectionManagers: Collection<AnyIviServiceConnectionManagerImpl>) : LifecycleOwner

Base class for IVI service host managers.

IviServiceHostManagerBuilder

interface IviServiceHostManagerBuilder

Implementations construct a IviServiceHostManagerBase instance.

IviServiceHostManagerFactory

interface IviServiceHostManagerFactory

Interface for creating IVI service host managers.

IviServiceInterfaceRegistration

class IviServiceInterfaceRegistration<C : IviServiceConnection<P, PO>, D : IviServiceConnectionData, P : Any, PO : IviServicePropertiesObserver, LP : IviServiceLiveDataPropertiesBase<P, PO>>

Represents an IVI service interface registration entry.

IviServiceInterfaceRegistrationWrapper

data class IviServiceInterfaceRegistrationWrapper @IviInternal constructor(val serviceInterfaceRegistration: AnyIviServiceInterfaceRegistration)

A reference to an IVI service interface registration data.

IviServiceLifecycleListenerBinderInterface

interface IviServiceLifecycleListenerBinderInterface : Observer<Lifecycle.State> , IInterface

Extends Observer as an IBinder interface.

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class IviServiceMock(val functionsInterface: KClass<*>)

The generated <Interface>Mock classes are annotated with this annotation to inform the test framework about the class that needs to be mocked for mocking the functions of the IVI service.

IviServiceNonNullMirrorableMapPropertyDelegate

class IviServiceNonNullMirrorableMapPropertyDelegate<K, V>(lifecycleOwner: LifecycleOwner, listener: MirrorableMapListenerForwarder<K, V>, observer: ChangeHandler<MirrorableMap<K, V>>) : IviServiceNonNullPropertyDelegateBase<MirrorableMap<K, V>>

Property delegate for non-null IVI service MirrorableMap properties.

IviServiceNonNullPropertyDelegate

class IviServiceNonNullPropertyDelegate<T : Any>(observer: ChangeHandler<T>) : IviServiceNonNullPropertyDelegateBase<T>

Property delegate for non-null IVI service properties, except MirrorableMap.

IviServiceNonNullPropertyDelegateBase

abstract class IviServiceNonNullPropertyDelegateBase<T : Any>(observer: ChangeHandler<T>) : IviServicePropertyDelegate<T>

The base class for non-null IVI service property delegate. Have the same base type allows IviServicePropertyInitChecker to check if the property is initialized or not.

IviServiceNullableMirrorableMapPropertyDelegate

class IviServiceNullableMirrorableMapPropertyDelegate<K, V>(lifecycleOwner: LifecycleOwner, listener: MirrorableMapListenerForwarder<K, V>, observer: ChangeHandler<MirrorableMap<K, V>?>) : IviServicePropertyDelegate<MirrorableMap<K, V>?>

Property delegate for nullable IVI service MirrorableMap properties.

IviServiceNullablePropertyDelegate

class IviServiceNullablePropertyDelegate<T>(observer: ChangeHandler<T?>) : IviServicePropertyDelegate<T?>

Property delegate for nullable IVI service properties, except MirrorableMap

IviServicePropertyInitChecker

class IviServicePropertyInitChecker(val serviceId: IviServiceId, val requiredProperties: Map<String, IviServiceNonNullPropertyDelegateBase<*>>, val onPropertiesInitializedCallback: () -> Unit)

Helper class to check if all properties are initialized.

LiveDataPropertiesFactory

typealias LiveDataPropertiesFactory<LP> = () -> LP

OnConnectionExceptionHandler

typealias OnConnectionExceptionHandler = (String, Exception) -> Unit

ParcelableIviServiceFunResult

data class ParcelableIviServiceFunResult(val resultType: IviServiceFunResult.ResultType, val exception: ParcelableException? = null) : Parcelable

A parcelable variant of an IviServiceFunResult.

Functions

createGlobalConnectionManager

fun <C : IviServiceConnection<P, PO>, D : IviServiceConnectionData, P : Any, PO : IviServicePropertiesObserver, LP : IviServiceLiveDataPropertiesBase<P, PO>> IviServiceInterfaceRegistration<C, D, P, PO, LP>.createGlobalConnectionManager(): IviServiceConnectionManagerImpl<C, D, P, PO, LP>

Creates a global connection manager corresponding to this interface registration entry.

createIviInstanceBoundConnectionManager

fun <C : IviServiceConnection<P, PO>, D : IviServiceConnectionData, P : Any, PO : IviServicePropertiesObserver, LP : IviServiceLiveDataPropertiesBase<P, PO>> IviServiceInterfaceRegistration<C, D, P, PO, LP>.createIviInstanceBoundConnectionManager(iviInstanceId: IviInstanceId): IviServiceConnectionManagerImpl<C, D, P, PO, LP>

Creates a IVI instance bound connection manager corresponding to this interface registration entry and the given iviInstanceId.

toBinderMessageDispatchFailureListener

fun IpcMessageDispatchFailureListener.toBinderMessageDispatchFailureListener(): BinderMessageDispatchFailureListener

Creates an BinderMessageDispatchFailureListener that forwards the failure handler to the IpcMessageDispatchFailureListener.

fun <V> IviServiceFunResult<V>.toParcelable(): ParcelableIviServiceFunResult

unlinkToDeathSafe

fun IBinder.unlinkToDeathSafe(recipient: IBinder.DeathRecipient, flags: Int)

Calls IBinder.unlinkToDeath and catches NoSuchElementException.