All Types

io.ktor.network.sockets.ABoundSocket

Represents a bound socket

io.ktor.network.sockets.AConnectedSocket

Represent a connected socket

io.ktor.network.sockets.AReadable

Represent a readable socket

io.ktor.network.sockets.ASocket

Base type for all async sockets

io.ktor.network.sockets.AWritable

Represents a writable socket

io.ktor.client.features.cookies.AcceptAllCookiesStorage

CookiesStorage that stores all the cookies in an in-memory map.

io.ktor.features.AcceptHeaderContributor

Functional type for accepted content types contributor

io.ktor.network.sockets.Acceptable

Represents a socket source, for example server socket

io.ktor.validator.AccessFlags

io.ktor.network.selector.ActorSelectorManager

Default CIO selector manager implementation

io.ktor.util.AlwaysFailNonceManager

Stub implementation that always fails. Will be removed so no public signatures should rely on it

io.ktor.routing.AndRouteSelector

Evaluates a route as a result of the AND operation using two other selectors

io.ktor.client.engine.android.Android

HttpClientEngineFactory using a UrlConnection based backend implementation without additional dependencies with the the associated configuration AndroidEngineConfig.

io.ktor.client.engine.android.AndroidClientEngine

Android client engine

io.ktor.client.engine.android.AndroidEngineConfig

Configuration for Android client engine.

io.ktor.client.engine.android.AndroidEngineContainer

org.objectweb.asm.tree.AnnotationNode (extensions in package io.ktor.validator)

io.ktor.client.engine.apache.Apache

HttpClientEngineFactory using org.apache.httpcomponents.httpasyncclient with the the associated configuration ApacheEngineConfig.

io.ktor.client.engine.apache.ApacheEngineConfig

Configuration for Apache implementation of HttpClientEngineFactory.

io.ktor.client.engine.apache.ApacheEngineContainer

io.ktor.application.Application

Represents configured and running web application, capable of handling requests. It is also the application coroutine scope that is cancelled immediately at application stop so useful for launching background coroutines.

io.ktor.application.ApplicationCall

Represents a single act of communication between client and server.

io.ktor.application.ApplicationCallPipeline

Pipeline configuration for executing ApplicationCall instances

io.ktor.auth.ApplicationCallPredicate

Predicate function that accepts an application call and returns true or false

io.ktor.config.ApplicationConfig

Represents an application config node

io.ktor.config.ApplicationConfigValue

Represents an application config value

io.ktor.config.ApplicationConfigurationException

Thrown when an application is misconfigured

io.ktor.server.engine.ApplicationEngine

Engine which runs an application

io.ktor.server.engine.ApplicationEngineEnvironment

Represents an environment in which engine runs

io.ktor.server.engine.ApplicationEngineEnvironmentBuilder

Engine environment configuration builder

io.ktor.server.engine.ApplicationEngineEnvironmentReloading

Implements ApplicationEngineEnvironment by loading an Application from a folder or jar.

io.ktor.server.engine.ApplicationEngineFactory

Factory interface for creating ApplicationEngine instances

io.ktor.application.ApplicationEnvironment

Represents an environment in which Application runs

io.ktor.application.ApplicationEvents

Provides events for Application lifecycle

io.ktor.application.ApplicationFeature

Defines an installable Application Feature

io.ktor.request.ApplicationReceivePipeline

Pipeline for processing incoming content

io.ktor.request.ApplicationReceiveRequest

Represents a subject for ApplicationReceivePipeline

io.ktor.request.ApplicationRequest

Represents client’s request

io.ktor.response.ApplicationResponse

Represents server’s response

io.ktor.response.ApplicationSendPipeline

Server response send pipeline

io.ktor.server.servlet.AsyncServletApplicationCall

io.ktor.server.servlet.AsyncServletApplicationRequest

io.ktor.server.servlet.AsyncServletApplicationResponse

io.ktor.util.AttributeKey

Specifies a key for an attribute in Attributes

io.ktor.util.Attributes

Map of attributes accessible by AttributeKey in a typed manner

io.ktor.client.tests.AttributesTest

io.ktor.client.features.auth.Auth

Client authentication feature. providers - list of auth providers to use.

io.ktor.client.features.auth.AuthProvider

Authentication provider interface.

io.ktor.http.auth.AuthScheme

Contains the standard auth schemes.

io.ktor.auth.Authentication

Authentication feature supports pluggable mechanisms for checking and challenging a client to provide credentials

io.ktor.auth.AuthenticationContext

Represents an authentication context for the call

io.ktor.auth.AuthenticationFailedCause

Represents a cause for authentication challenge request

io.ktor.auth.AuthenticationFunction

Authentication function that accepts and verifies credentials and returns a principal when verification successful.

io.ktor.auth.AuthenticationPipeline

Represents authentication Pipeline for checking and requesting authentication

io.ktor.auth.AuthenticationProcedureChallenge

Represents authentication challenging procedure requested by authentication mechanism

io.ktor.auth.AuthenticationProvider

Represents an authentication provider with the given name

io.ktor.auth.AuthenticationRouteSelector

An authentication route node that is used by Authentication feature and usually created by Route.authenticate DSL function so generally there is no need to instantiate it directly unless you are writing an extension

io.ktor.features.AutoHeadResponse

A feature that automatically respond to HEAD requests

io.ktor.http.BadContentTypeFormatException

Exception thrown when a content type string is malformed.

io.ktor.features.BadRequestException

Base exception to indicate that the request is not correct due to wrong/missing request parameters, body content or header values. Throwing this exception in a handler will lead to 400 Bad Request response unless a custom io.ktor.features.StatusPages handler registered.

io.ktor.client.features.BadResponseStatusException

io.ktor.server.engine.BaseApplicationCall

Base class for implementing an ApplicationCall.

io.ktor.server.engine.BaseApplicationEngine

Base class for implementing ApplicationEngine

io.ktor.server.engine.BaseApplicationRequest

Base class for implementing ApplicationRequest

io.ktor.server.engine.BaseApplicationResponse

Base class for implementing an ApplicationResponse

io.ktor.client.features.auth.basic.BasicAuth

HttpClient feature that sets an Authorization: basic header as specified in RFC-2617 using username and password.

io.ktor.client.features.auth.providers.BasicAuthConfig

BasicAuthProvider configuration.

io.ktor.client.features.auth.providers.BasicAuthProvider

Client basic authentication provider.

io.ktor.auth.BasicAuthenticationProvider

Represents a Basic authentication provider

io.ktor.network.sockets.BoundDatagramSocket

Represents a bound datagram socket

io.ktor.client.tests.BuildersTest

kotlin.ByteArray (extensions in package io.ktor.util)

io.ktor.content.ByteArrayContent

io.ktor.http.content.ByteArrayContent

Implementation of the OutgoingContent.ByteArrayContent for sending array of bytes

java.nio.ByteBuffer (extensions in package io.ktor.util)

io.ktor.client.utils.ByteBufferPool

io.ktor.util.cio.ByteBufferPool

kotlinx.coroutines.io.ByteReadChannel (extensions in package io.ktor.util)

kotlinx.coroutines.io.ByteReadChannel (extensions in package io.ktor.util.cio)

kotlinx.io.core.ByteReadPacket (extensions in package io.ktor.util)

