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

Package-level declarations

General API of TomTom Digital Cockpit's IPC framework.

Most of the classes are used by the generated code specific to an IVI service interface.

Types

AnyIviServiceApiBase

typealias AnyIviServiceApiBase = IviServiceApiBase<*, *, *, *>

AnyIviServiceBase

typealias AnyIviServiceBase = IviServiceBase<*, *>

typealias ChangeHandler<T> = (oldValue: T?, newValue: T) -> Unit

Callback for handling a property change.

The first callback argument is the old value of the property. For non-null properties the old value is set to null when the property is being initialized.

The second callback argument is the new value of the property.

data class FunSequenceId(id: Long = 0) : Parcelable

Used to tie requests and completion tracer events together. Both request and completion events will log the same sequence identifier if they refer to the same request.

class FunSequenceIds

Keeps track of, and provides, the next function call ID. Useful for trace events.

IpcMessageDispatchFailureListener

fun interface IpcMessageDispatchFailureListener

Called when dispatching an IPC message resulted in an Exception.

IviDiscoverableServiceIdProvider

fun interface IviDiscoverableServiceIdProvider

Function interface to provide an IviServiceId for a discoverable IVI service interface.

IviDiscoverableServiceIdsMap

data class IviDiscoverableServiceIdsMap(discoverableServiceIds: Map<KClass<*>, List<IviServiceId>> = emptyMap())

IviInstanceBoundIviServiceProvider

interface IviInstanceBoundIviServiceProvider : IviServiceProvider

An IviServiceProvider that is bound to an IviInstanceId.

interface IviServiceApi<C : IviServiceConnection<P, PO>, P : Any, PO : IviServicePropertiesObserver, LP : Any>

A base interface for the APIs that clients of IVI services interact with.

IviServiceApiBase

abstract class IviServiceApiBase<C : IviServiceConnection<P, PO>, P : Any, PO : IviServicePropertiesObserver, LP : Any> @IviInternal constructor(connectionManager: IviServiceConnectionManager<C, LP>, lifecycleOwner: LifecycleOwner, serviceId: IviServiceId, iviInstanceIdProvider: OptionalIviInstanceIdProvider) : IviServiceApi<C, P, PO, LP>

Base class for <Interface>Api classes.

abstract class IviServiceBase<P : Any, PO : IviServicePropertiesObserver> @IviInternal constructor(iviServiceHostContext: IviServiceHostContext) : LifecycleOwner

Base for the generated base classes of IVI Services.

IviServiceBuildConfigExtension

data class IviServiceBuildConfigExtension(val globalRuntimeDeployments: Map<RuntimeDeploymentId.Global, RuntimeDeploymentConfig.Global> = emptyMap(), val multipleInstanceRuntimeDeployments: Map<RuntimeDeploymentId.MultipleInstance, RuntimeDeploymentConfig.MultipleInstance> = emptyMap()) : IviBuildConfigExtension

An IviBuildConfigExtension containing the IVI service runtime deployment configurations, generated at build time.

IviServiceConnection

interface IviServiceConnection<P, PO : IviServicePropertiesObserver>

Interface for all IVI service connections.

IviServiceConnectionFactory

interface IviServiceConnectionFactory

Factory interface for connections for IVI services.

IviServiceConnectionManager

interface IviServiceConnectionManager<C : IviServiceConnection<*, *>, LP>

Interface for IVI service connection managers.

IviServiceFunctionCancellationException

class IviServiceFunctionCancellationException : CancellationException

Thrown when an IVI service function resulted in a CancellationException.

IviServiceFunctionException

class IviServiceFunctionException : Exception

Thrown when an IVI service function resulted in cause.

IviServiceFunResult

class IviServiceFunResult<V>

Represents the result of an asynchronous IVI service function call.

IviServiceGenerationId

data class IviServiceGenerationId(val generation: Int) : Parcelable

Denotes the generation of an IVI service.

