- cacheControl($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
- cacheControl($receiver, value) - Static method in class io.ktor.response.ApplicationResponsePropertiesKt
-
- cacheControl($receiver, value) - Static method in class io.ktor.response.ApplicationResponsePropertiesKt
-
- CachingHeaders - Class in io.ktor.features
-
- CachingHeaders(optionsProviders) - Constructor for class io.ktor.features.CachingHeaders
-
- CachingHeaders.Configuration - Class in io.ktor.features
-
- CachingHeaders.Feature - Class in io.ktor.features
-
- CachingOptions - Class in io.ktor.content
-
Specifies caching properties for an OutgoingContent such as Cache-Control or Expires
- CachingOptions(cacheControl, expires) - Constructor for class io.ktor.content.CachingOptions
-
Specifies caching properties for an OutgoingContent such as Cache-Control or Expires
- CachingOptions() - Constructor for class io.ktor.content.CachingOptions
-
Specifies caching properties for an OutgoingContent such as Cache-Control or Expires
- CachingOptionsKt - Class in io.ktor.content
-
- CallLogging - Class in io.ktor.features
-
Logs application lifecycle and call events.
- CallLogging(log, monitor, level, filters) - Constructor for class io.ktor.features.CallLogging
-
Logs application lifecycle and call events.
- CallLogging.Configuration - Class in io.ktor.features
-
- CallLogging.Feature - Class in io.ktor.features
-
- CallLoggingKt - Class in io.ktor.features
-
- check(call) - Method in class io.ktor.content.EntityTagVersion
-
- check(call) - Method in class io.ktor.content.LastModifiedVersion
-
- check(call) - Method in interface io.ktor.content.Version
-
- clear(name) - Method in interface io.ktor.sessions.CurrentSession
-
- clear(call, $continuation) - Method in interface io.ktor.sessions.SessionTracker
-
Clear session information
- clear(call, $continuation) - Method in class io.ktor.sessions.SessionTrackerById
-
Clear session information
- clear(call, $continuation) - Method in class io.ktor.sessions.SessionTrackerByValue
-
Clear session information
- clear(call) - Method in interface io.ktor.sessions.SessionTransport
-
- clear(call) - Method in class io.ktor.sessions.SessionTransportCookie
-
- clear(call) - Method in class io.ktor.sessions.SessionTransportHeader
-
- Companion - Static variable in class io.ktor.features.CORS.Configuration
-
- Companion - Static variable in class io.ktor.routing.RouteSelectorEvaluation
-
- Companion - Static variable in class io.ktor.routing.RoutingPath
-
- completeShutdown() - Method in class io.ktor.util.DispatcherWithShutdown
-
- component1() - Method in class io.ktor.content.CachingOptions
-
- component1() - Method in class io.ktor.content.EntityTagVersion
-
- component1() - Method in class io.ktor.content.LastModifiedVersion
-
- component1() - Method in class io.ktor.features.CompressionEncoderConfig
-
Name of the encoder,
- component1() - Method in class io.ktor.features.CompressionOptions
-
Map of encoder configurations
- component1() - Method in class io.ktor.features.ContentNegotiation.ConverterRegistration
-
- component1() - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- component1() - Method in class io.ktor.routing.AndRouteSelector
-
- component1() - Method in class io.ktor.routing.ConstantParameterRouteSelector
-
- component1() - Method in class io.ktor.routing.HttpAcceptRouteSelector
-
- component1() - Method in class io.ktor.routing.HttpHeaderRouteSelector
-
- component1() - Method in class io.ktor.routing.HttpMethodRouteSelector
-
- component1() - Method in class io.ktor.routing.OptionalParameterRouteSelector
-
- component1() - Method in class io.ktor.routing.OrRouteSelector
-
- component1() - Method in class io.ktor.routing.ParameterRouteSelector
-
- component1() - Method in class io.ktor.routing.PathSegmentConstantRouteSelector
-
- component1() - Method in class io.ktor.routing.PathSegmentOptionalParameterRouteSelector
-
- component1() - Method in class io.ktor.routing.PathSegmentParameterRouteSelector
-
- component1() - Method in class io.ktor.routing.PathSegmentTailcardRouteSelector
-
- component1() - Method in class io.ktor.routing.RouteSelectorEvaluation
-
- component1() - Method in class io.ktor.routing.RoutingPathSegment
-
- component1() - Method in class io.ktor.routing.RoutingResolveResult
-
- component2() - Method in class io.ktor.content.CachingOptions
-
- component2() - Method in class io.ktor.features.CompressionEncoderConfig
-
Encoder implementation
- component2() - Method in class io.ktor.features.CompressionOptions
-
Conditions for all encoders
- component2() - Method in class io.ktor.features.ContentNegotiation.ConverterRegistration
-
- component2() - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- component2() - Method in class io.ktor.routing.AndRouteSelector
-
- component2() - Method in class io.ktor.routing.ConstantParameterRouteSelector
-
- component2() - Method in class io.ktor.routing.HttpHeaderRouteSelector
-
- component2() - Method in class io.ktor.routing.OrRouteSelector
-
- component2() - Method in class io.ktor.routing.PathSegmentOptionalParameterRouteSelector
-
- component2() - Method in class io.ktor.routing.PathSegmentParameterRouteSelector
-
- component2() - Method in class io.ktor.routing.RouteSelectorEvaluation
-
- component2() - Method in class io.ktor.routing.RoutingPathSegment
-
- component2() - Method in class io.ktor.routing.RoutingResolveResult
-
- component3() - Method in class io.ktor.features.CompressionEncoderConfig
-
Conditions for the encoder
- component3() - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- component3() - Method in class io.ktor.routing.PathSegmentOptionalParameterRouteSelector
-
- component3() - Method in class io.ktor.routing.PathSegmentParameterRouteSelector
-
- component3() - Method in class io.ktor.routing.RouteSelectorEvaluation
-
- component3() - Method in class io.ktor.routing.RoutingResolveResult
-
- component4() - Method in class io.ktor.features.CompressionEncoderConfig
-
Priority of the encoder
- component4() - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- component4() - Method in class io.ktor.routing.RouteSelectorEvaluation
-
- component4() - Method in class io.ktor.routing.RoutingResolveResult
-
- component5() - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- compress(readChannel) - Method in interface io.ktor.features.CompressionEncoder
-
Wraps readChannel into a compressing ByteReadChannel
- compress(writeChannel) - Method in interface io.ktor.features.CompressionEncoder
-
Wraps writeChannel into a compressing ByteWriteChannel
- compress(readChannel) - Method in class io.ktor.features.DeflateEncoder
-
Wraps readChannel into a compressing ByteReadChannel
- compress(writeChannel) - Method in class io.ktor.features.DeflateEncoder
-
Wraps writeChannel into a compressing ByteWriteChannel
- compress(readChannel) - Method in class io.ktor.features.GzipEncoder
-
Wraps readChannel into a compressing ByteReadChannel
- compress(writeChannel) - Method in class io.ktor.features.GzipEncoder
-
Wraps writeChannel into a compressing ByteWriteChannel
- compress(readChannel) - Method in class io.ktor.features.IdentityEncoder
-
Wraps readChannel into a compressing ByteReadChannel
- compress(writeChannel) - Method in class io.ktor.features.IdentityEncoder
-
Wraps writeChannel into a compressing ByteWriteChannel
- Compression - Class in io.ktor.features
-
Feature to compress a response based on conditions and ability of client to decompress it
- Compression(compression) - Constructor for class io.ktor.features.Compression
-
Feature to compress a response based on conditions and ability of client to decompress it
- Compression.Configuration - Class in io.ktor.features
-
Configuration builder for Compression feature
- Compression.Feature - Class in io.ktor.features
-
- CompressionEncoder - Interface in io.ktor.features
-
Represents a Compression encoder
- CompressionEncoderBuilder - Class in io.ktor.features
-
Builder for compression encoder configuration
- CompressionEncoderConfig - Class in io.ktor.features
-
Configuration for an encoder
- CompressionEncoderConfig(name, encoder, conditions, priority) - Constructor for class io.ktor.features.CompressionEncoderConfig
-
Configuration for an encoder
- CompressionKt - Class in io.ktor.features
-
- CompressionOptions - Class in io.ktor.features
-
Compression feature configuration
- CompressionOptions(encoders, conditions) - Constructor for class io.ktor.features.CompressionOptions
-
Compression feature configuration
- CompressionOptions() - Constructor for class io.ktor.features.CompressionOptions
-
Compression feature configuration
- condition($receiver, predicate) - Static method in class io.ktor.features.CompressionKt
-
Appends a custom condition to the encoder or Compression configuration
- ConditionalHeaders - Class in io.ktor.features
-
Feature to check modified/match conditional headers and avoid sending contents if it was not changed
- ConditionalHeaders(versionProviders) - Constructor for class io.ktor.features.ConditionalHeaders
-
Feature to check modified/match conditional headers and avoid sending contents if it was not changed
- ConditionalHeaders.Configuration - Class in io.ktor.features
-
- ConditionalHeaders.Feature - Class in io.ktor.features
-
- ConditionalHeadersKt - Class in io.ktor.features
-
- ConditionsHolderBuilder - Interface in io.ktor.features
-
Represents a builder for conditions
- config(path) - Method in interface io.ktor.config.ApplicationConfig
-
- config(path) - Method in class io.ktor.config.HoconApplicationConfig
-
- config(path) - Method in class io.ktor.config.MapApplicationConfig
-
- Config() - Constructor for class io.ktor.features.XForwardedHeadersSupport.Config
-
- configList(path) - Method in interface io.ktor.config.ApplicationConfig
-
- configList(path) - Method in class io.ktor.config.HoconApplicationConfig
-
- configList(path) - Method in class io.ktor.config.MapApplicationConfig
-
- Configuration() - Constructor for class io.ktor.features.CachingHeaders.Configuration
-
- Configuration() - Constructor for class io.ktor.features.CallLogging.Configuration
-
- Configuration() - Constructor for class io.ktor.features.Compression.Configuration
-
Configuration builder for Compression feature
- Configuration() - Constructor for class io.ktor.features.ConditionalHeaders.Configuration
-
- Configuration() - Constructor for class io.ktor.features.ContentNegotiation.Configuration
-
- Configuration() - Constructor for class io.ktor.features.CORS.Configuration
-
- Configuration() - Constructor for class io.ktor.features.DataConversion.Configuration
-
- Configuration() - Constructor for class io.ktor.features.DefaultHeaders.Configuration
-
- Configuration() - Constructor for class io.ktor.features.HSTS.Configuration
-
- Configuration() - Constructor for class io.ktor.features.HttpsRedirect.Configuration
-
- Configuration() - Constructor for class io.ktor.features.PartialContent.Configuration
-
- Configuration() - Constructor for class io.ktor.features.StatusPages.Configuration
-
- Configuration() - Constructor for class io.ktor.sessions.Sessions.Configuration
-
- Configuration.Companion - Class in io.ktor.features
-
- ConstantParameterRouteSelector - Class in io.ktor.routing
-
Evaluates a route against a constant query parameter value
- ConstantParameterRouteSelector(name, value) - Constructor for class io.ktor.routing.ConstantParameterRouteSelector
-
Evaluates a route against a constant query parameter value
- contains(name) - Method in class io.ktor.response.ResponseHeaders
-
- contentCharset($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
- ContentConverter - Interface in io.ktor.features
-
A custom content converted that could be registered in
class 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
- contentLength($receiver, length) - Static method in class io.ktor.response.ApplicationResponsePropertiesKt
-
- ContentNegotiation - Class in io.ktor.features
-
This feature provides automatic content conversion according to Content-Type and Accept headers
- ContentNegotiation(registrations) - Constructor for class io.ktor.features.ContentNegotiation
-
This feature provides automatic content conversion according to Content-Type and Accept headers
- ContentNegotiation.Configuration - Class in io.ktor.features
-
- ContentNegotiation.ConverterRegistration - Class in io.ktor.features
-
Specifies which converter to use for a particular contentType
- ContentNegotiation.Feature - Class in io.ktor.features
-
- ContentNegotiationKt - Class in io.ktor.features
-
- contentRange($receiver, range, fullLength, unit) - Static method in class io.ktor.response.ApplicationResponsePropertiesKt
-
- contentRange($receiver, range, fullLength, unit) - Static method in class io.ktor.response.ApplicationResponsePropertiesKt
-
- contentRange($receiver, range, fullLength, unit) - Static method in class io.ktor.response.ApplicationResponsePropertiesKt
-
- ContentTransformationException - Exception in io.ktor.request
-
- ContentTransformationException(message) - Constructor for exception io.ktor.request.ContentTransformationException
-
- contentType($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
- contentType($receiver, value) - Static method in class io.ktor.response.ApplicationResponsePropertiesKt
-
- contentType($receiver, value) - Static method in class io.ktor.response.ApplicationResponsePropertiesKt
-
- contentType($receiver, contentType, build) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match requests with HttpHeaders.ContentType header matching specified contentType
- ConversionService - Interface in io.ktor.util
-
- convert(klass, convertor) - Method in class io.ktor.features.DataConversion.Configuration
-
- convert(ktype, convertor) - Method in class io.ktor.features.DataConversion.Configuration
-
- convert(klass, configure) - Method in class io.ktor.features.DataConversion.Configuration
-
- ConverterRegistration(contentType, converter) - Constructor for class io.ktor.features.ContentNegotiation.ConverterRegistration
-
Specifies which converter to use for a particular contentType
- convertForReceive(context, $continuation) - Method in interface io.ktor.features.ContentConverter
-
Convert a value (RAW or intermediate) from receive pipeline (deserialize)
- convertForSend(context, contentType, value, $continuation) - Method in interface io.ktor.features.ContentConverter
-
Convert a value to the specified contentType to a value suitable for sending (serialize).
Note that as far as
interface ContentConverter could be registered multiple times with different content types
hence contentType could be different depends on what the client accepts (inferred from Accept header).
This function could ignore value if it is not suitable for conversion and return
null so in this case
other registered converters could be tried or this function could be invoked with other content types
it the converted has been registered multiple times with different content types
- cookie($receiver, name, sessionType, storage) - Static method in class io.ktor.sessions.SessionsBuilderKt
-
- cookie($receiver, name, sessionType, storage, block) - Static method in class io.ktor.sessions.SessionsBuilderKt
-
- cookie($receiver, name, sessionType) - Static method in class io.ktor.sessions.SessionsBuilderKt
-
- cookie($receiver, name, sessionType, block) - Static method in class io.ktor.sessions.SessionsBuilderKt
-
- CookieConfiguration - Class in io.ktor.sessions
-
- CookieConfiguration() - Constructor for class io.ktor.sessions.CookieConfiguration
-
- CookieIdSessionBuilder<S> - Class in io.ktor.sessions
-
- CookieIdSessionBuilder(type) - Constructor for class io.ktor.sessions.CookieIdSessionBuilder
-
- CookieSessionBuilder<S> - Class in io.ktor.sessions
-
- CookieSessionBuilder(type) - Constructor for class io.ktor.sessions.CookieSessionBuilder
-
- copy(cacheControl, expires) - Method in class io.ktor.content.CachingOptions
-
Specifies caching properties for an OutgoingContent such as Cache-Control or Expires
- copy(etag) - Method in class io.ktor.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
enum VersionCheckResult
- copy(lastModified) - Method in class io.ktor.content.LastModifiedVersion
-
This version passes the given lastModified date through the client provided
http conditional headers If-Modified-Since and If-Unmodified-Since.
- copy(name, encoder, conditions, priority) - Method in class io.ktor.features.CompressionEncoderConfig
-
Configuration for an encoder
- copy(encoders, conditions) - Method in class io.ktor.features.CompressionOptions
-
Compression feature configuration
- copy(contentType, converter) - Method in class io.ktor.features.ContentNegotiation.ConverterRegistration
-
Specifies which converter to use for a particular contentType
- copy(host, by, forParam, proto, others) - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- copy(first, second) - Method in class io.ktor.routing.AndRouteSelector
-
Evaluates a route as a result of the AND operation using two other selectors
- copy(name, value) - Method in class io.ktor.routing.ConstantParameterRouteSelector
-
Evaluates a route against a constant query parameter value
- copy(contentType) - Method in class io.ktor.routing.HttpAcceptRouteSelector
-
Evaluates a route against a content-type in the HttpHeaders.Accept header in the request
- copy(name, value) - Method in class io.ktor.routing.HttpHeaderRouteSelector
-
Evaluates a route against a header in the request
- copy(method) - Method in class io.ktor.routing.HttpMethodRouteSelector
-
Evaluates a route against an HttpMethod
- copy(name) - Method in class io.ktor.routing.OptionalParameterRouteSelector
-
Evaluates a route against an optional query parameter value and captures its value, if found
- copy(first, second) - Method in class io.ktor.routing.OrRouteSelector
-
Evaluates a route as a result of the OR operation using two other selectors
- copy(name) - Method in class io.ktor.routing.ParameterRouteSelector
-
Evaluates a route against a query parameter value and captures its value
- copy(value) - Method in class io.ktor.routing.PathSegmentConstantRouteSelector
-
Evaluates a route against a constant path segment
- copy(name, prefix, suffix) - Method in class io.ktor.routing.PathSegmentOptionalParameterRouteSelector
-
Evaluates a route against an optional parameter path segment and captures its value, if any
- copy(name, prefix, suffix) - Method in class io.ktor.routing.PathSegmentParameterRouteSelector
-
Evaluates a route against a parameter path segment and captures its value
- copy(name) - Method in class io.ktor.routing.PathSegmentTailcardRouteSelector
-
Evaluates a route against any number of trailing path segments, and captures their values
- copy(succeeded, quality, parameters, segmentIncrement) - Method in class io.ktor.routing.RouteSelectorEvaluation
-
Represents a result of a route evaluation against a call
- copy(value, kind) - Method in class io.ktor.routing.RoutingPathSegment
-
- copy(succeeded, route, parameters, quality) - Method in class io.ktor.routing.RoutingResolveResult
-
Represents a result of routing resolution
- CORS - Class in io.ktor.features
-
- CORS(configuration) - Constructor for class io.ktor.features.CORS
-
- CORS.Configuration - Class in io.ktor.features
-
- CORS.Feature - Class in io.ktor.features
-
- createChild(selector) - Method in class io.ktor.routing.Route
-
Creates a child node in this node with a given selector or returns an existing one with the same selector
- createFromCall($receiver, call) - Static method in class io.ktor.util.URLBuilderKt
-
- createRouteFromPath($receiver, path) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Create a routing entry for specified path
- CurrentSession - Interface in io.ktor.sessions
-
- generateCertificate(file, algorithm, keyAlias, keyPassword, jksPassword) - Static method in class io.ktor.util.SSLKt
-
Generates simple self-signed certificate with keyAlias name, private key is encrypted with keyPassword,
and a JKS keystore to hold it in file with jksPassword.
- get(name, encoding) - Method in class io.ktor.request.RequestCookies
-
- get(name) - Method in class io.ktor.response.ResponseCookies
-
- get(name) - Method in class io.ktor.response.ResponseHeaders
-
- get($receiver, path, body) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match GET requests with specified path
- get($receiver, body) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match GET requests
- get(name) - Method in interface io.ktor.sessions.CurrentSession
-
- getAfter() - Method in class io.ktor.request.ApplicationReceivePipeline.Phases
-
- getAfter() - Method in class io.ktor.response.ApplicationSendPipeline.Phases
-
The latest application phase that happens right before engine will send the response
- getAlgorithm() - Method in class io.ktor.sessions.SessionTransportTransformerDigest
-
- getAlgorithm() - Method in class io.ktor.sessions.SessionTransportTransformerMessageAuthentication
-
- getAllHeaders() - Method in class io.ktor.features.CORS
-
- getAllowCredentials() - Method in class io.ktor.features.CORS.Configuration
-
- getAllowCredentials() - Method in class io.ktor.features.CORS
-
- getAllowsAnyHost() - Method in class io.ktor.features.CORS
-
- getApplication() - Method in interface io.ktor.application.ApplicationCall
-
Application being called
- getApplication($receiver) - Static method in class io.ktor.application.ApplicationCallPipelineKt
-
Current application for the context
- getApplication() - Method in class io.ktor.routing.Routing
-
- getApplication() - Method in class io.ktor.routing.RoutingApplicationCall
-
Application being called
- getApplication($receiver) - Static method in class io.ktor.routing.RoutingKt
-
- getApplicationStarted() - Static method in class io.ktor.application.ApplicationEnvironmentKt
-
Even definition for Application Started event
- getApplicationStarting() - Static method in class io.ktor.application.ApplicationEnvironmentKt
-
Even definition for Application Starting event
- getApplicationStopped() - Static method in class io.ktor.application.ApplicationEnvironmentKt
-
Even definition for Application Stopped event
- getApplicationStopping() - Static method in class io.ktor.application.ApplicationEnvironmentKt
-
Even definition for Application Stopping event
- getApplicationStopPreparing() - Static method in class io.ktor.application.ApplicationEnvironmentKt
-
- getAttributes() - Method in interface io.ktor.application.ApplicationCall
-
Attributes attached to this instance
- getAttributes() - Method in class io.ktor.routing.RoutingApplicationCall
-
Attributes attached to this instance
- getBefore() - Method in class io.ktor.request.ApplicationReceivePipeline.Phases
-
- getBefore() - Method in class io.ktor.response.ApplicationSendPipeline.Phases
-
The earliest phase that happens before any other
- getBy() - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- getCacheControl() - Method in class io.ktor.content.CachingOptions
-
- getCaching($receiver) - Static method in class io.ktor.content.CachingOptionsKt
-
Gets or sets CacheControl instance as an extension property on this content
- getCachingProperty() - Static method in class io.ktor.content.CachingOptionsKt
-
Specifies a key for CacheControl extension property for OutgoingContent
- getCall() - Method in class io.ktor.application.ApplicationCallPipeline.ApplicationPhase
-
Phase for processing a call and sending a response
- getCall($receiver) - Static method in class io.ktor.application.ApplicationCallPipelineKt
-
Current call for the context
- getCall() - Method in interface io.ktor.request.ApplicationRequest
-
- getCall() - Method in interface io.ktor.response.ApplicationResponse
-
- getCall() - Method in class io.ktor.routing.RoutingApplicationRequest
-
- getCall() - Method in class io.ktor.routing.RoutingApplicationResponse
-
- getCall() - Method in class io.ktor.routing.RoutingResolveContext
-
- getChildren() - Method in class io.ktor.routing.Route
-
List of child routes for this node
- getClassLoader() - Method in interface io.ktor.application.ApplicationEnvironment
-
ClassLoader used to load application.
- getConditions() - Method in class io.ktor.features.Compression.Configuration
-
- getConditions() - Method in class io.ktor.features.CompressionEncoderBuilder
-
List of conditions for this encoder
- getConditions() - Method in class io.ktor.features.CompressionEncoderConfig
-
Conditions for the encoder
- getConditions() - Method in class io.ktor.features.CompressionOptions
-
Conditions for all encoders
- getConditions() - Method in interface io.ktor.features.ConditionsHolderBuilder
-
- getConfig() - Method in interface io.ktor.application.ApplicationEnvironment
-
- getConfiguration() - Method in class io.ktor.sessions.SessionTransportCookie
-
- getConstant() - Method in class io.ktor.routing.RouteSelectorEvaluation.Companion
-
Route evaluation succeeded for a constant value
- getConstantPath() - Method in class io.ktor.routing.RouteSelectorEvaluation.Companion
-
Route evaluation succeeded for a single path segment with a constant value
- getContentEncoding() - Method in class io.ktor.response.ApplicationSendPipeline.Phases
-
Phase for processing Content-Encoding, like compression and partial content
- getContentLength() - Method in class io.ktor.content.JarFileContent
-
- getContentLength() - Method in class io.ktor.content.LocalFileContent
-
- getContentType() - Method in class io.ktor.content.JarFileContent
-
- getContentType() - Method in class io.ktor.content.LocalFileContent
-
- getContentType() - Method in class io.ktor.content.URIFileContent
-
- getContentType() - Method in class io.ktor.content.WriterContent
-
- getContentType() - Method in class io.ktor.features.ContentNegotiation.ConverterRegistration
-
- getContentType() - Method in class io.ktor.routing.HttpAcceptRouteSelector
-
- getConversionService($receiver) - Static method in class io.ktor.features.DataConversionKt
-
- getConverter() - Method in class io.ktor.features.ContentNegotiation.ConverterRegistration
-
- getCookie() - Method in class io.ktor.sessions.CookieSessionBuilder
-
- getCookies() - Method in interface io.ktor.request.ApplicationRequest
-
Cookies for this request
- getCookies() - Method in interface io.ktor.response.ApplicationResponse
-
Cookies for this response
- getCookies() - Method in class io.ktor.routing.RoutingApplicationRequest
-
Cookies for this request
- getCookies() - Method in class io.ktor.routing.RoutingApplicationResponse
-
Cookies for this response
- getCorsDefaultHeaders() - Method in class io.ktor.features.Configuration.Companion
-
- getCorsDefaultMethods() - Method in class io.ktor.features.Configuration.Companion
-
- getCustomDirectives() - Method in class io.ktor.features.HSTS.Configuration
-
- getDefaultVersions($receiver) - Static method in class io.ktor.features.ConditionalHeadersKt
-
Retrieves LastModified and ETag versions from this OutgoingContent headers
- getDomain() - Method in class io.ktor.sessions.CookieConfiguration
-
- getDuration() - Method in class io.ktor.sessions.CookieConfiguration
-
- getEncoder() - Method in class io.ktor.features.CompressionEncoderBuilder
-
- getEncoder() - Method in class io.ktor.features.CompressionEncoderConfig
-
Encoder implementation
- getEncoders() - Method in class io.ktor.features.Compression.Configuration
-
- getEncoders() - Method in class io.ktor.features.CompressionOptions
-
Map of encoder configurations
- getEncoding() - Method in class io.ktor.sessions.CookieConfiguration
-
- getEngine() - Method in class io.ktor.response.ApplicationSendPipeline.Phases
-
Phase for Engine to send the response out to client.
- getEngineHeaderNames() - Method in class io.ktor.response.ResponseHeaders
-
- getEngineHeaderValues(name) - Method in class io.ktor.response.ResponseHeaders
-
- getEnvironment() - Method in class io.ktor.application.Application
-
- getEtag() - Method in class io.ktor.content.EntityTagVersion
-
- getExceptions() - Method in class io.ktor.features.StatusPages.Configuration
-
- getExpires() - Method in class io.ktor.content.CachingOptions
-
- getExposedHeaders() - Method in class io.ktor.features.CORS.Configuration
-
- getExtensions() - Method in class io.ktor.sessions.CookieConfiguration
-
- getFailed() - Method in class io.ktor.routing.RouteSelectorEvaluation.Companion
-
Route evaluation failed to succeed, route doesn't match a context
- getFallback() - Method in class io.ktor.application.ApplicationCallPipeline.ApplicationPhase
-
Phase for handling unprocessed calls
- getFile() - Method in class io.ktor.content.LocalFileContent
-
- getFirst() - Method in class io.ktor.routing.AndRouteSelector
-
- getFirst() - Method in class io.ktor.routing.OrRouteSelector
-
- getForHeaders() - Method in class io.ktor.features.XForwardedHeadersSupport.Config
-
- getForParam() - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- getForwardedParsedKey() - Method in class io.ktor.features.ForwardedHeaderSupport
-
- getHeaders() - Method in class io.ktor.features.CORS.Configuration
-
- getHeaders() - Method in class io.ktor.features.CORS
-
- getHeaders() - Method in class io.ktor.features.DefaultHeaders.Configuration
-
Provides a builder to append any custom headers to be sent with each request
- getHeaders() - Method in interface io.ktor.request.ApplicationRequest
-
Headers for this request
- getHeaders() - Method in interface io.ktor.response.ApplicationResponse
-
Headers for this response
- getHeaders() - Method in class io.ktor.response.DefaultResponsePushBuilder
-
- getHeaders() - Method in interface io.ktor.response.ResponsePushBuilder
-
- getHeaders() - Method in class io.ktor.routing.RoutingApplicationRequest
-
Headers for this request
- getHeaders() - Method in class io.ktor.routing.RoutingApplicationResponse
-
Headers for this response
- getHeaderValue() - Method in class io.ktor.features.HSTS
-
- getHost() - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- getHost() - Method in class io.ktor.features.MutableOriginConnectionPoint
-
- getHostHeaders() - Method in class io.ktor.features.XForwardedHeadersSupport.Config
-
- getHosts() - Method in class io.ktor.features.CORS.Configuration
-
- getHttpMethod($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
Returns request HTTP method possibly overridden via header X-Http-Method-Override
- getHttpOnly() - Method in class io.ktor.sessions.CookieConfiguration
-
- getHttpsFlagHeaders() - Method in class io.ktor.features.XForwardedHeadersSupport.Config
-
- getHttpVersion($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
- getIncludeSubDomains() - Method in class io.ktor.features.HSTS.Configuration
-
- getInfrastructure() - Method in class io.ktor.application.ApplicationCallPipeline.ApplicationPhase
-
Phase for setting up infrastructure for processing a call
- getJarFile() - Method in class io.ktor.content.JarFileContent
-
- getKey() - Method in interface io.ktor.application.ApplicationFeature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.AutoHeadResponse
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.CachingHeaders.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.CallLogging.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.Compression.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.ConditionalHeaders.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.ContentNegotiation.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.CORS.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.DataConversion.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.DefaultHeaders.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.ForwardedHeaderSupport
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.HSTS.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.HttpsRedirect.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.PartialContent.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.StatusPages.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.features.XForwardedHeadersSupport
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.routing.Routing.Feature
-
Unique key that identifies a feature
- getKey() - Method in class io.ktor.sessions.Sessions.Feature
-
Unique key that identifies a feature
- getKeySpec() - Method in class io.ktor.sessions.SessionTransportTransformerMessageAuthentication
-
- getKind() - Method in class io.ktor.routing.RoutingPathSegment
-
- getLastModified() - Method in class io.ktor.content.LastModifiedVersion
-
- getLevel() - Method in class io.ktor.features.CallLogging.Configuration
-
- getList() - Method in interface io.ktor.config.ApplicationConfigValue
-
- getLocal() - Method in interface io.ktor.request.ApplicationRequest
-
Contains http request and connection details such as a host name used to connect, port, scheme and so on.
No proxy headers could affect it. Use
ApplicationRequest.origin if you need override headers support
- getLocal() - Method in class io.ktor.routing.RoutingApplicationRequest
-
Contains http request and connection details such as a host name used to connect, port, scheme and so on.
No proxy headers could affect it. Use
ApplicationRequest.origin if you need override headers support
- getLog() - Method in interface io.ktor.application.ApplicationEnvironment
-
Instance of Logger to be used for logging.
- getLog($receiver) - Static method in class io.ktor.application.ApplicationKt
-
Convenience property to access log from application
- getMaxAge() - Method in class io.ktor.features.CORS.Configuration
-
- getMaxAge() - Method in class io.ktor.features.HSTS.Configuration
-
- getMaxRangeCount() - Method in class io.ktor.features.PartialContent.Configuration
-
Maximum number of ranges that will be accepted from HTTP request.
- getMethod() - Method in class io.ktor.features.MutableOriginConnectionPoint
-
- getMethod() - Method in class io.ktor.response.DefaultResponsePushBuilder
-
- getMethod() - Method in interface io.ktor.response.ResponsePushBuilder
-
- getMethod() - Method in class io.ktor.routing.HttpMethodRouteSelector
-
- getMethods() - Method in class io.ktor.features.CORS.Configuration
-
- getMethods() - Method in class io.ktor.features.CORS
-
- getMissing() - Method in class io.ktor.routing.RouteSelectorEvaluation.Companion
-
Route evaluation succeeded for a missing optional value
- getMonitor() - Method in interface io.ktor.application.ApplicationEnvironment
-
Provides events on Application lifecycle
- getMutableOriginConnectionPointKey() - Static method in class io.ktor.features.OriginConnectionPointKt
-
Deprecated.
- getName() - Method in class io.ktor.features.CompressionEncoderBuilder
-
- getName() - Method in class io.ktor.features.CompressionEncoderConfig
-
Name of the encoder,
- getName() - Method in class io.ktor.routing.ConstantParameterRouteSelector
-
- getName() - Method in class io.ktor.routing.HttpHeaderRouteSelector
-
- getName() - Method in class io.ktor.routing.OptionalParameterRouteSelector
-
- getName() - Method in class io.ktor.routing.ParameterRouteSelector
-
- getName() - Method in class io.ktor.routing.PathSegmentOptionalParameterRouteSelector
-
- getName() - Method in class io.ktor.routing.PathSegmentParameterRouteSelector
-
- getName() - Method in class io.ktor.routing.PathSegmentTailcardRouteSelector
-
- getName() - Method in class io.ktor.sessions.SessionProvider
-
- getName() - Method in class io.ktor.sessions.SessionTransportCookie
-
- getName() - Method in class io.ktor.sessions.SessionTransportHeader
-
- getOrigin($receiver) - Static method in class io.ktor.features.OriginConnectionPointKt
-
Represents request and connection parameters possibly overridden via https headers.
By default it fallbacks to ApplicationRequest.local
- getOthers() - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- getParameters() - Method in interface io.ktor.application.ApplicationCall
-
Parameters associated with this call
- getParameters() - Method in class io.ktor.routing.RouteSelectorEvaluation
-
- getParameters() - Method in class io.ktor.routing.RoutingApplicationCall
-
Parameters associated with this call
- getParameters() - Method in class io.ktor.routing.RoutingResolveResult
-
- getParent() - Method in class io.ktor.routing.Route
-
- getParts() - Method in class io.ktor.routing.RoutingPath
-
- getPath() - Method in class io.ktor.sessions.CookieConfiguration
-
- getPermanent() - Method in class io.ktor.features.HttpsRedirect
-
- getPermanentRedirect() - Method in class io.ktor.features.HttpsRedirect.Configuration
-
- getPipeline() - Method in interface io.ktor.request.ApplicationRequest
-
Pipeline for receiving content
- getPipeline() - Method in interface io.ktor.response.ApplicationResponse
-
Pipeline for sending content
- getPipeline() - Method in class io.ktor.routing.RoutingApplicationRequest
-
Pipeline for receiving content
- getPipeline() - Method in class io.ktor.routing.RoutingApplicationResponse
-
Pipeline for sending content
- getPort() - Method in class io.ktor.features.MutableOriginConnectionPoint
-
- getPrefix() - Method in class io.ktor.routing.PathSegmentOptionalParameterRouteSelector
-
- getPrefix() - Method in class io.ktor.routing.PathSegmentParameterRouteSelector
-
- getPreload() - Method in class io.ktor.features.HSTS.Configuration
-
- getPriority() - Method in class io.ktor.features.CompressionEncoderBuilder
-
Priority for this encoder
- getPriority() - Method in class io.ktor.features.CompressionEncoderConfig
-
Priority of the encoder
- getProperties() - Method in class io.ktor.sessions.SessionSerializerReflection
-
- getProto() - Method in class io.ktor.features.ForwardedHeaderSupport.ForwardedHeaderValue
-
- getProtoHeaders() - Method in class io.ktor.features.XForwardedHeadersSupport.Config
-
- getProviders() - Method in class io.ktor.sessions.Sessions.Configuration
-
- getProviders() - Method in class io.ktor.sessions.Sessions
-
- getQuality() - Method in class io.ktor.routing.RouteSelector
-
- getQuality() - Method in class io.ktor.routing.RouteSelectorEvaluation
-
- getQuality() - Method in class io.ktor.routing.RoutingResolveResult
-
- getQualityConstant() - Method in class io.ktor.routing.RouteSelectorEvaluation.Companion
-
- getQualityMissing() - Method in class io.ktor.routing.RouteSelectorEvaluation.Companion
-
- getQualityParameter() - Method in class io.ktor.routing.RouteSelectorEvaluation.Companion
-
- getQualityTailcard() - Method in class io.ktor.routing.RouteSelectorEvaluation.Companion
-
- getQualityWildcard() - Method in class io.ktor.routing.RouteSelectorEvaluation.Companion
-
- getQueryParameters() - Method in interface io.ktor.request.ApplicationRequest
-
Parameters provided in an URL
- getQueryParameters() - Method in class io.ktor.routing.RoutingApplicationRequest
-
Parameters provided in an URL
- getRawCookies() - Method in class io.ktor.request.RequestCookies
-
- getReceivePipeline() - Method in class io.ktor.application.ApplicationCallPipeline
-
Pipeline for receiving content
- getRedirectPort() - Method in class io.ktor.features.HttpsRedirect
-
- getRegistrations() - Method in class io.ktor.features.ContentNegotiation
-
- getRemoteHost() - Method in class io.ktor.features.MutableOriginConnectionPoint
-
- getRender() - Method in class io.ktor.response.ApplicationSendPipeline.Phases
-
- getRequest() - Method in interface io.ktor.application.ApplicationCall
-
Client request
- getRequest() - Method in class io.ktor.request.RequestCookies
-
- getRequest() - Method in class io.ktor.routing.RoutingApplicationCall
-
Client request
- getResourcePath() - Method in class io.ktor.content.JarFileContent
-
- getResponse() - Method in interface io.ktor.application.ApplicationCall
-
Server response
- getResponse() - Method in class io.ktor.routing.RoutingApplicationCall
-
Server response
- getRoot() - Method in class io.ktor.routing.RoutingPath.Companion
-
- getRoute() - Method in class io.ktor.routing.RoutingApplicationCall
-
- getRoute() - Method in class io.ktor.routing.RoutingResolveResult
-
- getRouting() - Method in class io.ktor.routing.RoutingResolveContext
-
- getRoutingCallFinished() - Method in class io.ktor.routing.Routing.Feature
-
Event definition for when a routing-based call processing finished
- getRoutingCallStarted() - Method in class io.ktor.routing.Routing.Feature
-
Event definition for when a routing-based call processing starts
- getSalt() - Method in class io.ktor.sessions.SessionTransportTransformerDigest
-
- getScheme() - Method in class io.ktor.features.MutableOriginConnectionPoint
-
- getSecond() - Method in class io.ktor.routing.AndRouteSelector
-
- getSecond() - Method in class io.ktor.routing.OrRouteSelector
-
- getSecure() - Method in class io.ktor.sessions.CookieConfiguration
-
- getSegmentIncrement() - Method in class io.ktor.routing.RouteSelectorEvaluation
-
- getSegments() - Method in class io.ktor.routing.RoutingResolveContext
-
List of path segments parsed out of a call
- getSelector() - Method in class io.ktor.routing.Route
-
- getSendPipeline() - Method in class io.ktor.application.ApplicationCallPipeline
-
Pipeline for sending content
- getSerializer() - Method in class io.ktor.sessions.CookieSessionBuilder
-
- getSerializer() - Method in class io.ktor.sessions.HeaderSessionBuilder
-
- getSerializer() - Method in class io.ktor.sessions.SessionTrackerById
-
- getSerializer() - Method in class io.ktor.sessions.SessionTrackerByValue
-
- getSessionIdProvider() - Method in class io.ktor.sessions.CookieIdSessionBuilder
-
- getSessionIdProvider() - Method in class io.ktor.sessions.HeaderIdSessionBuilder
-
- getSessionIdProvider() - Method in class io.ktor.sessions.SessionTrackerById
-
- getSessions($receiver) - Static method in class io.ktor.sessions.SessionsKt
-
- getSslPort() - Method in class io.ktor.features.HttpsRedirect.Configuration
-
- getStaticBasePackage($receiver) - Static method in class io.ktor.content.StaticContentKt
-
Base package for relative resources calculations for static content
- getStaticRootFolder($receiver) - Static method in class io.ktor.content.StaticContentKt
-
Base folder for relative files calculations for static content
- getStatus() - Method in class io.ktor.content.HttpStatusCodeContent
-
- getStatus() - Method in class io.ktor.content.WriterContent
-
- getStatusCode() - Method in enum io.ktor.content.VersionCheckResult
-
- getStatuses() - Method in class io.ktor.features.StatusPages.Configuration
-
- getStorage() - Method in class io.ktor.sessions.SessionTrackerById
-
- getString() - Method in interface io.ktor.config.ApplicationConfigValue
-
- getSucceeded() - Method in class io.ktor.routing.RouteSelectorEvaluation
-
- getSucceeded() - Method in class io.ktor.routing.RoutingResolveResult
-
- getSuffix() - Method in class io.ktor.routing.PathSegmentOptionalParameterRouteSelector
-
- getSuffix() - Method in class io.ktor.routing.PathSegmentParameterRouteSelector
-
- getSuppressionAttribute() - Method in class io.ktor.features.Compression.Feature
-
- getTracker() - Method in class io.ktor.sessions.SessionProvider
-
- getTransferEncoding() - Method in class io.ktor.response.ApplicationSendPipeline.Phases
-
Phase for handling Transfer-Encoding, like if chunked encoding is being done manually and not by engine
- getTransform() - Method in class io.ktor.request.ApplicationReceivePipeline.Phases
-
- getTransform() - Method in class io.ktor.response.ApplicationSendPipeline.Phases
-
Transformation phase that can proceed with any supported data like String
- getTransformers() - Method in class io.ktor.sessions.CookieSessionBuilder
-
- getTransformers() - Method in class io.ktor.sessions.HeaderSessionBuilder
-
- getTransformers() - Method in class io.ktor.sessions.SessionTransportCookie
-
- getTransformers() - Method in class io.ktor.sessions.SessionTransportHeader
-
- getTransport() - Method in class io.ktor.sessions.SessionProvider
-
- getType() - Method in class io.ktor.request.ApplicationReceiveRequest
-
- getType() - Method in class io.ktor.sessions.CookieSessionBuilder
-
- getType() - Method in class io.ktor.sessions.HeaderSessionBuilder
-
- getType() - Method in class io.ktor.sessions.SessionProvider
-
- getType() - Method in class io.ktor.sessions.SessionSerializerReflection
-
- getType() - Method in class io.ktor.sessions.SessionTrackerById
-
- getType() - Method in class io.ktor.sessions.SessionTrackerByValue
-
- getUri() - Method in class io.ktor.content.URIFileContent
-
- getUri() - Method in class io.ktor.features.MutableOriginConnectionPoint
-
- getUri($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
- getUrl() - Method in class io.ktor.response.DefaultResponsePushBuilder
-
- getUrl() - Method in interface io.ktor.response.ResponsePushBuilder
-
- getValue() - Method in class io.ktor.request.ApplicationReceiveRequest
-
- getValue() - Method in class io.ktor.routing.ConstantParameterRouteSelector
-
- getValue() - Method in class io.ktor.routing.HttpHeaderRouteSelector
-
- getValue() - Method in class io.ktor.routing.PathSegmentConstantRouteSelector
-
- getValue() - Method in class io.ktor.routing.RoutingPathSegment
-
- getVersion() - Method in class io.ktor.features.MutableOriginConnectionPoint
-
- getVersionListProperty() - Static method in class io.ktor.content.VersionsKt
-
Specifies a key for VersionList extension property for OutgoingContent
- getVersions($receiver) - Static method in class io.ktor.content.VersionsKt
-
Gets or sets list of
interface Version instances as an extension property on this content
- getVersions() - Method in class io.ktor.response.DefaultResponsePushBuilder
-
- getVersions() - Method in interface io.ktor.response.ResponsePushBuilder
-
- getWildcardPath() - Method in class io.ktor.routing.RouteSelectorEvaluation.Companion
-
Route evaluation succeeded for a wildcard path segment
- gzip($receiver, block) - Static method in class io.ktor.features.CompressionKt
-
Appends gzip encoder
- GzipEncoder - Class in io.ktor.features
-
Implementation of the gzip encoder
- identity($receiver, block) - Static method in class io.ktor.features.CompressionKt
-
Appends identity encoder
- identity(f) - Method in class io.ktor.sessions.CookieIdSessionBuilder
-
- identity(f) - Method in class io.ktor.sessions.HeaderIdSessionBuilder
-
- IdentityEncoder - Class in io.ktor.features
-
Implementation of the identity encoder
- install(pipeline, configure) - Method in interface io.ktor.application.ApplicationFeature
-
Feature installation script
- install($receiver, feature, configure) - Static method in class io.ktor.application.ApplicationFeatureKt
-
Installs feature into this pipeline, if it is not yet installed
- install(pipeline, configure) - Method in class io.ktor.features.AutoHeadResponse
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.CachingHeaders.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.CallLogging.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.Compression.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.ConditionalHeaders.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.ContentNegotiation.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.CORS.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.DataConversion.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.DefaultHeaders.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.ForwardedHeaderSupport
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.HSTS.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.HttpsRedirect.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.PartialContent.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.StatusPages.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.features.XForwardedHeadersSupport
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.routing.Routing.Feature
-
Feature installation script
- install(pipeline, configure) - Method in class io.ktor.sessions.Sessions.Feature
-
Feature installation script
- INSTANCE - Static variable in class io.ktor.features.AutoHeadResponse
-
- INSTANCE - Static variable in class io.ktor.features.DeflateEncoder
-
Implementation of the deflate encoder
- INSTANCE - Static variable in class io.ktor.features.ForwardedHeaderSupport
-
Forwarded header support. See RFC 7239 https://tools.ietf.org/html/rfc7239
- INSTANCE - Static variable in class io.ktor.features.GzipEncoder
-
Implementation of the gzip encoder
- INSTANCE - Static variable in class io.ktor.features.IdentityEncoder
-
Implementation of the identity encoder
- INSTANCE - Static variable in class io.ktor.features.XForwardedHeadersSupport
-
- INSTANCE - Static variable in class io.ktor.routing.PathSegmentSelectorBuilder
-
- INSTANCE - Static variable in class io.ktor.routing.PathSegmentWildcardRouteSelector
-
Evaluates a route against any single path segment
- INSTANCE - Static variable in class io.ktor.util.DefaultConversionService
-
- intercept(context, $continuation) - Method in class io.ktor.features.CORS
-
- intercept(call) - Method in class io.ktor.features.HSTS
-
- intercept(phase, block) - Method in class io.ktor.routing.Route
-
Installs an interceptor into this route which will be called when this or a child route is selected for a call
- invalidate(id, $continuation) - Method in interface io.ktor.sessions.SessionStorage
-
- invalidate(id, $continuation) - Method in class io.ktor.sessions.SessionStorageMemory
-
- invoke(body) - Method in class io.ktor.routing.Route
-
Allows using route instance for building additional routes
- io.ktor.application - package io.ktor.application
-
- io.ktor.config - package io.ktor.config
-
- io.ktor.content - package io.ktor.content
-
- io.ktor.features - package io.ktor.features
-
- io.ktor.http - package io.ktor.http
-
- io.ktor.request - package io.ktor.request
-
- io.ktor.response - package io.ktor.response
-
- io.ktor.routing - package io.ktor.routing
-
- io.ktor.sessions - package io.ktor.sessions
-
- io.ktor.util - package io.ktor.util
-
- isChunked($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
- isMultipart($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
- param($receiver, name, value, build) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match parameter with specified name and value
- param($receiver, name, build) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match parameter with specified name and capture its value
- ParameterRouteSelector - Class in io.ktor.routing
-
Evaluates a route against a query parameter value and captures its value
- ParameterRouteSelector(name) - Constructor for class io.ktor.routing.ParameterRouteSelector
-
Evaluates a route against a query parameter value and captures its value
- parse(path) - Method in class io.ktor.routing.RoutingPath.Companion
-
- parseConstant(value) - Method in class io.ktor.routing.PathSegmentSelectorBuilder
-
- parseName(value) - Method in class io.ktor.routing.PathSegmentSelectorBuilder
-
Parses a name out of segment specification
- parseParameter(value) - Method in class io.ktor.routing.PathSegmentSelectorBuilder
-
- PartialContent - Class in io.ktor.features
-
Feature to support requests to specific content ranges.
- PartialContent(maxRangeCount) - Constructor for class io.ktor.features.PartialContent
-
Feature to support requests to specific content ranges.
- PartialContent.Configuration - Class in io.ktor.features
-
- PartialContent.Feature - Class in io.ktor.features
-
- PartialContentKt - Class in io.ktor.features
-
- patch($receiver, path, body) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match PATCH requests with specified path
- patch($receiver, body) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match PATCH requests
- path($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
- PathSegmentConstantRouteSelector - Class in io.ktor.routing
-
Evaluates a route against a constant path segment
- PathSegmentConstantRouteSelector(value) - Constructor for class io.ktor.routing.PathSegmentConstantRouteSelector
-
Evaluates a route against a constant path segment
- PathSegmentOptionalParameterRouteSelector - Class in io.ktor.routing
-
Evaluates a route against an optional parameter path segment and captures its value, if any
- PathSegmentOptionalParameterRouteSelector(name, prefix, suffix) - Constructor for class io.ktor.routing.PathSegmentOptionalParameterRouteSelector
-
Evaluates a route against an optional parameter path segment and captures its value, if any
- PathSegmentParameterRouteSelector - Class in io.ktor.routing
-
Evaluates a route against a parameter path segment and captures its value
- PathSegmentParameterRouteSelector(name, prefix, suffix) - Constructor for class io.ktor.routing.PathSegmentParameterRouteSelector
-
Evaluates a route against a parameter path segment and captures its value
- PathSegmentSelectorBuilder - Class in io.ktor.routing
-
- PathSegmentTailcardRouteSelector - Class in io.ktor.routing
-
Evaluates a route against any number of trailing path segments, and captures their values
- PathSegmentTailcardRouteSelector(name) - Constructor for class io.ktor.routing.PathSegmentTailcardRouteSelector
-
Evaluates a route against any number of trailing path segments, and captures their values
- PathSegmentTailcardRouteSelector() - Constructor for class io.ktor.routing.PathSegmentTailcardRouteSelector
-
Evaluates a route against any number of trailing path segments, and captures their values
- PathSegmentWildcardRouteSelector - Class in io.ktor.routing
-
Evaluates a route against any single path segment
- Phases - Static variable in class io.ktor.request.ApplicationReceivePipeline
-
- Phases - Static variable in class io.ktor.response.ApplicationSendPipeline
-
- port($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
- post($receiver, path, body) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match POST requests with specified path
- post($receiver, body) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match POST requests
- prepareShutdown() - Method in class io.ktor.util.DispatcherWithShutdown
-
- property(path) - Method in interface io.ktor.config.ApplicationConfig
-
- property(path) - Method in class io.ktor.config.HoconApplicationConfig
-
- property(path) - Method in class io.ktor.config.MapApplicationConfig
-
- propertyOrNull(path) - Method in interface io.ktor.config.ApplicationConfig
-
- propertyOrNull(path) - Method in class io.ktor.config.HoconApplicationConfig
-
- propertyOrNull(path) - Method in class io.ktor.config.MapApplicationConfig
-
- push($receiver, pathAndQuery) - Static method in class io.ktor.http.PushKt
-
- push($receiver, encodedPath, parameters) - Static method in class io.ktor.http.PushKt
-
- push($receiver, block) - Static method in class io.ktor.http.PushKt
-
Produces HTTP/2 push from server to client or sets HTTP/1.x hint header
or does nothing (may call or not call block).
Exact behaviour is up to engine implementation.
- push(builder) - Method in interface io.ktor.response.ApplicationResponse
-
Produces HTTP/2 push from server to client or sets HTTP/1.x hint header
or does nothing. Exact behaviour is up to engine implementation.
- push(builder) - Method in class io.ktor.routing.RoutingApplicationResponse
-
Produces HTTP/2 push from server to client or sets HTTP/1.x hint header
or does nothing. Exact behaviour is up to engine implementation.
- PushKt - Class in io.ktor.http
-
- put(path, value) - Method in class io.ktor.config.MapApplicationConfig
-
- put(path, values) - Method in class io.ktor.config.MapApplicationConfig
-
- put($receiver, path, body) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match PUT requests with specified path
- put($receiver, body) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match PUT requests
- raise(definition, value) - Method in class io.ktor.application.ApplicationEvents
-
Rise an event specified by definition with the specified value and call all handlers
- ranges($receiver) - Static method in class io.ktor.request.ApplicationRequestPropertiesKt
-
- read(id, consumer, $continuation) - Method in interface io.ktor.sessions.SessionStorage
-
- read(id, consumer, $continuation) - Method in class io.ktor.sessions.SessionStorageMemory
-
- readFrom() - Method in class io.ktor.content.JarFileContent
-
- readFrom() - Method in class io.ktor.content.LocalFileContent
-
- readFrom(range) - Method in class io.ktor.content.LocalFileContent
-
- readFrom() - Method in class io.ktor.content.URIFileContent
-
- receive(call) - Method in interface io.ktor.sessions.SessionTransport
-
- receive(call) - Method in class io.ktor.sessions.SessionTransportCookie
-
- receive(call) - Method in class io.ktor.sessions.SessionTransportHeader
-
- receiveChannel($receiver, $continuation) - Static method in class io.ktor.request.ApplicationReceiveFunctionsKt
-
- receiveContent() - Method in interface io.ktor.request.ApplicationRequest
-
- receiveContent() - Method in class io.ktor.routing.RoutingApplicationRequest
-
- receiveMultipart($receiver, $continuation) - Static method in class io.ktor.request.ApplicationReceiveFunctionsKt
-
- receiveOrNull($receiver, type, $continuation) - Static method in class io.ktor.request.ApplicationReceiveFunctionsKt
-
Receive content for this request
- receiveParameters($receiver, $continuation) - Static method in class io.ktor.request.ApplicationReceiveFunctionsKt
-
- receiveStream($receiver, $continuation) - Static method in class io.ktor.request.ApplicationReceiveFunctionsKt
-
- receiveText($receiver, $continuation) - Static method in class io.ktor.request.ApplicationReceiveFunctionsKt
-
- register(contentType, converter, configuration) - Method in class io.ktor.features.ContentNegotiation.Configuration
-
Registers a contentType to a specified converter with an optional configuration script for converter
- register(provider) - Method in class io.ktor.sessions.Sessions.Configuration
-
- RequestCookies - Class in io.ktor.request
-
- RequestCookies(request) - Constructor for class io.ktor.request.RequestCookies
-
- resolve() - Method in class io.ktor.routing.RoutingResolveContext
-
- resolveResource($receiver, path, resourcePackage, classLoader, mimeResolve) - Static method in class io.ktor.content.StaticContentResolutionKt
-
- resource($receiver, remotePath, resource, resourcePackage) - Static method in class io.ktor.content.StaticContentKt
-
Sets up routing to serve resource as remotePath in resourcePackage
- resources($receiver, resourcePackage) - Static method in class io.ktor.content.StaticContentKt
-
Sets up routing to serve all resources in resourcePackage
- respond($receiver, message, $continuation) - Static method in class io.ktor.response.ApplicationResponseFunctionsKt
-
Sends a message as a response
- respond($receiver, status, message, $continuation) - Static method in class io.ktor.response.ApplicationResponseFunctionsKt
-
Sets status and sends a message as a response
- respondFile($receiver, baseDir, fileName, configure, $continuation) - Static method in class io.ktor.response.ApplicationResponseFunctionsKt
-
Responds to a client with a contents of a file with the name fileName in the baseDir folder
- respondFile($receiver, file, configure, $continuation) - Static method in class io.ktor.response.ApplicationResponseFunctionsKt
-
Responds to a client with a contents of a file
- respondRedirect($receiver, url, permanent, $continuation) - Static method in class io.ktor.response.ApplicationResponseFunctionsKt
-
Responds to a client with a 301 Moved Permanently or 302 Found redirect
- respondText($receiver, text, contentType, status, configure, $continuation) - Static method in class io.ktor.response.ApplicationResponseFunctionsKt
-
Responds to a client with a plain text response, using specified text
- respondText($receiver, contentType, status, provider, $continuation) - Static method in class io.ktor.response.ApplicationResponseFunctionsKt
-
Responds to a client with a plain text response, using specified provider to build a text
- respondWrite($receiver, contentType, status, writer, $continuation) - Static method in class io.ktor.response.ApplicationResponseFunctionsKt
-
Respond with content producer.
- ResponseCookies - Class in io.ktor.response
-
- ResponseCookies(response, secureTransport) - Constructor for class io.ktor.response.ResponseCookies
-
- ResponseHeaders - Class in io.ktor.response
-
- ResponseHeaders() - Constructor for class io.ktor.response.ResponseHeaders
-
- ResponseHeadersKt - Class in io.ktor.response
-
- ResponsePushBuilder - Interface in io.ktor.response
-
- Route - Class in io.ktor.routing
-
Describes a node in a routing tree
- Route(parent, selector) - Constructor for class io.ktor.routing.Route
-
Describes a node in a routing tree
- route($receiver, path, build) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match specified path
- route($receiver, path, method, build) - Static method in class io.ktor.routing.RoutingBuilderKt
-
Builds a route to match specified method and path
- RouteSelector - Class in io.ktor.routing
-
Base type for all routing selectors
- RouteSelector(quality) - Constructor for class io.ktor.routing.RouteSelector
-
Base type for all routing selectors
- RouteSelectorEvaluation - Class in io.ktor.routing
-
Represents a result of a route evaluation against a call
- RouteSelectorEvaluation(succeeded, quality, parameters, segmentIncrement) - Constructor for class io.ktor.routing.RouteSelectorEvaluation
-
Represents a result of a route evaluation against a call
- RouteSelectorEvaluation.Companion - Class in io.ktor.routing
-
- Routing - Class in io.ktor.routing
-
- Routing(application) - Constructor for class io.ktor.routing.Routing
-
- routing($receiver, configuration) - Static method in class io.ktor.routing.RoutingKt
-
- Routing.Feature - Class in io.ktor.routing
-
- RoutingApplicationCall - Class in io.ktor.routing
-
- RoutingApplicationCall(call, route, receivePipeline, responsePipeline, parameters) - Constructor for class io.ktor.routing.RoutingApplicationCall
-
- RoutingApplicationRequest - Class in io.ktor.routing
-
- RoutingApplicationRequest(call, pipeline, request) - Constructor for class io.ktor.routing.RoutingApplicationRequest
-
- RoutingApplicationResponse - Class in io.ktor.routing
-
- RoutingApplicationResponse(call, pipeline, response) - Constructor for class io.ktor.routing.RoutingApplicationResponse
-
- RoutingBuilderKt - Class in io.ktor.routing
-
- RoutingKt - Class in io.ktor.routing
-
- RoutingPath - Class in io.ktor.routing
-
- RoutingPath.Companion - Class in io.ktor.routing
-
- RoutingPathSegment - Class in io.ktor.routing
-
- RoutingPathSegment(value, kind) - Constructor for class io.ktor.routing.RoutingPathSegment
-
- RoutingPathSegmentKind - Enum in io.ktor.routing
-
- RoutingPathSegmentKind() - Constructor for enum io.ktor.routing.RoutingPathSegmentKind
-
- RoutingResolutionException - Exception in io.ktor.routing
-
Exception indicating a failure in a routing resolution process
- RoutingResolutionException(message) - Constructor for exception io.ktor.routing.RoutingResolutionException
-
Exception indicating a failure in a routing resolution process
- RoutingResolveContext - Class in io.ktor.routing
-
Represents a context in which routing resolution is being performed
- RoutingResolveContext(routing, call) - Constructor for class io.ktor.routing.RoutingResolveContext
-
Represents a context in which routing resolution is being performed
- RoutingResolveResult - Class in io.ktor.routing
-
Represents a result of routing resolution
- RoutingResolveResult(succeeded, route, parameters, quality) - Constructor for class io.ktor.routing.RoutingResolveResult
-
Represents a result of routing resolution