ouisync-session/org.equalitie.ouisync.session

Package-level declarations

Types

AccessChange

@Serializable

sealed interface AccessChange

How to change access to a repository.

AccessMode

@Serializable

enum AccessMode : Enum<AccessMode>

Access mode of a repository.

ConnectHandler

object ConnectHandler : CompletionHandler<Void?, CancellableContinuation<Unit>>

DirectoryEntry

@Serializable

data class DirectoryEntry(val name: String, val entryType: EntryType)

EntryType

@Serializable

enum EntryType : Enum<EntryType>

Type of filesystem entry.

ErrorCode

@Serializable

enum ErrorCode : Enum<ErrorCode>

File

open class File

FileHandle

@Serializable

@JvmInline

value class FileHandle(val value: Long)

IOHandler

class IOHandler<T> : CompletionHandler<T, CancellableContinuation<T>>

LocalSecret

@Serializable

sealed interface LocalSecret

Type of secret to unlock a repository.

LogLevel

@Serializable

enum LogLevel : Enum<LogLevel>

MessageId

@Serializable

@JvmInline

value class MessageId(val value: Long)

MetadataEdit

@Serializable

data class MetadataEdit(val key: String, val oldValue: String?, val newValue: String?)

Edit of a single metadata entry.

MonitorId

@Serializable(with = IdSerializer::class)

data class MonitorId(val name: String, val disambiguator: Long)

NatBehavior

@Serializable

enum NatBehavior : Enum<NatBehavior>

NetworkDefaults

@Serializable

data class NetworkDefaults(val bind: List<String>, val portForwardingEnabled: Boolean, val localDiscoveryEnabled: Boolean)

Default network parameters

NetworkEvent

@Serializable

enum NetworkEvent : Enum<NetworkEvent>

Network notification event.

OuisyncException

open class OuisyncException : Exception

Password

@Serializable

@JvmInline

value class Password(val value: String)

A simple wrapper over String to avoid certain kinds of attack. For more elaboration please see the documentation for the SecretKey structure.

PasswordSalt

@Serializable

@JvmInline

value class PasswordSalt(val value: ByteArray)

PeerInfo

@Serializable

data class PeerInfo(val addr: String, val source: PeerSource, val state: PeerState, val stats: Stats)

Information about a peer.

PeerSource

@Serializable

enum PeerSource : Enum<PeerSource>

How was the peer discovered.

PeerState

@Serializable

sealed interface PeerState

Progress

@Serializable

data class Progress(val value: Long, val total: Long)

Progress of a task.

PublicRuntimeId

@Serializable

@JvmInline

value class PublicRuntimeId(val value: ByteArray)

QuotaInfo

@Serializable

data class QuotaInfo(val quota: StorageSize?, val size: StorageSize)

Repository

open class Repository

RepositoryHandle

@Serializable

@JvmInline

value class RepositoryHandle(val value: Long)

Request

@Serializable

sealed interface Request

Response

@Serializable

sealed interface Response

SecretKey

@Serializable

@JvmInline

value class SecretKey(val value: ByteArray)

Symmetric encryption/decryption secret key.

Session

open class Session

SetLocalSecret

@Serializable

sealed interface SetLocalSecret

Used to set or change the read or write local secret of a repository.

ShareToken

@Serializable

@JvmInline

value class ShareToken(val value: String)

Token to share a repository. It can be encoded as a URL-formatted string and transmitted to other replicas.

StateMonitorNode

@Serializable

class StateMonitorNode(val values: Map<String, String>, val children: List<MonitorId>)

Stats

@Serializable

data class Stats(val bytesTx: Long, val bytesRx: Long, val throughputTx: Long, val throughputRx: Long)

Network traffic statistics.

StorageSize

@Serializable

@JvmInline

value class StorageSize(val bytes: Long)

Strongly typed storage size.

UnexpectedResponse

open class UnexpectedResponse : OuisyncException.InvalidData

Value

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.FIELD])

annotation class Value(val value: Int)

Annotation for enum constants to serialize/deserialize that constant as the specified value instead of its ordinal value.

Functions

suspend fun Session.close()

Closes the session.

create

suspend fun Session.Companion.create(configPath: String): Session

Creates a new Ouisync session.

fun Repository.subscribe(): Flow<Unit>

Subscribe to repository events.

subscribeToNetworkEvents

fun Session.subscribeToNetworkEvents(): Flow<NetworkEvent>

Returns a Flow of network events.