IviServiceHostBase

abstract class IviServiceHostBase(iviServiceHostContext: IviServiceHostContext)

A host for one or more IVI services.

IviServiceHostBuilder

abstract class IviServiceHostBuilder

Base class for IviServiceHostBase builders.

IviServiceHostContext

interface IviServiceHostContext : OptionalIviInstanceIdProvider

An entry point for an IVI service host to communicate with the rest of the system.

IviServiceHostContextFactory

interface IviServiceHostContextFactory

Factory for IVI service host context instances.

IviServiceHostContextFactoryProvider

interface IviServiceHostContextFactoryProvider

Provides an IviServiceHostContextFactory.

IviServiceHostId

data class IviServiceHostId(val id: String) : Parcelable

An IVI service host ID.

IviServiceHostStatus

data class IviServiceHostStatus(val iviInstanceId: IviInstanceId?, val started: Boolean, val serviceStatus: Map<IviServiceId, IviServiceStatus>, val pid: Int?)

IviServiceHostStatusProvider

interface IviServiceHostStatusProvider

Provides the status of the IVI service hosts.

data class IviServiceId(val id: String) : Parcelable

An IVI service ID.

IviServiceLiveDataPropertiesBase

abstract class IviServiceLiveDataPropertiesBase<P, O>

Base class for <Interface>LiveDataProperties classes.

IviServicePropertiesObserver

interface IviServicePropertiesObserver

Super interface for any properties observer interface of an IVI service interface.

IviServicePropertyDelegate

interface IviServicePropertyDelegate<T>

Interface to allow IVI service implementations to setup an IVI service property delegate.

IviServiceProvider

interface IviServiceProvider : OptionalIviInstanceIdProvider

Allows <Interface>Api classes to obtain a service connection manager.

IviServiceStatus

data class IviServiceStatus(val requested: Boolean, val state: IviServiceStatus.State)

IviServiceUnavailableException

class IviServiceUnavailableException @IviInternal constructor(serviceId: IviServiceId) : CancellationException

Thrown when an IVI service is unavailable.

OnCompletedTraceCallbackType

typealias OnCompletedTraceCallbackType<R> = (IviServiceFunResult<R?>, R?) -> Unit

OnResultCallbackType

typealias OnResultCallbackType<R> = (IviServiceFunResult<R?>) -> Unit

RuntimeDeploymentConfig

sealed class RuntimeDeploymentConfig<Builder : IviServiceHostManagerBuilder>

A runtime deployment defines how to register the IVI service hosts managers for a given runtime deployment.

RuntimeDeploymentId

sealed class RuntimeDeploymentId

Identifies a RuntimeDeploymentConfig.

SimpleIviServiceHost

class SimpleIviServiceHost(iviServiceHostContext: IviServiceHostContext, val iviServices: Collection<AnyIviServiceBase>) : IviServiceHostBase

A very simple IVI service host.

SimpleIviServiceHostBuilder

abstract class SimpleIviServiceHostBuilder : IviServiceHostBuilder

A simple IviServiceHostBuilder that builds a SimpleIviServiceHost with the IVI service implementation created by createIviServices.

Properties

iviServiceBuildConfigExtension

val IviBuildConfig.iviServiceBuildConfigExtension: IviServiceBuildConfigExtension

Returns the IviServiceBuildConfigExtension from the IviBuildConfig instance.

iviServiceBuildConfigExtensionId

val iviServiceBuildConfigExtensionId: IviBuildConfigExtensionId<IviServiceBuildConfigExtension>

Identifier for the IviServiceBuildConfigExtension.

Functions

fun <T : IviServiceApi<C, P, PO, LP>, C : IviServiceConnection<P, PO>, P : Any, PO : IviServicePropertiesObserver, LP : Any> T.queueOrRun(action: (T) -> Unit)

Runs an action if the service is available. Otherwise, it adds the action to a queue that will be processed when the service becomes available.