model-client/org.modelix.model.client2/ModelClientV2

ModelClientV2

class ModelClientV2(httpClient: HttpClient, val baseUrl: String, clientProvidedUserId: String?) : IModelClientV2, IModelClientV2Internal, Closable

Constructors

ModelClientV2

constructor(httpClient: HttpClient, baseUrl: String, clientProvidedUserId: String?)

Types

Companion

object Companion

Properties

baseUrl

val baseUrl: String

Functions

open override fun close()

deleteBranch

open suspend override fun deleteBranch(branch: BranchReference): Boolean

Deletes a branch from a repository if it exists.

deleteRepository

open suspend override fun deleteRepository(repository: RepositoryId): Boolean

getClientId

open override fun getClientId(): Int

getIdGenerator

open override fun getIdGenerator(): IIdGenerator

getObjects

open suspend override fun getObjects(repository: RepositoryId, keys: Sequence<ObjectHash>): Map<ObjectHash, SerializedObject>

Required for lazy loading. Use IModelClientV2.lazyLoadVersion

getReplicatedModel

fun IModelClientV2.getReplicatedModel(branchRef: BranchReference): ReplicatedModel

fun IModelClientV2.getReplicatedModel(branchRef: BranchReference, scope: CoroutineScope): ReplicatedModel

getUserId

open override fun getUserId(): String?

init

suspend fun init()

initRepository

open suspend override fun initRepository(repository: RepositoryId, useRoleIds: Boolean): IVersion

suspend fun initRepository(repository: RepositoryId, useRoleIds: Boolean = false, legacyGlobalStorage: Boolean = false): IVersion

initRepositoryWithLegacyStorage

open suspend override fun initRepositoryWithLegacyStorage(repository: RepositoryId): IVersion

lazyLoadVersion

suspend fun IModelClientV2.lazyLoadVersion(branchRef: BranchReference, config: CacheConfiguration = CacheConfiguration()): IVersion

An overload of IModelClientV2.lazyLoadVersion that reads the current version hash of the branch from the server and then loads that version with lazy loading support.

fun IModelClientV2.lazyLoadVersion(repositoryId: RepositoryId, versionHash: String, config: CacheConfiguration = CacheConfiguration()): IVersion

This function loads parts of the model lazily while it is iterated and limits the amount of data that is cached on the client side.

listBranches

open suspend override fun listBranches(repository: RepositoryId): List<BranchReference>

listRepositories

open suspend override fun listRepositories(): List<RepositoryId>

loadVersion

open suspend override fun ~~loadVersion~~(versionHash: String, baseVersion: IVersion?): IVersion

open suspend override fun loadVersion(repositoryId: RepositoryId, versionHash: String, baseVersion: IVersion?): IVersion

poll

open suspend override fun poll(branch: BranchReference, lastKnownVersion: IVersion?): IVersion

While pull returns immediately poll returns as soon as a new version, that is different from the given lastKnownVersion, is pushed to the server or after some timeout specified by the server (usually ~30 seconds).

pollHash

open suspend override fun pollHash(branch: BranchReference, lastKnownHash: String?): String

open suspend override fun pollHash(branch: BranchReference, lastKnownVersion: IVersion?): String

pull

open suspend override fun pull(branch: BranchReference, lastKnownVersion: IVersion?): IVersion

pullHash

open suspend override fun pullHash(branch: BranchReference): String

pullIfExists

open suspend override fun pullIfExists(branch: BranchReference): IVersion?

push

open suspend override fun push(branch: BranchReference, version: IVersion, baseVersion: IVersion?): IVersion

The pushed version is merged automatically by the server with the current head. The merge result is returned.

pushObjects

open suspend override fun pushObjects(repository: RepositoryId, objects: Sequence<ObjectHashAndSerializedObject>)

Required for lazy loading. Use IModelClientV2.lazyLoadVersion

query

open suspend override fun <R> query(branch: BranchReference, body: (IMonoStep<INode>) -> IMonoStep<R>): R

open suspend override fun <R> query(repositoryId: RepositoryId, versionHash: String, body: (IMonoStep<INode>) -> IMonoStep<R>): R

runWrite

suspend fun <T> IModelClientV2.runWrite(branchRef: BranchReference, body: (INode) -> T): T

Performs a write transaction on the root node of the given branch.

runWriteOnBranch

suspend fun <T> IModelClientV2.runWriteOnBranch(branchRef: BranchReference, body: (IBranch) -> T): T

Performs a write transaction on the root node of the given branch.

setClientProvideUserId

fun setClientProvideUserId(userId: String?)

Set or remove the client provided user ID.

updateUserId

suspend fun updateUserId()