kotlinx.coroutines.io.ByteWriteChannel (extensions in package io.ktor.util)

kotlinx.coroutines.io.ByteWriteChannel (extensions in package io.ktor.util.cio)

io.ktor.client.engine.cio.CIO

HttpClientEngineFactory using a Coroutine based I/O implementation without additional dependencies with the the associated configuration CIOEngineConfig.

io.ktor.server.cio.CIO

An ApplicationEngineFactory providing a CIO-based ApplicationEngine

io.ktor.server.cio.CIOApplicationEngine

Engine that based on CIO backend

io.ktor.network.tls.CIOCipherSuites

CIO cipher suites collection https://www.ietf.org/rfc/rfc5289.txt https://tools.ietf.org/html/rfc5288#section-3

io.ktor.client.engine.cio.CIOEngineConfig

Configuration for CIO client engine.

io.ktor.client.engine.cio.CIOEngineContainer

io.ktor.http.cio.CIOHeaders

An adapter from CIO low-level headers map to ktor Headers interface

io.ktor.http.cio.CIOMultipartDataBase

Represents a multipart data object that does parse and convert parts to ktor’s PartData

io.ktor.features.CORS

CORS feature. Please read http://ktor.io/servers/features/cors.html first before using it.

io.ktor.sessions.Cache

io.ktor.client.utils.CacheControl

List of CacheControl known values.

io.ktor.http.CacheControl

Represents a value for a Cache-Control header

io.ktor.sessions.CacheStorage

io.ktor.features.CachingHeaders

Feature that set CachingOptions headers for every response. It invokes optionsProviders for every response and use first non null caching options

io.ktor.http.content.CachingOptions

Specifies caching properties for an OutgoingContent such as Cache-Control or Expires

io.ktor.client.features.CallExceptionHandler

Response exception handler method.

io.ktor.features.CallId

Retrieves and generates if necessary a call id. A call id (or correlation id) could be retrieved_ from a call via CallId.Configuration.retrieve function. Multiple retrieve functions could be configured that will be invoked one by one until one of them return non-null value. If no value has been provided by retrievers then a generator could be applied to generate a new call id. Generators could be provided via CallId.Configuration.generate function. Similar to retrieve, multiple generators could be configured so they will be invoked one by one. Usually call id is passed via io.ktor.http.HttpHeaders.XRequestId so one could use CallId.Configuration.retrieveFromHeader function to retrieve call id from a header.

io.ktor.features.CallIdProvider

A function that retrieves or generates call id using provided call

io.ktor.features.CallIdVerifier

A function that verifies retrieved or generated call id. Should return true for a valid call id. Also it could throw a RejectedCallIdException to reject an ApplicationCall otherwise an illegal call id will be ignored or replaced with generated one.

io.ktor.features.CallLogging

Logs application lifecycle and call events.

io.ktor.util.CaseInsensitiveMap

A map with case insensitive String keys

io.ktor.network.tls.CertificateAndKey

Client certificate chain with private key.

io.ktor.network.tls.certificates.CertificateBuilder

Builder for certificate

io.ktor.util.cio.ChannelIOException

An exception thrown when an IO error occurred during reading or writing to/from the underlying channel. The typical error is “connection reset” and so on.

io.ktor.util.cio.ChannelReadException

An exception that is thrown when an IO error occurred during reading from the request channel. Usually it happens when a remote client closed the connection.

io.ktor.util.cio.ChannelWriteException

An exception that is thrown when an IO error occurred during writing to the destination channel. Usually it happens when a remote client closed the connection.

kotlin.Char (extensions in package io.ktor.util)

io.ktor.network.tls.CipherSuite

Represents a TLS cipher suite

io.ktor.network.tls.CipherType

Cipher type.

java.lang.Class (extensions in package io.ktor.util)

io.ktor.validator.ClassBinarySignature

org.objectweb.asm.tree.ClassNode (extensions in package io.ktor.validator)

io.ktor.validator.ClassVisibility

io.ktor.client.engine.cio.ClientClosedException

io.ktor.client.tests.utils.ClientLoader

Helper interface to test client.

io.ktor.client.features.ClientRequestException

Bad client request exception.

io.ktor.client.tests.utils.ClientRunner

io.ktor.client.request.ClientUpgradeContent

io.ktor.client.features.websocket.ClientWebSocketSession

Client specific WebSocketSession.

io.ktor.http.cio.websocket.CloseReason

Websocket close reason

io.ktor.features.Compression

Feature to compress a response based on conditions and ability of client to decompress it

io.ktor.features.CompressionEncoder

Represents a Compression encoder

io.ktor.features.CompressionEncoderBuilder

Builder for compression encoder configuration

io.ktor.features.CompressionEncoderConfig

Configuration for an encoder

io.ktor.features.CompressionOptions

Compression feature configuration

io.ktor.util.collections.ConcurrentMap

io.ktor.util.collections.ConcurrentSet

io.ktor.features.ConditionalHeaders

Feature to check modified/match conditional headers and avoid sending contents if it was not changed

io.ktor.features.ConditionsHolderBuilder

Represents a builder for conditions

com.typesafe.config.Config (extensions in package io.ktor.config)

io.ktor.network.sockets.Configurable

Represent a configurable socket

io.ktor.client.engine.cio.ConnectException

io.ktor.network.sockets.ConnectedDatagramSocket

Represents a connected datagram socket.

io.ktor.http.cio.ConnectionOptions

Represents a parsed Connection header

io.ktor.client.tests.ConnectionTest

io.ktor.server.engine.ConnectorType

Represents a type of a connector, e.g HTTP or HTTPS.

io.ktor.client.features.cookies.ConstantCookiesStorage

CookiesStorage that ignores addCookie and returns a list of specified cookies when constructed.

io.ktor.routing.ConstantParameterRouteSelector

Evaluates a route against a constant query parameter value

io.ktor.features.ContentConverter

A custom content converted that could be registered in ContentNegotiation feature for any particular content type Could provide bi-directional conversion implementation. One of the most typical examples of content converter is a json content converter that provides both serialization and deserialization

io.ktor.http.ContentDisposition

Represents Content-Disposition header value

io.ktor.client.features.compression.ContentEncoder

Client content encoder.

io.ktor.client.features.compression.ContentEncoding

Content-Encoding header support.

io.ktor.features.ContentNegotiation

This feature provides automatic content conversion according to Content-Type and Accept headers

io.ktor.http.ContentRange

Represents a Range header’s particular range

io.ktor.features.ContentTransformationException

Thrown when content cannot be transformed to the desired type. It is not defined which status code will be replied when an exception of this type is thrown and not caught. Depending on child type it could be 4xx or 5xx status code. By default it will be 500 Internal Server Error.

io.ktor.request.ContentTransformationException

Thrown when content cannot be transformed to the desired type.

io.ktor.http.ContentType

Represents a value for a Content-Type header.

io.ktor.features.ContentTypeWithQuality

Pair of ContentType and quality usually parsed from HttpHeaders.Accept headers.

io.ktor.util.pipeline.ContextDsl

DslMarker for pipeline execution context

io.ktor.util.ConversionService

Data conversion service that does serialization and deserialization to/from list of strings

io.ktor.http.Cookie

Represents a cooke value

io.ktor.sessions.CookieConfiguration

Cookie configuration being used to send sessions

