ExternalMapDataSource Class Reference


                    
                    
                    configureSdkEngineWithAutoRemoteConnection(url:engine:)

Initialize SDKNativeEngine with URL of the remote map data source gRPC server. Newly injected map data source replaces exiting one if SDKNativeEngine was already connected. Suggested configuration is taken from SDKOptions.catalogConfigurations, actual catalog versions are queried from the remote connection in order to be in sync.

Throws

ExternalMapDataSourceExceptionError Indicates what went wrong when initialization of SDK with external map data source was attempted.

Declaration

Swift

public static func configureSdkEngineWithAutoRemoteConnection(url: String, engine: SDKNativeEngine) throws

Parameters

`url`	URL to connect with the remote map data source gRPC server. The remote map data source gRPC server could be self managed service created with help OCM Access Manager (OCM AM) or service exposed using `ExternalMapDataSource.start(String, SDKNativeEngine, SslServerCredentialsOptions?)`
`engine`	Instance of an existing `SDKNativeEngine`.


                    
                    
                    configureSdkEngineWithAutoRemoteConnectionSsl(url:engine:credentials:)

Initialize SDKNativeEngine with URL of the remote map data source gRPC server. Newly injected map data source replaces exiting one if SDKNativeEngine was already connected. Suggested configuration is taken from SDKOptions.catalogConfigurations, actual catalog versions are queried from the remote connection in order to be in sync.

Throws

ExternalMapDataSourceExceptionError Indicates what went wrong when initialization of SDK with external map data source was attempted.

Declaration

Swift

public static func configureSdkEngineWithAutoRemoteConnectionSsl(url: String, engine: SDKNativeEngine, credentials: SslClientCredentialsOptions?) throws

Parameters

`url`	URL to connect with the remote map data source gRPC server. The remote map data source gRPC server could be self managed service created with help OCM Access Manager (OCM AM) or service exposed using `ExternalMapDataSource.start(String, SDKNativeEngine, SslServerCredentialsOptions?)`
`engine`	Instance of an existing `SDKNativeEngine`.
`credentials`	Instance of `SslClientCredentialsOptions`


                    
                    
                    configureSdkEngineWithFixedRemoteConnection(url:catalogConfigs:engine:)

Initialize SDKNativeEngine with URL of the remote map data source gRPC server. Newly injected map data source replaces exiting one if SDKNativeEngine was already connected. Overrides automatic version resolution, in favour of explicitly passed one.

Throws

ExternalMapDataSourceExceptionError Indicates what went wrong when initialization of SDK with external map data source was attempted.

Declaration

Swift

public static func configureSdkEngineWithFixedRemoteConnection(url: String, catalogConfigs: [CatalogIdentifier], engine: SDKNativeEngine) throws

Parameters

`url`	URL to connect with the remote map data source gRPC server. The remote map data source gRPC server could be self managed service created with help OCM Access Manager (OCM AM) or service exposed using `ExternalMapDataSource.start(String, SDKNativeEngine, SslServerCredentialsOptions?)`
`catalogConfigs`	List of `CatalogIdentifier` with HRNs and corresponding catalog versions. The same catalogs must be added to the `DataStoreServer` instance on the server side. Otherwise, the `DataStoreClient` instance will not be able to load data from the catalog. In this case function will throw `ExternalMapDataSourceException.ADD_CATALOG_ERROR`.
`engine`	Instance of an existing `SDKNativeEngine`.


                    
                    
                    configureSdkEngineWithFixedRemoteConnectionSsl(url:catalogConfigs:engine:credentials:)

Initialize SDKNativeEngine with URL of the remote map data source gRPC server. Newly injected map data source replaces exiting one if SDKNativeEngine was already connected. Overrides automatic version resolution, in favour of explicitly passed one.

Throws

ExternalMapDataSourceExceptionError Indicates what went wrong when initialization of SDK with external map data source was attempted.

Declaration

Swift

public static func configureSdkEngineWithFixedRemoteConnectionSsl(url: String, catalogConfigs: [CatalogIdentifier], engine: SDKNativeEngine, credentials: SslClientCredentialsOptions?) throws

Parameters

`url`	URL to connect with the remote map data source gRPC server. The remote map data source gRPC server could be self managed service created with help OCM Access Manager (OCM AM) or service exposed using `ExternalMapDataSource.start(String, SDKNativeEngine, SslServerCredentialsOptions?)`
`catalogConfigs`	List of `CatalogIdentifier` with HRNs and corresponding catalog versions. The same catalogs must be added to the `DataStoreServer` instance on the server side. Otherwise, the `DataStoreClient` instance will not be able to load data from the catalog. In this case function will throw `ExternalMapDataSourceException.ADD_CATALOG_ERROR`.
`engine`	Instance of an existing `SDKNativeEngine`.
`credentials`	Instance of `SslClientCredentialsOptions`


                    
                    
                    start(url:engine:)

Exposes map data source as GRPC service on given url for SDKNativeEngine. The exposed service can be consumed with the help of ExternalMapDataSource.configureSdkEngineWithAutoRemoteConnection(...) or ExternalMapDataSource.configureSdkEngineWithFixedRemoteConnection(...)

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Throws

ExternalMapDataSourceExceptionError Indicates what went wrong when trying to expose external map data source.

Declaration

Swift

public static func start(url: String, engine: SDKNativeEngine) throws -> ExternalMapDataSource

Parameters

`url`	URL in the ‘ip_address:port’ format. Address will be used to bind to the GRPC server.
`engine`	Instance of an existing `SDKNativeEngine`.

Return Value

An object to control the lifetime of the server.


                    
                    
                    start(url:engine:serviceCredential:)

Exposes map data source as GRPC service on given url for SDKNativeEngine. The exposed service can be consumed with the help of ExternalMapDataSource.configureSdkEngineWithAutoRemoteConnection(...) or ExternalMapDataSource.configureSdkEngineWithFixedRemoteConnection(...)

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Throws

ExternalMapDataSourceExceptionError Indicates what went wrong when trying to expose external map data source.

Declaration

Swift

public static func start(url: String, engine: SDKNativeEngine, serviceCredential: SslServerCredentialsOptions?) throws -> ExternalMapDataSource

Parameters

`url`	URL in the ‘ip_address:port’ format. Address will be used to bind to the GRPC server.
`engine`	Instance of an existing `SDKNativeEngine`.
`serviceCredential`	Instance of `SslServerCredentialsOptions`

Return Value

An object to control the lifetime of the server.


                    
                    
                    stop(engine:)

Stops the exposed map data source GRPC service started using ExternalMapDataSource.start(String, SDKNativeEngine, SslServerCredentialsOptions?).

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Throws

ExternalMapDataSourceExceptionError Indicates what went wrong when trying to stop exposed external map data source service.

Declaration

Swift

public func stop(engine: SDKNativeEngine) throws

Parameters


                                engine

Instance of an existing SDKNativeEngine.