Krosstalk Base/com.rnett.krosstalk.endpoint

Package com.rnett.krosstalk.endpoint

Contains the endpoint template and resolution classes.

Endpoint represents a template from @KrosstalkEndpoint, with parameters and optional segments. Client plugins do not need to work with it, it is all handled internally.

EndpointResolveTree provides a tree based URL resolver based on an endpoint, that can extract parameter values and handle optionals. This is used by Endpoint.resolve, which is generally how server plugins do method resolution. See the Ktor server plugin for an example of how resolution can be handled.

Types

@KrosstalkPluginApi

data class Endpoint(urlParts: EndpointRegion.UrlParts, queryParameters: EndpointRegion.QueryParameters)

Class representing an endpoint template. Valid template structures:

@KrosstalkPluginApi

sealed class EndpointPart<in L : EndpointRegion>

EndpointQueryParameter

@KrosstalkPluginApi

typealias EndpointQueryParameter = EndpointPart<EndpointRegion.QueryParameters>

@KrosstalkPluginApi

sealed class EndpointRegion

EndpointResolveTree

@KrosstalkPluginApi

sealed class EndpointResolveTree

EndpointUnknownArgumentException

class EndpointUnknownArgumentException @InternalKrosstalkApi constructor(methodName: String, endpointTemplate: Endpoint, missingParam: String, knownParams: Set<String>) : KrosstalkException

An unknown parameter was used in an @KrosstalkEndpoint template.

EndpointUrlPart

@KrosstalkPluginApi

typealias EndpointUrlPart = EndpointPart<EndpointRegion.UrlParts>

ResolveEndpoint

@KrosstalkPluginApi

data class ResolveEndpoint(urlParts: List<ResolveUrlPart>, queryParams: Map<String, ResolveQueryParam>)

ResolveQueryParam

@KrosstalkPluginApi

sealed class ResolveQueryParam

@KrosstalkPluginApi

sealed class ResolveUrlPart

@KrosstalkPluginApi

data class UrlRequest(urlParts: List<String>, queryParams: Map<String, String>)