io.ktor.http.CookieEncoding

Cooke encoding strategy

io.ktor.sessions.CookieIdSessionBuilder

Cookie session configuration builder

io.ktor.sessions.CookieSessionBuilder

Cookie session configuration builder

io.ktor.client.features.cookies.CookiesStorage

Storage for Cookie.

io.ktor.client.tests.CookiesTest

kotlinx.coroutines.CoroutineScope (extensions in package io.ktor.http.cio.websocket)

kotlinx.coroutines.CoroutineScope (extensions in package io.ktor.http.cio)

kotlinx.coroutines.CoroutineScope (extensions in package io.ktor.server.cio)

kotlinx.coroutines.CoroutineScope (extensions in package io.ktor.features)

kotlinx.coroutines.CoroutineScope (extensions in package io.ktor.server.engine)

io.ktor.auth.Credential

Marker interface indicating that a class represents credentials for authentication

io.ktor.sessions.CurrentSession

Represents a container for all session instances

io.ktor.features.DataConversion

Data conversion feature to serialize and deserialize types using converters registry

io.ktor.util.DataConversionException

Thrown when failed to convert value

io.ktor.network.sockets.Datagram

UDP datagram with packet content targeted to address

io.ktor.network.sockets.DatagramReadChannel

A channel for receiving datagrams

io.ktor.network.sockets.DatagramReadWriteChannel

A channel for sending and receiving datagrams

io.ktor.network.sockets.DatagramWriteChannel

A channel for sending datagrams

java.util.Date (extensions in package io.ktor.util)

io.ktor.http.cio.DecoderJob

Decoder job type

io.ktor.client.features.websocket.DefaultClientWebSocketSession

ClientSpecific DefaultWebSocketSession.

io.ktor.util.DefaultConversionService

The default conversion service that supports only basic types and enums

io.ktor.features.DefaultHeaders

Adds standard HTTP headers Date and Server and provides ability to specify other headers that are included in responses.

io.ktor.client.request.DefaultHttpRequest

Default HttpRequest implementation.

io.ktor.client.response.DefaultHttpResponse

Default HttpResponse implementation.

io.ktor.auth.DefaultOAuth2StateProvider

The default state provider that does generate random nonce and don’t keep them

io.ktor.client.features.DefaultRequest

Feature is used to set request default parameters.

io.ktor.response.DefaultResponsePushBuilder

HTTP/2 push builder

io.ktor.server.servlet.DefaultServletUpgrade

The default servlet upgrade implementation using Servlet API. Please note that some servlet containers may not support it or it may be broken.

io.ktor.websocket.DefaultWebSocketServerSession

Represents a server-side web socket session with all default implementations

io.ktor.http.cio.websocket.DefaultWebSocketSession

Default websocket session with ping-pong and timeout processing and built-in closeReason population

io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl

Default web socket session implementation that handles ping-pongs, close sequence and frame fragmentation

io.ktor.features.DeflateEncoder

Implementation of the deflate encoder

io.ktor.features.DelegatingConversionService

Custom convertor builder

io.ktor.server.cio.DevelopmentEngine

io.ktor.server.jetty.DevelopmentEngine

io.ktor.server.netty.DevelopmentEngine

io.ktor.server.tomcat.DevelopmentEngine

io.ktor.util.Digest

Stateful digest class specified to calculate digest.

io.ktor.client.features.auth.providers.DigestAuthConfig

DigestAuthProvider configuration.

io.ktor.client.features.auth.providers.DigestAuthProvider

Client digest AuthProvider.

io.ktor.auth.DigestAuthenticationProvider

Represents a Digest authentication provider

io.ktor.auth.DigestCredential

Represents Digest credentials

io.ktor.auth.DigestProviderFunction

Provides message digest for the specified username and realm or returns null if the user is missing. This function could fetch digest from a database or compute it instead.

io.ktor.util.DispatcherWithShutdown

Specialized dispatcher useful for graceful shutdown

io.ktor.client.call.DoubleReceiveException

Exception representing that the response payload has already been received.

io.ktor.metrics.dropwizard.DropwizardMetrics

Dropwizard metrics support feature. See https://ktor.io/servers/features/metrics.html for details.

io.ktor.application.DuplicateApplicationFeatureException

Thrown when Application Feature has been attempted to be installed with the same key as already installed Feature

io.ktor.client.utils.EmptyContent

Concrete OutgoingContent without a payload.

io.ktor.http.EmptyHeaders

io.ktor.http.EmptyParameters

io.ktor.util.Encoder

Content encoder.

io.ktor.http.cio.EncoderJob

Encoder job type

io.ktor.client.engine.cio.EndpointConfig

Endpoint settings.

io.ktor.server.engine.EngineAPI

API marked with this annotation is not intended to be used by end users unless a custom server engine implementation is required

io.ktor.server.engine.EngineConnectorBuilder

Mutable implementation of EngineConnectorConfig for building connectors programmatically

io.ktor.server.engine.EngineConnectorConfig

Represents a connector configuration.

io.ktor.server.cio.EngineMain

Default development engine with main function that starts CIO engine using application.conf

io.ktor.server.jetty.EngineMain

Jetty development engine

io.ktor.server.netty.EngineMain

Netty development engine

io.ktor.server.tomcat.EngineMain

Tomcat development engine

io.ktor.server.engine.EnginePipeline

Application engine pipeline. One usually don’t need to install interceptors here unless your are writing your own engine implementation

io.ktor.server.engine.EngineSSLConnectorBuilder

Mutable implementation of EngineSSLConnectorConfig for building connectors programmatically

io.ktor.server.engine.EngineSSLConnectorConfig

Represents an SSL connector configuration.

io.ktor.server.testing.EngineStressSuite

io.ktor.server.testing.EngineTestBase

io.ktor.server.testing.EngineTestSuite

io.ktor.http.content.EntityTagVersion

This version checks etag value and pass it through conditions supplied by the remote client. Depending on conditions it produces return value of enum type VersionCheckResult

io.ktor.application.EventDefinition

Definition of an event

io.ktor.application.EventHandler

Specifies signature for the event handler

io.ktor.client.features.ExpectSuccess

io.ktor.client.engine.cio.FailToConnectException

io.ktor.client.tests.FeaturesTest

io.ktor.validator.FieldBinarySignature

org.objectweb.asm.tree.FieldNode (extensions in package io.ktor.validator)

java.io.File (extensions in package io.ktor.util)

java.io.File (extensions in package io.ktor.util.cio)

io.ktor.auth.FormAuthChallenge

Specifies what to send back if form authentication fails.

io.ktor.auth.FormAuthenticationProvider

Represents a form-based authentication provider

io.ktor.client.request.forms.FormBuilder

Form builder type used in formData builder function.

io.ktor.client.request.forms.FormDataContent

OutgoingContent with for application/x-www-form-urlencoded formatted request.

io.ktor.client.request.forms.FormPart

Multipart form item. Use it to build form in client.

io.ktor.features.ForwardedHeaderSupport

Forwarded header support. See RFC 7239 https://tools.ietf.org/html/rfc7239

io.ktor.http.cio.websocket.Frame

A frame received or ready to be sent. It is not reusable and not thread-safe

io.ktor.http.cio.websocket.FrameParser

io.ktor.http.cio.websocket.FrameType

