ksrpc-core/com.monkopedia.ksrpc.channels

Package-level declarations

Interfaces that serve as the abstraction layer across different communication mediums.

Interfaces that serve as the abstraction layer across different communication mediums.

Interfaces that serve as the abstraction layer across different communication mediums.

Interfaces that serve as the abstraction layer across different communication mediums.

Types

Link copied to clipboard
sealed class CallData<T>

Wrapper around data being serialized through calls. Could be a reference to a string for a serialized object or to binary data.

Link copied to clipboard
interface ChannelClient<T> : SerializedChannel<T> , SingleChannelClient<T> , KsrpcEnvironment.Element<T>

A SerializedChannel that can call into sub-services.

Link copied to clipboard
interface ChannelHost<T> : SerializedChannel<T> , SingleChannelHost<T> , KsrpcEnvironment.Element<T>

A SerializedChannel that can host sub-services.

Link copied to clipboard
data class ChannelId(val id: String)
Link copied to clipboard
interface Connection<T> : ChannelHost<T> , ChannelClient<T> , SingleChannelConnection<T>

A bidirectional channel that can both host and call services/sub-services.

Link copied to clipboard
interface ContextContainer

Generic interface for things that hold a context that is used when interacting with them.

Link copied to clipboard
interface SerializedChannel<T> : SuspendCloseableObservable, ContextContainer, KsrpcEnvironment.Element<T>

A multi-channel interface for serialized communication, generally shouldn't need to interact directly with this, instead use either ChannelClient or ChannelHost to reference a SerializedService instead.

Link copied to clipboard
interface SerializedService<T> : SuspendCloseableObservable, ContextContainer, KsrpcEnvironment.Element<T>

Serialized version of a service. This can be transformed to and from a service using serialized and SerializedService.toStub.

Link copied to clipboard
interface SingleChannelClient<T>

A wrapper around a communication pathway that can be turned into a primary SerializedService.

Link copied to clipboard
interface SingleChannelConnection<T> : SingleChannelHost<T> , SingleChannelClient<T>

A bidirectional channel that can host one service in each direction (1 host and 1 client).

Link copied to clipboard
interface SingleChannelHost<T> : KsrpcEnvironment.Element<T>

A wrapper around a communication pathway that can be turned into a primary SerializedService.

Functions

Link copied to clipboard
inline suspend fun <T : RpcService, R : RpcService, S> SingleChannelConnection<S>.connect(crossinline host: suspend (R) -> T)

Connects both default channels for a connection (incoming and outgoing).

@JvmName(name = "connectSerialized")
suspend fun <T> SingleChannelConnection<T>.connect(host: suspend (SerializedService<T>) -> SerializedService<T>)

Raw version of connect, performing the same functionality with SerializedService directly.

Link copied to clipboard
expect fun randomUuid(): String
actual fun randomUuid(): String
actual fun randomUuid(): String
actual fun randomUuid(): String
Link copied to clipboard
inline suspend fun <T : RpcService, S> SingleChannelHost<S>.registerDefault(service: T)
suspend fun <T : RpcService, S> SingleChannelHost<S>.registerDefault(service: T, obj: RpcObject<T>)

Register a service to be hosted on the default channel.

Link copied to clipboard
inline suspend fun <T : RpcService, S> ChannelHost<S>.registerHost(service: T): ChannelId
suspend fun <T : RpcService, S> ChannelHost<S>.registerHost(service: T, obj: RpcObject<T>): ChannelId

Register a service to be hosted, the ChannelId ollocated to this service is returned. Generally this should not be called directly, as it will happen automatically when services are returned from KsMethod tagged methods.