Package-level declarations

Types

Link copied to clipboard

Specifies how to handle better route proposals.

Link copied to clipboard

Specifies how to handle route replanning on deviation.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
data class ReplannedRoute(val route: Route, val replanningReason: RouteReplanningReason, val routePlanningOptions: RoutePlanningOptions)

Describes the route after replanning.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
interface ReplanningRetryPolicy

Specifies how to handle requests which failed during replanning of a Route.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
object ReplanningRetryPolicyFactory

Responsible for creating default implementation of a ReplanningRetryPolicy.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
interface RouteProposalSelector

Responsible for selecting a route proposal inside RouteReplanningEngine.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
interface RouteReplanningEngine : AutoCloseable

Responsible for replanning a route.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
object RouteReplanningEngineFactory

Responsible for creating default implementation of RouteReplanningEngine.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
abstract class RouteReplanningEngineFailure

Represents the various failure reasons encountered during the route replanning process by the RouteReplanningEngine.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class RouteReplanningEngineOptions(val routeUpdateMode: RouteUpdateMode = DEFAULT_ROUTE_UPDATE_MODE, val replanRouteInterval: Duration = DEFAULT_REPLAN_ROUTE_INTERVAL, val validRemainingRouteDuration: Duration = DEFAULT_VALID_ROUTE_DURATION_REMAINING)
Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
abstract class RouteReplanningFailure

Represents the various failure reasons encountered during the route replanning process by the RouteReplanner.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
abstract class RouteReplanningReason

Specifies the reason for replanning the current route.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
value class RouteUpdateMode

Specifies whether or not the system should try to periodically update the active route and look for better route proposals.