Frame types enum

io.ktor.freemarker.FreeMarker

Freemarker support feature. Provides ability to respond with FreeMarkerContent

io.ktor.freemarker.FreeMarkerContent

Represents a content handled by FreeMarker feature.

io.ktor.client.tests.FullFormTest

io.netty.util.concurrent.Future (extensions in package io.ktor.server.netty)

io.ktor.util.date.GMTDate

Date in GMT timezone

io.ktor.util.GenerateOnlyNonceManager

This implementation does only generate nonce values but doesn’t validate them. This is recommended for testing only.

io.ktor.gson.GsonConverter

GSON converter for ContentNegotiation feature

io.ktor.client.features.json.GsonSerializer

JsonSerializer using Gson as backend.

io.ktor.features.GzipEncoder

Implementation of the gzip encoder

io.ktor.features.HSTS

HSTS feature that appends Strict-Transport-Security HTTP header to every response. See http://ktor.io/servers/features/hsts.html for details See RFC 6797 https://tools.ietf.org/html/rfc6797

io.ktor.util.Hash

io.ktor.network.tls.extensions.HashAlgorithm

Hash algorithms

io.ktor.network.tls.extensions.HashAndSign

Hash and signature algorithm pair

io.ktor.sessions.HeaderIdSessionBuilder

Header session configuration builder

io.ktor.sessions.HeaderSessionBuilder

Header session configuration builder

io.ktor.http.HeaderValue

Represents a header value. Similar to HeaderValueWithParameters

io.ktor.http.auth.HeaderValueEncoding

Describes how a header should be encoded.

io.ktor.http.HeaderValueParam

Represents a single value parameter

io.ktor.http.HeaderValueWithParameters

Represents a header value that consist of content followed by parameters. Useful for headers such as Content-Type, Content-Disposition and so on.

io.ktor.http.Headers

Represents HTTP headers as a map from case-insensitive names to collection of String values

io.ktor.http.HeadersBuilder

io.ktor.http.HeadersImpl

io.ktor.http.HeadersSingleImpl

io.ktor.server.testing.HighLoadHttpGenerator

This HTTP generator produces huge amount of requests however it doesn’t validate responses and doesn’t measure any time characteristics.

io.ktor.config.HoconApplicationConfig

Implements ApplicationConfig by loading configuration from HOCON data structures

io.ktor.routing.HostRouteSelector

Evaluates a route against a request’s host and port

io.ktor.html.HtmlContent

Represents an OutgoingContent using kotlinx.html builder.

io.ktor.routing.HttpAcceptRouteSelector

Evaluates a route against a content-type in the HttpHeaders.Accept header in the request

io.ktor.http.auth.HttpAuthHeader

Describes an authentication header with a mandatory authScheme that usually is a standard AuthScheme.

io.ktor.client.features.cache.HttpCache

This feature allow to use HTTP cache.

io.ktor.client.features.cache.HttpCacheEntry

Client single response cache with expires and varyKeys.

io.ktor.client.features.cache.storage.HttpCacheStorage

Cache storage interface.

io.ktor.client.features.HttpCallValidator

Response validator feature is used for validate response and handle response exceptions.

io.ktor.client.HttpClient

Asynchronous client to perform HTTP requests.

io.ktor.client.call.HttpClientCall

A class that represents a single pair of request and response for a specific HttpClient.

io.ktor.client.HttpClientConfig

Mutable configuration used by HttpClient.

io.ktor.client.HttpClientDsl

Dsl marker for HttpClient dsl.

io.ktor.client.engine.HttpClientEngine

Base interface use to define engines for HttpClient.

io.ktor.client.engine.HttpClientEngineConfig

Base configuration for HttpClientEngine.

io.ktor.client.HttpClientEngineContainer

A container is searched across dependencies using ServiceLoader to find client implementations. An implementation of this interface provides HTTP client factory and only used to find the default client engine when HttpClient function is called with no particular client implementation specified

io.ktor.client.engine.HttpClientEngineFactory

Factory of HttpClientEngine with a specific T of HttpClientEngineConfig.

io.ktor.client.features.HttpClientFeature

Base interface representing a HttpClient feature.

io.ktor.client.engine.HttpClientJvmEngine

Base jvm implementation for HttpClientEngine

io.ktor.client.tests.HttpClientTest

io.ktor.client.features.cookies.HttpCookies

HttpClient feature that handles sent Cookie, and received Set-Cookie headers, using a specific storage for storing and retrieving cookies.

io.ktor.client.call.HttpEngineCall

Raw http call produced by engine.

io.ktor.routing.HttpHeaderRouteSelector

Evaluates a route against a header in the request

io.ktor.http.HttpHeaders

io.ktor.http.cio.HttpHeadersMap

A headers map data structure used in CIO

io.ktor.http.HttpMessage

A message either from the client or the server, that has headers associated.

io.ktor.http.cio.HttpMessage

Represents a base HTTP message type for request and response

io.ktor.http.HttpMessageBuilder

A builder message either for the client or the server, that has a headers builder associated.

io.ktor.http.HttpMethod

Represents an HTTP method (verb)

io.ktor.routing.HttpMethodRouteSelector

Evaluates a route against an HttpMethod

io.ktor.client.features.HttpPlainText

HttpClient feature that encodes String request bodies to TextContent and processes the response body as String.

io.ktor.http.HttpProtocolVersion

Represents an HTTP protocol version.

io.ktor.client.response.HttpReceivePipeline

HttpClient Pipeline used for receiving HttpResponse without any processing.

io.ktor.client.features.HttpRedirect

HttpClient feature that handles http redirect

io.ktor.client.tests.HttpRedirectTest

io.ktor.client.request.HttpRequest

A request for HttpClient, first part of HttpClientCall.

io.ktor.client.request.HttpRequestBuilder

Class for building HttpRequestData.

io.ktor.client.request.HttpRequestData

Actual data of the HttpRequest, including url, method, headers, body and executionContext. Built by HttpRequestBuilder.

io.ktor.http.cio.HttpRequestHandler

HTTP request handler function

io.ktor.client.request.HttpRequestPipeline

HttpClient Pipeline used for executing HttpRequest.

io.ktor.client.response.HttpResponse

A response for HttpClient, second part of HttpClientCall.

io.ktor.client.response.HttpResponseConfig

io.ktor.client.response.HttpResponseContainer

Class representing a typed response with an attached expectedType.

io.ktor.client.request.HttpResponseData

Data prepared for HttpResponse.

io.ktor.client.response.HttpResponsePipeline

HttpClient Pipeline used for executing HttpResponse.

io.ktor.client.features.HttpSend

This is internal feature that is always installed.

io.ktor.client.features.HttpSendInterceptor

HttpSend pipeline interceptor function

io.ktor.client.request.HttpSendPipeline

HttpClient Pipeline used for sending HttpRequest to remote server.

io.ktor.server.cio.HttpServer

Represents a server instance

io.ktor.server.cio.HttpServerSettings

HTTP server connector settings

io.ktor.http.HttpStatusCode

Represents an HTTP status code and description.

io.ktor.http.content.HttpStatusCodeContent

Represents a simple status code response with no content

io.ktor.features.HttpsRedirect

Redirect non-secure requests to HTTPS

io.ktor.network.util.IOCoroutineDispatcher

