Krosstalk Server/com.rnett.krosstalk.server.plugin

Package com.rnett.krosstalk.server.plugin

APIs for defining server plugins. For an example, see the Krosstalk Ktor server.

For instructions on writing plugins, see WRITING_PLUGINS.md.

Types

KrosstalkResponse

@KrosstalkPluginApi

class KrosstalkResponse(statusCode: Int, contentType: String?, responseHeaders: Headers, responseBody: ByteArray)

A response to send from the server. Should not set content type if contentType is null.

ServerHandler

interface ServerHandler<S : ServerScope<*>>

A Krosstalk server handler. Should help you set up receiver endpoints for all Krosstalk methods (Krosstalk.methods), which should each call handle for their method. No behavior is defined here as what is necessary to do that, and where and how you will want to call it, will vary widely depending on which server you are using.

Functions

handle

@KrosstalkPluginApi

inline suspend fun <K : Krosstalk, KrosstalkServer<*>> K.handle(serverUrl: String, method: MethodDefinition<*>, requestHeaders: Headers, urlArguments: Map<String, String>, requestBody: ByteArray, scopes: WantedScopes, handleException: (Throwable) -> Unit = { throw it }, sendResponse: (KrosstalkResponse) -> Unit)

Helper method for server side to handle a request for a Krosstalk method.

scopesAsType

@KrosstalkPluginApi

@JvmName(name = "serverScopesAsType")

fun <S : ServerScope<*>, K : Krosstalk, KrosstalkServer<S>> K.scopesAsType(scopes: Iterable<Scope>): List<S>

Properties

serverScopes

@KrosstalkPluginApi

val <S : ServerScope<*>, K : Krosstalk, KrosstalkServer<S>> K.serverScopes: List<S>