Krosstalk Client/com.rnett.krosstalk.client

Package com.rnett.krosstalk.client

Krosstalk APIs necessary for defining a client. See the module description.

Types

ClientFailureException

open class ClientFailureException @InternalKrosstalkApi constructor(methodName: String, cause: Throwable) : KrosstalkException

A Krosstalk call failed in the client. Happens when a request could not be made.

DuplicateScopeException

class DuplicateScopeException @InternalKrosstalkApi constructor(scope: Scope) : KrosstalkException

KrosstalkClient

interface KrosstalkClient<C : ClientScope<*>>

The interface for a krosstalk client. Have your Krosstalk object implement this to be a client.

ServerDefaultInEndpointException

@InternalKrosstalkApi

class ServerDefaultInEndpointException(methodName: String, parameter: String) : KrosstalkException

WrongHeadersTypeException

class WrongHeadersTypeException @InternalKrosstalkApi constructor(methodName: String, type: KClass<*>) : KrosstalkException

WrongScopeTypeException

class WrongScopeTypeException @InternalKrosstalkApi constructor(scope: Scope, required: KType) : KrosstalkException

Functions

operator fun <T : ClientScope<C>, C> T.invoke(clientData: C): ScopeInstance<T>

suspend fun krosstalkCall(): Nothing

suspend fun krosstalkCall(requestHeaders: Headers): Nothing

suspend fun krosstalkCall(vararg scopes: ScopeInstance<*>): Nothing

suspend fun krosstalkCall(serverUrl: String?): Nothing

suspend fun krosstalkCall(scopes: Iterable<ScopeInstance<*>>): Nothing

suspend fun krosstalkCall(serverUrl: String? = null, requestHeaders: Headers = headersOf(), vararg scopes: ScopeInstance<*>): Nothing

suspend fun krosstalkCall(serverUrl: String? = null, requestHeaders: Headers = headersOf(), scopes: Iterable<ScopeInstance<*>> = emptyList()): Nothing

Placeholder for a Krosstalk client side method. Will be replaced by the compiler plugin.