Default ktor fixed size dispatcher for doing non-blocking I/O operations and selection

io.ktor.util.Identity

Empty Encoder

io.ktor.features.IdentityEncoder

Implementation of the identity encoder

kotlinx.io.core.Input (extensions in package io.ktor.util)

io.ktor.client.request.forms.InputProvider

Reusable Input form entry.

java.io.InputStream (extensions in package io.ktor.util.cio)

java.time.Instant (extensions in package io.ktor.util.date)

io.ktor.network.selector.InterestSuspensionsMap

io.ktor.util.InternalAPI

API marked with this annotation is ktor internal and it is not intended to be used outside. It could be modified or removed without any notice. Using it outside of ktor could cause undefined behaviour and/or any strange effects.

io.ktor.client.features.cache.InvalidCacheStateException

io.ktor.util.pipeline.InvalidPhaseException

An exception about misconfigured phases in a pipeline

io.ktor.server.testing.It

it function receiver object

kotlin.collections.Iterable (extensions in package io.ktor.http)

io.ktor.auth.jwt.JWTAuthenticationProvider

JWT authentication provider that will be registered with the specified name

io.ktor.auth.jwt.JWTConfigureFunction

JWT verifier configuration function. It is applied on the verifier builder.

io.ktor.auth.jwt.JWTCredential

Represents a JWT credential consist of the specified payload

io.ktor.auth.jwt.JWTPrincipal

Represents a JWT principal consist of the specified payload

