suspend fun createRepository(path: String, readSecret: SetLocalSecret? = null, writeSecret: SetLocalSecret? = null, token: ShareToken? = null, syncEnabled: Boolean = false, dhtEnabled: Boolean = false, pexEnabled: Boolean = false): Repository

Creates a new repository.

deleteRepositoryByName

suspend fun deleteRepositoryByName(name: String)

Delete a repository with the given name.

deriveSecretKey

suspend fun deriveSecretKey(password: Password, salt: PasswordSalt): SecretKey

findRepository

suspend fun findRepository(name: String): Repository

generatePasswordSalt

suspend fun generatePasswordSalt(): PasswordSalt

generateSecretKey

suspend fun generateSecretKey(): SecretKey

getCurrentProtocolVersion

suspend fun getCurrentProtocolVersion(): Long

Returns our Ouisync protocol version.

getDefaultBlockExpiration

suspend fun getDefaultBlockExpiration(): Duration?

getDefaultQuota

suspend fun getDefaultQuota(): StorageSize?

getDefaultRepositoryExpiration

suspend fun getDefaultRepositoryExpiration(): Duration?

getDhtRouters

suspend fun getDhtRouters(): List<String>

Returns the current DHT routers (bootstrap nodes). If the routers haven't been changed by the user yet, returns the default routers.

getExternalAddrV4

suspend fun getExternalAddrV4(): String?

getExternalAddrV6

suspend fun getExternalAddrV6(): String?

getHighestSeenProtocolVersion

suspend fun getHighestSeenProtocolVersion(): Long

Returns the highest protocol version of all known peers.

getLocalListenerAddrs

suspend fun getLocalListenerAddrs(): List<String>

Returns the listener addresses of this Ouisync instance.

getMetricsListenerAddr

suspend fun getMetricsListenerAddr(): String?

getMountRoot

suspend fun getMountRoot(): String?

getNatBehavior

suspend fun getNatBehavior(): NatBehavior?

getNetworkStats

suspend fun getNetworkStats(): Stats

getPeers

suspend fun getPeers(): List<PeerInfo>

Returns info about all known peers (both discovered and explicitly added).

getRemoteControlListenerAddr

suspend fun getRemoteControlListenerAddr(): String?

getRemoteListenerAddrs

suspend fun getRemoteListenerAddrs(host: String): List<String>

Returns the listener addresses of the specified remote Ouisync instance. Works only if the remote control API is enabled on the remote instance. Typically used with cache servers.

getRuntimeId

suspend fun getRuntimeId(): PublicRuntimeId

Returns the runtime id of this Ouisync instance.

getShareTokenAccessMode

suspend fun getShareTokenAccessMode(token: ShareToken): AccessMode

Returns the access mode that the given token grants.

getShareTokenInfoHash

suspend fun getShareTokenInfoHash(token: ShareToken): String

Return the info-hash of the repository corresponding to the given token, formatted as hex string.

getShareTokenSuggestedName

suspend fun getShareTokenSuggestedName(token: ShareToken): String

Returns the suggested name for the repository corresponding to the given token.

getStateMonitor

suspend fun getStateMonitor(path: List<MonitorId>): StateMonitorNode?

getStoreDirs

suspend fun getStoreDirs(): List<String>

getUserProvidedPeers

suspend fun getUserProvidedPeers(): List<String>

initNetwork

suspend fun initNetwork(defaults: NetworkDefaults)

Initializes the network according to the stored configuration. If a particular network parameter is not yet configured, falls back to the given defaults.

insertStoreDirs

suspend fun insertStoreDirs(paths: List<String>)

isLocalDhtEnabled

suspend fun isLocalDhtEnabled(): Boolean

Checks whether local DHT is enabled.

isLocalDiscoveryEnabled

suspend fun isLocalDiscoveryEnabled(): Boolean

Is local discovery enabled?

isPexRecvEnabled

suspend fun isPexRecvEnabled(): Boolean

Checks whether accepting peers discovered on the peer exchange is enabled.

isPexSendEnabled

suspend fun isPexSendEnabled(): Boolean

isPortForwardingEnabled

suspend fun isPortForwardingEnabled(): Boolean

Is port forwarding (UPnP) enabled?

listRepositories

suspend fun listRepositories(): Map<String, Repository>

mirrorExists

suspend fun mirrorExists(token: ShareToken, host: String): Boolean

openNetworkSocketV4

suspend fun openNetworkSocketV4(): NetworkSocket?

Opens a side channel to the underlying IPv4 UDP socket. The side channel is used to send/receive raw UDP datagrams on the same socket that the sync protocol uses. This is useful to share the socket between different protocols for hole punching.

openNetworkSocketV6

suspend fun openNetworkSocketV6(): NetworkSocket?

Opens a side channel to the underlying IPv6 UDP socket. The side channel is used to send/receive raw UDP datagrams on the same socket that the sync protocol uses. This is useful to share the socket between different protocols for hole punching.

openNetworkStream

suspend fun openNetworkStream(addr: String, topicId: TopicId): NetworkStream

Opens a raw byte streams to the given peer, bound to the given topic.

openRepository

suspend fun openRepository(path: String, localSecret: LocalSecret? = null): Repository

Opens an existing repository.

pinDht

suspend fun pinDht()

Pin the DHT to ensure it starts and remains running even when there are no active DHT lookups and no DHT-enabled repositories. This is useful to prevent the DHT restarting between the lookups (which could be slow).

removeStoreDirs

suspend fun removeStoreDirs(paths: List<String>)

removeUserProvidedPeers

suspend fun removeUserProvidedPeers(addrs: List<String>)

Removes peers previously added with Self::session_add_user_provided_peers.

setDefaultBlockExpiration

suspend fun setDefaultBlockExpiration(value: Duration?)

setDefaultQuota

suspend fun setDefaultQuota(value: StorageSize?)

setDefaultRepositoryExpiration

suspend fun setDefaultRepositoryExpiration(value: Duration?)

setDhtRouters

suspend fun setDhtRouters(routers: List<String>)

Changes the DHT routers (bootstrap nodes), rebootstraps the DHTs and restart any ongoing lookups. If this is not called, a default set of routers is used. Each router is specified as hostname + port or ip address + port.

setLocalDhtEnabled

suspend fun setLocalDhtEnabled(enabled: Boolean)

Set whether DHT on the local network or localhost is allowed. By default this is false because DHT is a global discovery mechanism and finding a local peer on it is unexpected (and could indicate malice). However, is some situations it's still useful to enable it (typically for testing).

setLocalDiscoveryEnabled

suspend fun setLocalDiscoveryEnabled(enabled: Boolean)

Enables/disables local discovery.

setMountRoot