io.ktor.jackson.JacksonConverter

    install(ContentNegotiation) {
       register(ContentType.Application.Json, JacksonConverter())
    }

    to be able to modify the objectMapper (eg. using specific modules and/or serializers and/or
    configuration options, you could use the following (as seen in the ktor-samples):

    install(ContentNegotiation) {
        jackson {
            configure(SerializationFeature.INDENT_OUTPUT, true)
            registerModule(JavaTimeModule())

io.ktor.client.features.json.JacksonSerializer

java.util.jar.JarFile (extensions in package io.ktor.validator)

io.ktor.http.content.JarFileContent

Represents an OutgoingContent for a resource inside a Jar file

io.ktor.client.engine.jetty.Jetty

HttpClientEngineFactory using org.eclipse.jetty.http2:http2-client with the the associated configuration JettyEngineConfig.

io.ktor.server.jetty.Jetty

An ApplicationEngineFactory providing a Jetty-based ApplicationEngine

io.ktor.server.jetty.JettyApplicationCall

io.ktor.server.jetty.JettyApplicationEngine

ApplicationEngine implementation for running in a standalone Jetty

io.ktor.server.jetty.JettyApplicationEngineBase

ApplicationEngine base type for running in a standalone Jetty

io.ktor.server.jetty.JettyApplicationResponse

io.ktor.client.engine.jetty.JettyEngineConfig

Configuration for Jetty implementation of HttpClientEngineFactory.

io.ktor.client.engine.jetty.JettyEngineContainer

io.ktor.server.jetty.internal.JettyUpgradeImpl

kotlinx.coroutines.Job (extensions in package io.ktor.util)

kotlinx.coroutines.Job (extensions in package io.ktor.server.engine)

io.ktor.client.features.json.JsonFeature

HttpClient feature that serializes/de-serializes as JSON custom objects to request and from response bodies using a serializer.

io.ktor.client.features.json.JsonSerializer

Client json serializer.

io.ktor.client.features.json.tests.JsonTest

Base class for JSON tests.

java.security.KeyStore (extensions in package io.ktor.network.tls.certificates)

io.ktor.network.tls.certificates.KeyStoreBuilder

Builder for key store

kotlinx.metadata.jvm.KotlinClassMetadata (extensions in package io.ktor.validator)

io.ktor.client.features.json.serializer.KotlinxSerializer

A JsonSerializer implemented for kotlinx Serializable classes. Since serializers are determined statically, you must set the mapping for each Serializable class to it’s KSerializer manually, using setMapper or register.

io.ktor.util.KtorExperimentalAPI

API marked with this annotation is experimental and is not guaranteed to be stable.

io.ktor.locations.KtorExperimentalLocationsAPI

API marked with this annotation is experimental and is not guaranteed to be stable.

io.ktor.server.servlet.KtorServlet

A base class for servlet engine implementations

io.ktor.http.content.LastModifiedVersion

This version passes the given lastModified date through the client provided http conditional headers If-Modified-Since and If-Unmodified-Since.

io.ktor.http.LinkHeader

Represents a Link header value as per RFC 5988

kotlin.collections.List (extensions in package io.ktor.validator)

kotlin.collections.List (extensions in package io.ktor.client.features.cookies)

kotlin.collections.List (extensions in package io.ktor.client.tests.utils)

kotlin.collections.List (extensions in package io.ktor.sessions)

kotlin.collections.List (extensions in package io.ktor.http)

kotlin.collections.List (extensions in package io.ktor.features)

kotlin.collections.List (extensions in package io.ktor.util)

io.ktor.http.content.LocalFileContent

OutgoingContent representing a local file with a specified contentType, expires date and caching

io.ktor.locations.Location

Annotation for classes that will act as typed routes.

io.ktor.locations.LocationAttributeRouteService

Implements LocationRouteService by extracting routing information from a Location annotation.

io.ktor.locations.LocationRouteService

Provides services for extracting routing information from a location class.

io.ktor.locations.LocationRoutingException

Exception indicating that route parameters in curly brackets do not match class properties.

io.ktor.locations.Locations

EXPERIMENTAL Ktor feature that allows to handle and construct routes in a typed way.

io.ktor.util.Lock

io.ktor.util.LockTicket

io.ktor.client.features.logging.LogLevel

Logging log level.

io.ktor.client.features.logging.Logger

HttpClient Logger.

org.slf4j.Logger (extensions in package io.ktor.util)

io.ktor.client.features.logging.Logging

HttpClient logging feature.

kotlin.Long (extensions in package io.ktor.http)

kotlin.ranges.LongRange (extensions in package io.ktor.util)

io.ktor.config.MapApplicationConfig

Mutable application config backed by a hash map

io.ktor.validator.MemberBinarySignature

io.ktor.validator.MemberVisibility

io.ktor.client.features.logging.MessageLengthLimitingLogger

A Logger that breaks up log messages into multiple logs no longer than maxLength

io.ktor.validator.MethodBinarySignature

org.objectweb.asm.tree.MethodNode (extensions in package io.ktor.validator)

io.ktor.metrics.Metrics

Dropwizard metrics feature. Use DropwizardMetrics or instead.

io.ktor.metrics.micrometer.MicrometerMetrics

Enables Micrometer support when installed. Exposes the following metrics:

io.ktor.application.MissingApplicationFeatureException

Thrown when Application Feature has been attempted to be accessed but has not been installed before

io.ktor.features.MissingRequestParameterException

This exception is thrown when a required parameter with name parameterName is missing

io.ktor.client.engine.mock.MockEngine

HttpClientEngine for writing tests without network.

io.ktor.client.engine.mock.MockEngineConfig

HttpClientEngineConfig for MockEngine.

io.ktor.client.engine.mock.MockRequestHandler

Single HttpClientCall to HttpResponse mapper.

io.ktor.util.date.Month

Month value is 3 letter shortcut

io.ktor.http.content.MultiPartData

Represents a multipart data stream that could be received from a call

io.ktor.client.request.forms.MultiPartFormDataContent

OutgoingContent for multipart/form-data formatted request.

io.ktor.http.cio.MultipartEvent

Represents a multipart content starting event. Every part need to be completely consumed or released via release

io.ktor.client.tests.MultithreadedTest

io.ktor.mustache.Mustache

Feature for providing Mustache templates as MustacheContent

io.ktor.mustache.MustacheContent

Response content which could be used to respond ApplicationCalls like `call.respond(MustacheContent(…))

io.ktor.features.MutableOriginConnectionPoint

Represents a RequestConnectionPoint. Every it’s component is mutable so application features could provide them

io.ktor.http.cio.internals.MutableRange

Represents a text range with mutable bounds

io.ktor.network.tls.extensions.NamedCurve

Named curves for Elliptic Curves.

io.ktor.server.netty.Netty

An ApplicationEngineFactory providing a Netty-based ApplicationEngine

io.ktor.server.netty.NettyApplicationCall

io.ktor.server.netty.NettyApplicationEngine

ApplicationEngine implementation for running in a standalone Netty

io.ktor.server.netty.NettyApplicationRequest

io.ktor.server.netty.NettyApplicationRequestHeaders

io.ktor.server.netty.NettyApplicationResponse

io.ktor.server.netty.NettyCallPool

NioEventLoopGroup for processing ApplicationCall instances

io.ktor.server.netty.NettyChannelInitializer

A ChannelInitializer implementation that does setup the default ktor channel pipeline

io.ktor.server.netty.NettyConnectionPool

NioEventLoopGroup for accepting connections

io.ktor.server.netty.NettyWorkerPool

NioEventLoopGroup for processing incoming requests and doing engine’s internal work

io.ktor.network.tls.NoPrivateKeyException

Throws if failed to find PrivateKey for any alias in KeyStore.

io.ktor.client.call.NoTransformationFoundException

Exception representing the no transformation was found. It includes the received type and the expected type as part of the message.

io.ktor.util.NonceManager

Represents a nonce manager. It’s responsibility is to produce nonce values and verify nonce values from untrusted sources that they are provided by this manager. This is usually required in web environment to mitigate CSRF attacks. Depending on it’s underlying implementation it could be stateful or stateless. Note that there is usually some timeout for nonce values to reduce memory usage and to avoid replay attacks. Nonce length is unspecified.

io.ktor.util.cio.NoopContinuation

io.ktor.features.NotFoundException

This exception means that the requested resource is not found. HTTP status 404 Not found will be replied when this exception is thrown and not caught. 404 status page could be configured by registering a custom io.ktor.features.StatusPages handler.

io.ktor.auth.OAuth1aException

Represents an OAuth1a server error

io.ktor.auth.OAuth2Exception

Represents a error during communicating to OAuth2 server

io.ktor.auth.OAuth2RequestParameters

List of OAuth2 request parameters for both peers

io.ktor.auth.OAuth2ResponseParameters

List of OAuth2 server response parameters

io.ktor.auth.OAuth2StateProvider

Provides states for OAuth2. State could be just a random number (nonce) or could contain additional form fields or a signature. It is important that it should be a way to verify state. So all states need to be saved somehow or a state need to be a signed set of parameters that could be verified later

io.ktor.auth.OAuthAccessTokenResponse

OAuth access token acquired from the server

io.ktor.auth.OAuthAuthenticationProvider

Represents an OAuth provider for Authentication feature

io.ktor.auth.OAuthCallback

OAauth callback parameters

io.ktor.auth.OAuthGrantTypes

OAuth grant types constants

io.ktor.auth.OAuthServerSettings

Represents OAuth server settings

io.ktor.auth.OAuthVersion

OAuth versions used in configuration

io.ktor.client.engine.okhttp.OkHttp

HttpClientEngineFactory using a OkHttp based backend implementation with the the associated configuration OkHttpConfig.

io.ktor.client.engine.okhttp.OkHttpConfig

Configuration for OkHttp client engine.

io.ktor.client.engine.okhttp.OkHttpEngine

io.ktor.client.engine.okhttp.OkHttpEngineContainer

io.ktor.server.testing.On

on function receiver object

io.ktor.routing.OptionalParameterRouteSelector

Evaluates a route against an optional query parameter value and captures its value, if found

io.ktor.routing.OrRouteSelector

Evaluates a route as a result of the OR operation using two other selectors

io.ktor.http.content.OutgoingContent

Information about the content to be sent to the peer, recognized by a client or server engine

io.ktor.http.content.OutputStreamContent

OutgoingContent to respond with OutputStream. The stream would be automatically closed after body finish.

io.ktor.features.ParameterConversionException

This exception is thrown when a required parameter with name parameterName couldn’t be converted to the type

io.ktor.routing.ParameterRouteSelector

Evaluates a route against a query parameter value and captures its value

io.ktor.http.Parameters

Represents HTTP parameters as a map from case-insensitive names to collection of String values

io.ktor.http.ParametersBuilder

io.ktor.http.ParametersImpl

io.ktor.http.ParametersSingleImpl

io.ktor.http.cio.ParserException

An HTTP parser exception

io.ktor.http.content.PartData

Represents a multipart/form-data entry. Could be a FormItem or FileItem

io.ktor.features.PartialContent

Feature to support requests to specific content ranges.

java.nio.file.Path (extensions in package io.ktor.util)

java.nio.file.Path (extensions in package io.ktor.util.cio)

io.ktor.routing.PathSegmentConstantRouteSelector

Evaluates a route against a constant path segment

io.ktor.routing.PathSegmentOptionalParameterRouteSelector

Evaluates a route against an optional parameter path segment and captures its value, if any

io.ktor.routing.PathSegmentParameterRouteSelector

Evaluates a route against a parameter path segment and captures its value

io.ktor.routing.PathSegmentSelectorBuilder

Helper object for building instances of RouteSelector from path segments

io.ktor.routing.PathSegmentTailcardRouteSelector

Evaluates a route against any number of trailing path segments, and captures their values

io.ktor.routing.PathSegmentWildcardRouteSelector

Evaluates a route against any single path segment

io.ktor.util.pipeline.Pipeline

Represents an execution pipeline for asynchronous extensible computations

io.ktor.util.pipeline.PipelineContext

Represents running execution of a pipeline

io.ktor.util.pipeline.PipelineExecutor

Represent an object that launches pipeline execution

io.ktor.util.pipeline.PipelineInterceptor

Represents an interceptor type which is a suspend extension function for context

io.ktor.util.pipeline.PipelinePhase

Represents a phase in a pipeline

io.ktor.html.Placeholder

A placeholder that is inserted inside TOuter

io.ktor.html.PlaceholderItem

Item of a placeholder list when it is expanded

io.ktor.html.PlaceholderList

Placeholder that can appear multiple times

io.ktor.network.tls.extensions.PointFormat

Elliptic curve point format

io.ktor.client.tests.PostTest

io.ktor.auth.Principal

Marker interface indicating that a class represents an authenticated principal

io.ktor.http.RangeUnits

Possible content range units: bytes and none

io.ktor.http.RangesSpecifier

Range specifier for partial content requests (RFC 2616 sec 14.35.1)

io.ktor.http.cio.websocket.RawWebSocket

Represents a RAW web socket session

io.ktor.util.ReadWriteLock

io.ktor.network.sockets.ReadWriteSocket

Represents both readable and writable socket

java.nio.channels.ReadableByteChannel (extensions in package io.ktor.util)

io.ktor.client.call.ReceivePipelineException

Exception representing fail of the response pipeline cause contains origin pipeline exception

io.ktor.client.features.RedirectResponseException

Unhandled redirect exception.

io.ktor.features.RejectedCallIdException

An exception that could be thrown to reject a call due to illegal call id

io.ktor.http.cio.Request

Represents an HTTP request

io.ktor.http.RequestConnectionPoint

Represents request address information is used to make a call. There are at least two possible instances: “local” is how we see request at the server application and “actual” is what we can recover from proxy provided headers.

io.ktor.request.RequestCookies

Server request’s cookies

io.ktor.http.cio.RequestResponseBuilder

Builds an HTTP request or response

io.ktor.http.cio.Response

Represents an HTTP response

io.ktor.response.ResponseCookies

Server’s response cookies

io.ktor.client.features.ResponseException

Base for default response exceptions.

io.ktor.client.features.observer.ResponseHandler

ResponseObserver callback.

io.ktor.response.ResponseHeaders

Server’s response headers

io.ktor.client.features.observer.ResponseObserver

Observe response feature.

io.ktor.response.ResponsePushBuilder

HTTP/2 push builder interface

io.ktor.client.features.ResponseValidator

Response validator method.

io.ktor.routing.RootRouteSelector

The selector for routing root.

io.ktor.routing.Route

Describes a node in a routing tree

io.ktor.routing.RouteSelector

Base type for all routing selectors

io.ktor.routing.RouteSelectorEvaluation

Represents a result of a route evaluation against a call

io.ktor.routing.Routing

Root routing node for an Application

io.ktor.routing.RoutingApplicationCall

Represents an application call being handled by Routing

io.ktor.routing.RoutingApplicationRequest

Represents an application request being handled by Routing

io.ktor.routing.RoutingApplicationResponse

Represents an application response being handled by Routing

io.ktor.routing.RoutingPath

Represents a parsed routing path. Consist of number of segments parts

io.ktor.routing.RoutingPathSegment

Represent a single routing path segment

io.ktor.routing.RoutingPathSegmentKind

Possible routing path segment kinds

io.ktor.routing.RoutingResolveContext

Represents a context in which routing resolution is being performed

io.ktor.routing.RoutingResolveResult

Represents a result of routing resolution.

io.ktor.routing.RoutingResolveTrace

Represents the trace of routing resolution process for diagnostics.

io.ktor.routing.RoutingResolveTraceEntry

Represents a single entry in the RoutingResolveTrace.

io.ktor.network.tls.SecretExchangeType

TLS secret key exchange type.

io.ktor.network.selector.SelectInterest

Select interest kind

io.ktor.network.selector.Selectable

A selectable entity with selectable NIO channel, interestedOps subscriptions

io.ktor.network.selector.SelectorManager

Selector manager is a service that manages NIO selectors and selection threads

io.ktor.network.selector.SelectorManagerSupport

Base class for NIO selector managers

io.ktor.util.cio.Semaphore

Asynchronous Semaphore.

io.ktor.client.tests.cio.SemaphoreTest

io.ktor.client.features.SendCountExceedException

Thrown when too many actual requests were sent during a client call. It could be caused by infinite or too long redirect sequence. Maximum number of requests is limited by HttpSend.maxSendCount

io.ktor.client.features.Sender

This interface represents a request send pipeline interceptor chain

kotlin.sequences.Sequence (extensions in package io.ktor.validator)

io.ktor.http.cio.websocket.Serializer

io.ktor.network.tls.ServerKeyExchangeType

Server key exchange type with it’s code

io.ktor.client.features.ServerResponseException

Server error exception.

io.ktor.network.sockets.ServerSocket

Represents a server bound socket ready for accepting connections

io.ktor.server.servlet.ServletApplicationEngine

This servlet need to be installed into a servlet container

io.ktor.server.servlet.ServletApplicationRequest

io.ktor.server.servlet.ServletApplicationRequestCookies

io.ktor.server.servlet.ServletApplicationRequestHeaders

io.ktor.server.servlet.ServletApplicationResponse

io.ktor.server.servlet.ServletUpgrade

Servlet upgrade processing

io.ktor.server.servlet.ServletUpgradeHandler

io.ktor.auth.SessionAuthChallenge

Specifies what to send back if form authentication fails.

io.ktor.auth.SessionAuthenticationProvider

Represents a session-based authentication provider

io.ktor.sessions.SessionProvider

Specifies a provider for a session with the specific name and type

io.ktor.sessions.SessionSerializer

Serializes session from and to String

io.ktor.sessions.SessionSerializerReflection

Default reflection-based session serializer that does it via reflection. Serialized format is textual and optimized for size as it is could be transferred via HTTP headers or cookies

io.ktor.sessions.SessionStorage

Represents a way to write, read and invalidate session bits.

io.ktor.sessions.SessionStorageMemory

SessionStorage that stores session contents into memory.

io.ktor.sessions.SessionTracker

SessionTracker provides ability to track and extract session from the call context.

io.ktor.sessions.SessionTrackerById

SessionTracker that transfers a Session Id generated by a sessionIdProvider in HTTP Headers/Cookies. It uses a storage and a serializer to store/load serialized/deserialized session content of a specific type.

io.ktor.sessions.SessionTrackerByValue

SessionTracker that stores the contents of the session as part of HTTP Cookies/Headers. It uses a specific serializer to serialize and deserialize objects of type type.

io.ktor.sessions.SessionTransport

SessionTransport receive, send or clear a session from/to an ApplicationCall.

io.ktor.sessions.SessionTransportCookie

SessionTransport that adds a Set-Cookie header and reads Cookie header for the specified cookie name, and a specific cookie configuration after applying/un-applying the specified transforms defined by transformers.

io.ktor.sessions.SessionTransportHeader

SessionTransport that sets or gets the specific header name, applying/un-applying the specified transforms defined by transformers.

io.ktor.sessions.SessionTransportTransformer

Represents a session cookie transformation. Useful for such things like signing and encryption

io.ktor.sessions.SessionTransportTransformerDigest

Session transformer that appends an algorithm hash of the input. Where the input is either a session contents or a previous transformation. It prepends a salt when computing the hash.

io.ktor.sessions.SessionTransportTransformerEncrypt

Session transformer that encrypts/decrypts the input.

io.ktor.sessions.SessionTransportTransformerMessageAuthentication

Session transformer that appends an algorithm MAC (Message Authentication Code) hash of the input. Where the input is either a session contents or a previous transformation. It uses a specified keySpec when generating the Mac hash.

io.ktor.sessions.Sessions

Sessions reature that provides a mechanism to persist information between requests.

kotlin.collections.Set (extensions in package io.ktor.util)

io.ktor.server.engine.ShutDownUrl

Shutdown URL feature. It stops application when requested particular url

io.ktor.network.tls.extensions.SignatureAlgorithm

Signature algorithms

io.ktor.http.cio.websocket.SimpleFrameCollector

io.ktor.network.sockets.Socket

Represents a connected socket

io.ktor.network.sockets.SocketBuilder

Socket builder

io.ktor.network.sockets.SocketOptions

Socket options builder

io.ktor.util.StatelessHmacNonceManager

Stateless nonce manager implementation with HMAC verification and timeout. Every nonce provided by this manager consist of a random part, timestamp and HMAC.

io.ktor.features.StatusPages

Status pages feature that handles exceptions and status codes. Useful to configure default error pages.

io.ktor.server.testing.StressSuiteRunner

kotlin.String (extensions in package io.ktor.http)

kotlin.String (extensions in package io.ktor.util)

io.ktor.util.StringValues

Provides data structure for associating a String with a List of Strings

io.ktor.util.StringValuesBuilder

io.ktor.util.StringValuesImpl

io.ktor.util.StringValuesSingleImpl

io.ktor.network.tls.TLSAlertLevel

TLS alert level

io.ktor.network.tls.TLSAlertType

TLS alert types with codes

io.ktor.network.tls.TLSConfig

TLS configuration.

io.ktor.network.tls.TLSConfigBuilder

TLSConfig builder.

io.ktor.network.tls.TLSHandshakeType

TLS handshake record type

io.ktor.network.tls.TLSRecordType

TLS record type with it’s numeric code

io.ktor.network.tls.TLSVersion

TLS version

io.ktor.network.sockets.TcpSocketBuilder

TCP socket builder

io.ktor.html.Template

A template that expands inside TOuter

io.ktor.html.TemplatePlaceholder

A placeholder that is also a template

java.time.temporal.Temporal (extensions in package io.ktor.http)

io.ktor.server.testing.TestApplicationCall

Represents a test application call that is used in withTestApplication and handleRequest

io.ktor.server.testing.TestApplicationEngine

ktor test engine that provides way to simulate application calls to existing application module(s) without actual HTTP connection

io.ktor.server.testing.TestApplicationRequest

Represents a test application request

io.ktor.server.testing.TestApplicationResponse

Represents test call response received from server

io.ktor.client.tests.utils.TestClientBuilder

io.ktor.server.testing.TestEngine

An ApplicationEngineFactory providing a CIO-based ApplicationEngine

io.ktor.server.testing.client.TestHttpClientConfig

io.ktor.server.testing.client.TestHttpClientEngine

io.ktor.client.tests.utils.TestWithKtor

io.ktor.content.TextContent

io.ktor.http.content.TextContent

Represents a text content that could be sent

io.ktor.thymeleaf.Thymeleaf

Thymeleaf support feature. Provides ability to respond with Thymeleaf

io.ktor.thymeleaf.ThymeleafContent

Represents a content handled by Thymeleaf feature.

io.ktor.server.tomcat.Tomcat

An ApplicationEngineFactory providing a Tomcat-based ApplicationEngine

io.ktor.server.tomcat.TomcatApplicationEngine

Tomcat application engine that runs it in embedded mode

io.ktor.sessions.TooLateSessionSetException

This exception is thrown when HTTP response has been already sent but an attempt to modify session is made

io.ktor.client.call.Type

Information about type.

io.ktor.client.call.TypeInfo

Ktor type information.

io.ktor.network.sockets.TypeOfService

An inline class to hold a IP ToS value

io.ktor.network.sockets.UDPSocketBuilder

UDP socket builder

io.ktor.http.content.URIFileContent

Represents a content that is served from the specified uri

io.ktor.http.URLBuilder

A URL builder with all mutable components

io.ktor.http.URLDecodeException

URL decoder exception

io.ktor.http.URLParserException

Thrown when failed to parse URL

io.ktor.http.URLProtocol

Represents URL protocol

io.ktor.auth.UnauthorizedResponse

Response content with 401 Unauthorized status code and WWW-Authenticate header of supplied challenges

io.ktor.http.UnsafeHeaderException

Thrown when an attempt to set unsafe header detected. A header is unsafe if listed in HttpHeaders.UnsafeHeaders.

io.ktor.client.features.compression.UnsupportedContentEncodingException

io.ktor.client.call.UnsupportedContentTypeException

io.ktor.client.engine.okhttp.UnsupportedFrameTypeException

io.ktor.features.UnsupportedMediaTypeException

Thrown when there is no conversion for a content type configured. HTTP status 415 Unsupported Media Type will be replied when this exception is thrown and not caught.

io.ktor.client.call.UnsupportedUpgradeProtocolException

io.ktor.server.servlet.UpgradeRequest

io.ktor.http.Url

Represents an immutable URL

io.ktor.client.features.UserAgent

Default user-agent feature for HttpClient.

io.ktor.auth.UserHashedTableAuth

Simple in-memory table that keeps user names and password hashes

io.ktor.auth.UserIdPrincipal

Represents a simple user’s principal identified by name

io.ktor.auth.UserPasswordCredential

Represents a simple user name and password credential pair

io.ktor.velocity.Velocity

Velocity ktor feature. Provides ability to respond with VelocityContent and respondTemplate.

io.ktor.velocity.VelocityContent

Represents a response content that could be used to respond with call.respond(VelocityContent(...))

io.ktor.http.content.Version

Represents content version

io.ktor.http.content.VersionCheckResult

Represent result of the version comparison between content being sent and HTTP request.

io.ktor.http.cio.internals.WeakTimeoutQueue

It provides ability to cancel jobs and schedule coroutine with timeout. Unlike regular withTimeout this implementation is never scheduling timer tasks but only checks for current time. This makes timeout measurement much cheaper and doesn’t require any watchdog thread.

io.ktor.server.servlet.WebResourcesConfig

Web resources serve configuration

io.ktor.client.features.websocket.WebSocketException

io.ktor.http.cio.websocket.WebSocketInternalAPI

API marked with this annotation is internal and not intended to be used outside of ktor It is not recommended to use it as it may be changed in the future without notice or it may be too low-level so could damage your data.

io.ktor.http.cio.websocket.WebSocketReader

Class that continuously reads a byteChannel and converts into Websocket Frame exposing them in incoming.

io.ktor.websocket.WebSocketServerSession

Represents a server-side web socket session

io.ktor.http.cio.websocket.WebSocketSession

Represents a web socket session between two peers

io.ktor.websocket.WebSocketUpgrade

An OutgoingContent response object that could be used to respond(): it will cause application engine to perform HTTP upgrade and start websocket RAW session.

io.ktor.http.cio.websocket.WebSocketWriter

Class that processes written outgoing Websocket Frame, serializes them and writes the bits into the writeChannel.

io.ktor.client.features.websocket.WebSockets

Client WebSocket feature.

io.ktor.websocket.WebSockets

WebSockets support feature. It is required to be installed first before binding any websocket endpoints

io.ktor.webjars.Webjars

io.ktor.util.date.WeekDay

Day of week value is 3 letter shortcut

java.nio.channels.WritableByteChannel (extensions in package io.ktor.util)

io.ktor.http.content.WriterContent

Represents a content that is produced by body function

io.ktor.server.netty.cio.WriterEncapsulation

io.ktor.features.XForwardedHeaderSupport

X-Forwarded-* headers support See http://ktor.io/servers/features/forward-headers.html for details

java.time.ZonedDateTime (extensions in package io.ktor.util.date)