Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W 

A

Anchor - Static variable in class io.ktor.http.LinkHeader.Parameters
 
append($receiver, name, value) - Static method in class io.ktor.http.HeaderValueWithParametersKt
Append formatted header value to the builder
appendHeadersTo(builder) - Method in class io.ktor.http.content.EntityTagVersion
Appends relevant headers to the builder
appendHeadersTo(builder) - Method in class io.ktor.http.content.LastModifiedVersion
Appends relevant headers to the builder
appendHeadersTo(builder) - Method in interface io.ktor.http.content.Version
Appends relevant headers to the builder
ApplicationResponsePropertiesJvmKt - Class in io.ktor.http
 
ApplicationResponsePropertiesKt - Class in io.ktor.http
 
AuthScheme - Class in io.ktor.http.auth
Contains the standard auth schemes.

B

BadContentTypeFormatException - Exception in io.ktor.http
Exception thrown when a content type string is malformed.
BadContentTypeFormatException(value) - Constructor for exception io.ktor.http.BadContentTypeFormatException
Exception thrown when a content type string is malformed.
Basic - Static variable in class io.ktor.http.auth.AuthScheme
Basic Authentication described in the RFC-7617
basicAuthChallenge(realm, charset) - Method in class io.ktor.http.auth.HttpAuthHeader.Companion
Generates an AuthScheme.Basic challenge as a class HttpAuthHeader.
BinaryItem(provider, dispose, partHeaders) - Constructor for class io.ktor.http.content.PartData.BinaryItem
Represents a binary item
Bounded(from, to) - Constructor for class io.ktor.http.ContentRange.Bounded
Represents a Content-Range bounded from both sides
build(builder) - Method in class io.ktor.http.Headers.Companion
Builds a interface Headers instance with the given builder function
build() - Method in class io.ktor.http.HeadersBuilder
 
build(builder) - Method in class io.ktor.http.Parameters.Companion
Builds a interface Parameters instance with the given builder function
build() - Method in class io.ktor.http.ParametersBuilder
 
build() - Method in class io.ktor.http.URLBuilder
Build a class Url instance (everything is copied to a new instance)
buildString() - Method in class io.ktor.http.URLBuilder
Build a URL string
ByteArrayContent - Class in io.ktor.http.content
Implementation of the class OutgoingContent.ByteArrayContent for sending array of bytes
ByteArrayContent(bytes, contentType, status) - Constructor for class io.ktor.http.content.ByteArrayContent
Implementation of the class OutgoingContent.ByteArrayContent for sending array of bytes
ByteArrayContent() - Constructor for class io.ktor.http.content.OutgoingContent.ByteArrayContent
Variant of a class OutgoingContent with payload represented as ByteArray
bytes() - Method in class io.ktor.http.content.ByteArrayContent
Provides ByteArray which engine will send to peer
bytes() - Method in class io.ktor.http.content.OutgoingContent.ByteArrayContent
Provides ByteArray which engine will send to peer
bytes() - Method in class io.ktor.http.content.TextContent
Provides ByteArray which engine will send to peer

C

CacheControl - Class in io.ktor.http
Represents a value for a Cache-Control header
CacheControl.MaxAge - Class in io.ktor.http
Represents a cache control value with the specified max ages and re-validation strategies
CacheControl.NoCache - Class in io.ktor.http
Represents a no-cache cache control value
CacheControl.NoStore - Class in io.ktor.http
Represents a no-store cache control value
CacheControl.Visibility - Enum in io.ktor.http
Controls caching by proxies
CachingOptions - Class in io.ktor.http.content
Specifies caching properties for an class OutgoingContent such as Cache-Control or Expires
CachingOptions(cacheControl, expires) - Constructor for class io.ktor.http.content.CachingOptions
Specifies caching properties for an class OutgoingContent such as Cache-Control or Expires
CachingOptions() - Constructor for class io.ktor.http.content.CachingOptions
Specifies caching properties for an class OutgoingContent such as Cache-Control or Expires
CachingOptions(cacheControl, expires) - Static method in class io.ktor.http.content.CachingOptionsJvmKt
Creates class CachingOptions instance with ZonedDateTime expiration time
CachingOptionsJvmKt - Class in io.ktor.http.content
 
CachingOptionsKt - Class in io.ktor.http.content
 
Charset - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
charset($receiver) - Static method in class io.ktor.http.ContentTypesKt
Extracts a Charset value from the given Content-Type, Content-Disposition or similar header value.
charset($receiver, charset) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Deprecated. 
charset($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse charset from Content-Type header value
charset($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse charset from Content-Type header value
check(requestHeaders) - Method in class io.ktor.http.content.EntityTagVersion
Checks requestHeaders against this version and returns enum VersionCheckResult
check(requestHeaders) - Method in class io.ktor.http.content.LastModifiedVersion
 
check(requestHeaders) - Method in interface io.ktor.http.content.Version
Checks requestHeaders against this version and returns enum VersionCheckResult
clone($receiver) - Static method in class io.ktor.http.URLBuilderKt
Create a copy of this builder. Modifications in a copy is not reflected in the original instance and vise-versa.
CodecsKt - Class in io.ktor.http
 
Companion - Static variable in class io.ktor.http.auth.HttpAuthHeader
 
Companion - Static variable in class io.ktor.http.ContentDisposition
 
Companion - Static variable in class io.ktor.http.ContentType
 
Companion - Static variable in interface io.ktor.http.Headers
 
Companion - Static variable in class io.ktor.http.HeaderValueWithParameters
 
Companion - Static variable in class io.ktor.http.HttpMethod
 
Companion - Static variable in class io.ktor.http.HttpProtocolVersion
 
Companion - Static variable in class io.ktor.http.HttpStatusCode
 
Companion - Static variable in interface io.ktor.http.Parameters
 
Companion - Static variable in class io.ktor.http.Url
 
Companion - Static variable in class io.ktor.http.URLBuilder
 
Companion - Static variable in class io.ktor.http.URLProtocol
 
CompatibilityKt - Class in io.ktor.content
 
component1() - Method in class io.ktor.http.content.CachingOptions
header
component1() - Method in class io.ktor.http.content.EntityTagVersion
entity tag, for example file's content hash
component1() - Method in class io.ktor.http.content.LastModifiedVersion
of the current content,
component1() - Method in class io.ktor.http.ContentRange.Bounded
index from which the content should begin
component1() - Method in class io.ktor.http.ContentRange.Suffix
number of tail bytes
component1() - Method in class io.ktor.http.ContentRange.TailFrom
index from which the content should begin
component1() - Method in class io.ktor.http.Cookie
 
component1() - Method in class io.ktor.http.HeaderValue
 
component1() - Method in class io.ktor.http.HeaderValueParam
of parameter
component1() - Method in class io.ktor.http.HttpMethod
contains method name
component1() - Method in class io.ktor.http.HttpProtocolVersion
specifies name of the protocol,
component1() - Method in class io.ktor.http.HttpStatusCode
is a numeric code.
component1() - Method in class io.ktor.http.RangesSpecifier
range units,
component1() - Method in class io.ktor.http.Url
 
component1() - Method in class io.ktor.http.URLProtocol
of protocol
component10() - Method in class io.ktor.http.Cookie
additional cookie extensions
component2() - Method in class io.ktor.http.content.CachingOptions
header
component2() - Method in class io.ktor.http.ContentRange.Bounded
the last index the content should end at
component2() - Method in class io.ktor.http.Cookie
 
component2() - Method in class io.ktor.http.HeaderValue
for this value
component2() - Method in class io.ktor.http.HeaderValueParam
of parameter
component2() - Method in class io.ktor.http.HttpProtocolVersion
specifies protocol major version.
component2() - Method in class io.ktor.http.HttpStatusCode
is free form description of a status.
component2() - Method in class io.ktor.http.RangesSpecifier
a list of requested ranges
component2() - Method in class io.ktor.http.Url
name without port
component2() - Method in class io.ktor.http.URLProtocol
default port for protocol or
component3() - Method in class io.ktor.http.Cookie
cookie encoding type
component3() - Method in class io.ktor.http.HttpProtocolVersion
specifies protocol minor version.
component3() - Method in class io.ktor.http.Url
port number that was specified to override protocol
component4() - Method in class io.ktor.http.Cookie
number of seconds to keep cookie
component4() - Method in class io.ktor.http.Url
encoded path without query string
component5() - Method in class io.ktor.http.Cookie
date when it expires
component5() - Method in class io.ktor.http.Url
URL query parameters
component6() - Method in class io.ktor.http.Cookie
for which it is set
component6() - Method in class io.ktor.http.Url
URL fragment
component7() - Method in class io.ktor.http.Cookie
for which it is set
component7() - Method in class io.ktor.http.Url
username part of URL
component8() - Method in class io.ktor.http.Cookie
send it via secure connection only
component8() - Method in class io.ktor.http.Url
password part of URL
component9() - Method in class io.ktor.http.Cookie
only transfer cookie over HTTP,
component9() - Method in class io.ktor.http.Url
keep trailing question character even if there are no query parameters
ContentDisposition - Class in io.ktor.http
Represents Content-Disposition header value
ContentDisposition(disposition, parameters) - Constructor for class io.ktor.http.ContentDisposition
Represents Content-Disposition header value
ContentDisposition.Companion - Class in io.ktor.http
 
ContentDisposition.Parameters - Class in io.ktor.http
Frequently used content disposition parameter names
contentLength($receiver, length) - Static method in class io.ktor.http.ApplicationResponsePropertiesKt
Deprecated. 
contentLength($receiver, length) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Deprecated. 
contentLength($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse Content-Length header value
contentLength($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse Content-Length header value
ContentRange - Class in io.ktor.http
Represents a Range header's particular range
ContentRange.Bounded - Class in io.ktor.http
Represents a Content-Range bounded from both sides
ContentRange.Suffix - Class in io.ktor.http
Represents a Content-Range bounded by tail size
ContentRange.TailFrom - Class in io.ktor.http
Represents a Content-Range bounded at the beginning (skip first bytes, show tail)
contentRangeHeaderValue(range, fullLength, unit) - Static method in class io.ktor.http.ContentRangeKt
Format Content-Range header value
contentRangeHeaderValue(range, fullLength, unit) - Static method in class io.ktor.http.ContentRangeKt
Format Content-Range header value
ContentRangeKt - Class in io.ktor.http
 
contentType($receiver, contentType) - Static method in class io.ktor.http.ApplicationResponsePropertiesKt
Deprecated. 
ContentType - Class in io.ktor.http
Represents a value for a Content-Type header.
ContentType(contentType, contentSubtype, parameters) - Constructor for class io.ktor.http.ContentType
 
contentType($receiver, type) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Set Content-Type header
contentType($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse Content-Type header value
contentType($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse Content-Type header value
ContentType.Application - Class in io.ktor.http
Provides a list of standard subtypes of an application content type.
ContentType.Audio - Class in io.ktor.http
Provides a list of standard subtypes of an audio content type.
ContentType.Companion - Class in io.ktor.http
 
ContentType.Image - Class in io.ktor.http
Provides a list of standard subtypes of an image content type.
ContentType.Message - Class in io.ktor.http
Provides a list of standard subtypes of a message content type.
ContentType.MultiPart - Class in io.ktor.http
Provides a list of standard subtypes of a multipart content type.
ContentType.Text - Class in io.ktor.http
Provides a list of standard subtypes of a text content type.
ContentType.Video - Class in io.ktor.http
Provides a list of standard subtypes of a video content type.
ContentTypesKt - Class in io.ktor.http
 
Cookie - Class in io.ktor.http
Represents a cooke value
Cookie(name, value, encoding, maxAge, expires, domain, path, secure, httpOnly, extensions) - Constructor for class io.ktor.http.Cookie
Represents a cooke value
CookieEncoding - Enum in io.ktor.http
Cooke encoding strategy
CookieEncoding() - Constructor for enum io.ktor.http.CookieEncoding
Cooke encoding strategy
CookieKt - Class in io.ktor.http
 
cookies($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse Set-Cookie header value
copy(cacheControl, expires) - Method in class io.ktor.http.content.CachingOptions
Specifies caching properties for an class OutgoingContent such as Cache-Control or Expires
copy(etag) - Method in class 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 enum VersionCheckResult
copy(lastModified) - Method in class 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.
copy(from, to) - Method in class io.ktor.http.ContentRange.Bounded
Represents a Content-Range bounded from both sides
copy(lastCount) - Method in class io.ktor.http.ContentRange.Suffix
Represents a Content-Range bounded by tail size
copy(from) - Method in class io.ktor.http.ContentRange.TailFrom
Represents a Content-Range bounded at the beginning (skip first bytes, show tail)
copy(name, value, encoding, maxAge, expires, domain, path, secure, httpOnly, extensions) - Method in class io.ktor.http.Cookie
Represents a cooke value
copy(value, params) - Method in class io.ktor.http.HeaderValue
Represents a header value. Similar to class HeaderValueWithParameters
copy(name, value) - Method in class io.ktor.http.HeaderValueParam
Represents a single value parameter
copy(value) - Method in class io.ktor.http.HttpMethod
Represents an HTTP method (verb)
copy(name, major, minor) - Method in class io.ktor.http.HttpProtocolVersion
Represents an HTTP protocol version.
copy(value, description) - Method in class io.ktor.http.HttpStatusCode
Represents an HTTP status code and description.
copy(unit, ranges) - Method in class io.ktor.http.RangesSpecifier
Range specifier for partial content requests (RFC 2616 sec 14.35.1)
copy(protocol, host, specifiedPort, encodedPath, parameters, fragment, user, password, trailingQuery) - Method in class io.ktor.http.Url
Represents an immutable URL
copy(name, defaultPort) - Method in class io.ktor.http.URLProtocol
Represents URL protocol
createOrDefault(name) - Method in class io.ktor.http.URLProtocol.Companion
Create an instance by name or use already existing instance
CreationDate - Static variable in class io.ktor.http.ContentDisposition.Parameters
 

D

DateUtilsKt - Class in io.ktor.http
 
decodeCookieValue(encodedValue, encoding) - Static method in class io.ktor.http.CookieKt
Decode cookie value using the specified encoding
decodeURLPart($receiver, start, end, charset) - Static method in class io.ktor.http.CodecsKt
Decode percent encoded URL part within the specified range [start, end). This function is not intended to decode urlencoded forms so it doesn't decode plus character to space.
decodeURLQueryComponent($receiver, start, end, plusIsSpace, charset) - Static method in class io.ktor.http.CodecsKt
Decode URL query component
DEFAULT_PORT - Static variable in class io.ktor.http.URLBuilderKt
Select default port value from protocol.
defaultForFile($receiver, file) - Static method in class io.ktor.http.FileContentTypeJvmKt
 
defaultForFile($receiver, file) - Static method in class io.ktor.http.FileContentTypeJvmKt
 
defaultForFileExtension($receiver, extension) - Static method in class io.ktor.http.FileContentTypeKt
Default class ContentType for extension
defaultForFilePath($receiver, path) - Static method in class io.ktor.http.FileContentTypeKt
Default class ContentType for file path
description(value) - Method in class io.ktor.http.HttpStatusCode
Returns a copy of this code with a description changed to value.
Digest - Static variable in class io.ktor.http.auth.AuthScheme
Digest Authentication described in the RFC-2069:
digestAuthChallenge(realm, nonce, domain, opaque, stale, algorithm) - Method in class io.ktor.http.auth.HttpAuthHeader.Companion
Generates an AuthScheme.Digest challenge as a class HttpAuthHeader.
DnsPrefetch - Static variable in class io.ktor.http.LinkHeader.Rel
 

E

EmptyHeaders - Class in io.ktor.http
Deprecated. 
EmptyParameters - Class in io.ktor.http
Deprecated. 
encodeCookieValue(value, encoding) - Static method in class io.ktor.http.CookieKt
Encode cookie value using the specified encoding
encodeOAuth($receiver) - Static method in class io.ktor.http.CodecsKt
Encode this in percent encoding specified here: https://tools.ietf.org/html/rfc5849#section-3.6
encodeURLParameter($receiver, spaceToPlus) - Static method in class io.ktor.http.CodecsKt
Encode this as query parameter
encodeURLPath($receiver) - Static method in class io.ktor.http.CodecsKt
Encode URL path or component. It escapes all illegal or ambiguous characters
encodeURLQueryComponent($receiver, encodeFull, spaceToPlus, charset) - Static method in class io.ktor.http.CodecsKt
Encode url part as specified in https://tools.ietf.org/html/rfc3986#section-2
EntityTagVersion - Class in io.ktor.http.content
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
EntityTagVersion(etag) - Constructor for class 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 enum VersionCheckResult
entries() - Method in class io.ktor.http.EmptyHeaders
Deprecated.
 
entries() - Method in class io.ktor.http.EmptyParameters
Deprecated.
 
equals(other) - Method in class io.ktor.http.auth.HttpAuthHeader.Parameterized
 
equals(other) - Method in class io.ktor.http.auth.HttpAuthHeader.Single
 
equals(p) - Method in class io.ktor.http.content.CachingOptions
 
equals(p) - Method in class io.ktor.http.content.EntityTagVersion
 
equals(p) - Method in class io.ktor.http.content.LastModifiedVersion
 
equals(other) - Method in class io.ktor.http.ContentDisposition
 
equals(p) - Method in class io.ktor.http.ContentRange.Bounded
 
equals(p) - Method in class io.ktor.http.ContentRange.Suffix
 
equals(p) - Method in class io.ktor.http.ContentRange.TailFrom
 
equals(other) - Method in class io.ktor.http.ContentType
 
equals(p) - Method in class io.ktor.http.Cookie
 
equals(other) - Method in class io.ktor.http.EmptyParameters
Deprecated.
 
equals(p) - Method in class io.ktor.http.HeaderValue
 
equals(other) - Method in class io.ktor.http.HeaderValueParam
 
equals(p) - Method in class io.ktor.http.HttpMethod
 
equals(p) - Method in class io.ktor.http.HttpProtocolVersion
 
equals(p) - Method in class io.ktor.http.HttpStatusCode
 
equals(p) - Method in class io.ktor.http.RangesSpecifier
 
equals(p) - Method in class io.ktor.http.Url
 
equals(p) - Method in class io.ktor.http.URLProtocol
 
escapeIfNeeded($receiver) - Static method in class io.ktor.http.HeaderValueWithParametersKt
Escape using double quotes if needed or keep as is if no dangerous strings found
etag($receiver, entityTag) - Static method in class io.ktor.http.ApplicationResponsePropertiesKt
Set E-Tag header
etag($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse E-Tag header value
etag($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse E-Tag header value
expires($receiver, expires) - Static method in class io.ktor.http.ApplicationResponsePropertiesJvmKt
Set 'Expires` header value from expires
expires($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesJvmKt
Parse Expires header
expires($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesJvmKt
Parse Expires header

F

FileContentTypeJvmKt - Class in io.ktor.http
 
FileContentTypeKt - Class in io.ktor.http
 
fileExtensions($receiver) - Static method in class io.ktor.http.FileContentTypeKt
Recommended file name extensions for this content type
FileItem(provider, dispose, partHeaders) - Constructor for class io.ktor.http.content.PartData.FileItem
Represents a file item
FileName - Static variable in class io.ktor.http.ContentDisposition.Parameters
 
FileNameAsterisk - Static variable in class io.ktor.http.ContentDisposition.Parameters
 
forEachPart($receiver, partHandler, p) - Static method in class io.ktor.http.content.MultipartKt
Parse multipart data stream and invoke partHandler for each class PartData encountered
FormItem(value, dispose, partHeaders) - Constructor for class io.ktor.http.content.PartData.FormItem
Represents a multipart form item
formUrlEncode($receiver) - Static method in class io.ktor.http.HttpUrlEncodedKt
Encode form parameters from a list of pairs
formUrlEncode($receiver) - Static method in class io.ktor.http.HttpUrlEncodedKt
Encode form parameters
formUrlEncodeTo($receiver, out) - Static method in class io.ktor.http.HttpUrlEncodedKt
Encode form parameters from a list of pairs to the specified out appendable
formUrlEncodeTo($receiver, out) - Static method in class io.ktor.http.HttpUrlEncodedKt
Encode form parameters to the specified out appendable
fromFileExtension($receiver, ext) - Static method in class io.ktor.http.FileContentTypeKt
Recommended content type by file name extension
fromFilePath($receiver, path) - Static method in class io.ktor.http.FileContentTypeKt
Recommended content types by file path
fromHttpDateString($receiver) - Static method in class io.ktor.http.HttpDateKt
Parse HTTP date to ZonedDateTime
fromHttpToGmtDate($receiver) - Static method in class io.ktor.http.DateUtilsKt
Convert valid http date String to GMTDate according to: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Date format: {3}, {2} {3} {4} {2}:{2}:{2} GMT String size should be equals 29
fromValue(name, major, minor) - Method in class io.ktor.http.HttpProtocolVersion.Companion
Creates an instance of class HttpProtocolVersion from the given parameters.
fromValue(value) - Method in class io.ktor.http.HttpStatusCode.Companion
Creates an instance of class HttpStatusCode with the given numeric value.

G

getAccept() - Method in class io.ktor.http.HttpHeaders
 
getAcceptCharset() - Method in class io.ktor.http.HttpHeaders
 
getAccepted() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getAcceptEncoding() - Method in class io.ktor.http.HttpHeaders
 
getAcceptLanguage() - Method in class io.ktor.http.HttpHeaders
 
getAcceptRanges() - Method in class io.ktor.http.HttpHeaders
 
getAccessControlAllowCredentials() - Method in class io.ktor.http.HttpHeaders
 
getAccessControlAllowHeaders() - Method in class io.ktor.http.HttpHeaders
 
getAccessControlAllowMethods() - Method in class io.ktor.http.HttpHeaders
 
getAccessControlAllowOrigin() - Method in class io.ktor.http.HttpHeaders
 
getAccessControlExposeHeaders() - Method in class io.ktor.http.HttpHeaders
 
getAccessControlMaxAge() - Method in class io.ktor.http.HttpHeaders
 
getAccessControlRequestHeaders() - Method in class io.ktor.http.HttpHeaders
 
getAccessControlRequestMethod() - Method in class io.ktor.http.HttpHeaders
 
getAge() - Method in class io.ktor.http.HttpHeaders
 
getAll(name) - Method in class io.ktor.http.EmptyHeaders
Deprecated.
 
getAll(name) - Method in class io.ktor.http.EmptyParameters
Deprecated.
 
getAllow() - Method in class io.ktor.http.HttpHeaders
 
getAllStatusCodes() - Method in class io.ktor.http.HttpStatusCode.Companion
All known status codes
getALPN() - Method in class io.ktor.http.HttpHeaders
 
getAlternative() - Method in class io.ktor.http.ContentType.MultiPart
 
getAny() - Method in class io.ktor.http.ContentType.Application
Represents a pattern application / * to match any application content type.
getAny() - Method in class io.ktor.http.ContentType.Audio
 
getAny() - Method in class io.ktor.http.ContentType.Companion
Represents a pattern * / * to match any content type.
getAny() - Method in class io.ktor.http.ContentType.Image
 
getAny() - Method in class io.ktor.http.ContentType.Message
 
getAny() - Method in class io.ktor.http.ContentType.MultiPart
 
getAny() - Method in class io.ktor.http.ContentType.Text
 
getAny() - Method in class io.ktor.http.ContentType.Video
 
getAtom() - Method in class io.ktor.http.ContentType.Application
 
getAttachment() - Method in class io.ktor.http.ContentDisposition.Companion
Content-Disposition: attachment
getAuthenticationInfo() - Method in class io.ktor.http.HttpHeaders
 
getAuthorization() - Method in class io.ktor.http.HttpHeaders
 
getAuthScheme() - Method in class io.ktor.http.auth.HttpAuthHeader
auth scheme,
getBadGateway() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getBadRequest() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getBlob() - Method in class io.ktor.http.auth.HttpAuthHeader.Single
contains single token 68,
getByName() - Method in class io.ktor.http.URLProtocol.Companion
Protocols by names map
getByteRanges() - Method in class io.ktor.http.ContentType.MultiPart
 
getCacheControl() - Method in class io.ktor.http.content.CachingOptions
header
getCacheControl() - Method in class io.ktor.http.HttpHeaders
 
getCaching($receiver) - Static method in class io.ktor.http.content.CachingOptionsKt
Gets or sets class CacheControl instance as an extension property on this content
getCachingProperty() - Static method in class io.ktor.http.content.CachingOptionsKt
Specifies a key for CacheControl extension property for class OutgoingContent
getCaseInsensitiveName() - Method in class io.ktor.http.EmptyHeaders
Deprecated.
 
getCaseInsensitiveName() - Method in class io.ktor.http.EmptyParameters
Deprecated.
 
getConflict() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getConnection() - Method in class io.ktor.http.HttpHeaders
 
getContent() - Method in class io.ktor.http.HeaderValueWithParameters
header
getContentDisposition() - Method in class io.ktor.http.content.PartData
Parsed Content-Disposition header or null if missing
getContentDisposition() - Method in class io.ktor.http.HttpHeaders
 
getContentEncoding() - Method in class io.ktor.http.HttpHeaders
 
getContentLanguage() - Method in class io.ktor.http.HttpHeaders
 
getContentLength() - Method in class io.ktor.http.content.ByteArrayContent
Specifies content length in bytes for this resource.
getContentLength() - Method in class io.ktor.http.content.JarFileContent
Specifies content length in bytes for this resource.
getContentLength() - Method in class io.ktor.http.content.LocalFileContent
Specifies content length in bytes for this resource.
getContentLength() - Method in class io.ktor.http.content.OutgoingContent
Specifies content length in bytes for this resource.
getContentLength() - Method in class io.ktor.http.content.TextContent
Specifies content length in bytes for this resource.
getContentLength() - Method in class io.ktor.http.HttpHeaders
 
getContentLocation() - Method in class io.ktor.http.HttpHeaders
 
getContentRange() - Method in class io.ktor.http.HttpHeaders
 
getContentSubtype() - Method in class io.ktor.http.ContentType
represents a subtype part of the media type.
getContentType() - Method in class io.ktor.http.content.ByteArrayContent
Specifies
getContentType() - Method in class io.ktor.http.content.JarFileContent
Specifies
getContentType() - Method in class io.ktor.http.content.LocalFileContent
Specifies
getContentType() - Method in class io.ktor.http.content.OutgoingContent
Specifies class ContentType for this resource.
getContentType() - Method in class io.ktor.http.content.PartData
Parsed Content-Type header or null if missing
getContentType() - Method in class io.ktor.http.content.TextContent
Specifies
getContentType() - Method in class io.ktor.http.content.URIFileContent
Specifies
getContentType() - Method in class io.ktor.http.content.WriterContent
Specifies
getContentType() - Method in class io.ktor.http.ContentType
represents a type part of the media type.
getContentType() - Method in class io.ktor.http.HttpHeaders
 
getContinue() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getCookie() - Method in class io.ktor.http.HttpHeaders
 
getCreated() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getCSS() - Method in class io.ktor.http.ContentType.Text
 
getCSV() - Method in class io.ktor.http.ContentType.Text
 
getDASL() - Method in class io.ktor.http.HttpHeaders
 
getDate() - Method in class io.ktor.http.HttpHeaders
 
getDAV() - Method in class io.ktor.http.HttpHeaders
 
getDefaultMethods() - Method in class io.ktor.http.HttpMethod.Companion
A list of default HTTP methods
getDefaultPort() - Method in class io.ktor.http.URLProtocol
default port for protocol or
getDelete() - Method in class io.ktor.http.HttpMethod.Companion
 
getDepth() - Method in class io.ktor.http.HttpHeaders
 
getDescription() - Method in class io.ktor.http.HttpStatusCode
is free form description of a status.
getDestination() - Method in class io.ktor.http.HttpHeaders
 
getDispose() - Method in class io.ktor.http.content.PartData
to be invoked when this part is no longed needed
getDisposition() - Method in class io.ktor.http.ContentDisposition
Content disposition value without parameters
getDomain() - Method in class io.ktor.http.Cookie
for which it is set
getEmpty() - Method in class io.ktor.http.Headers.Companion
Empty interface Headers instance
getEmpty() - Method in class io.ktor.http.Parameters.Companion
Empty interface Parameters instance
getEncodedPath() - Method in class io.ktor.http.Url
encoded path without query string
getEncodedPath() - Method in class io.ktor.http.URLBuilder
encoded URL path without query
getEncoding() - Method in class io.ktor.http.auth.HttpAuthHeader.Parameterized
parameters encoding method,
getEncoding() - Method in class io.ktor.http.Cookie
cookie encoding type
getEncrypted() - Method in class io.ktor.http.ContentType.MultiPart
 
getEtag() - Method in class io.ktor.http.content.EntityTagVersion
entity tag, for example file's content hash
getETag() - Method in class io.ktor.http.HttpHeaders
 
getEventStream() - Method in class io.ktor.http.ContentType.Text
 
getExceptionFailed($receiver) - Static method in class io.ktor.http.HttpStatusCodeKt
Deprecated. 
getExpect() - Method in class io.ktor.http.HttpHeaders
 
getExpectationFailed() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getExpires() - Method in class io.ktor.http.content.CachingOptions
header
getExpires() - Method in class io.ktor.http.Cookie
date when it expires
getExpires() - Method in class io.ktor.http.HttpHeaders
 
getExtensions() - Method in class io.ktor.http.Cookie
additional cookie extensions
getFailedDependency() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getFile() - Method in class io.ktor.http.content.LocalFileContent
specifies the File to be served to a client
getFile() - Method in class io.ktor.http.ContentDisposition.Companion
Content-Disposition: file
getFontWoff() - Method in class io.ktor.http.ContentType.Application
 
getForbidden() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getFormData() - Method in class io.ktor.http.ContentType.MultiPart
 
getFormUrlEncoded() - Method in class io.ktor.http.ContentType.Application
 
getForwarded() - Method in class io.ktor.http.HttpHeaders
 
getFound() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getFragment() - Method in class io.ktor.http.Url
URL fragment
getFragment() - Method in class io.ktor.http.URLBuilder
URL fragment
getFrom() - Method in class io.ktor.http.ContentRange.Bounded
index from which the content should begin
getFrom() - Method in class io.ktor.http.ContentRange.TailFrom
index from which the content should begin
getFrom() - Method in class io.ktor.http.HttpHeaders
 
getFullPath($receiver) - Static method in class io.ktor.http.URLUtilsKt
Full encoded path with query string but without domain, port and schema
getGatewayTimeout() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getGet() - Method in class io.ktor.http.HttpMethod.Companion
 
getGIF() - Method in class io.ktor.http.ContentType.Image
 
getGone() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getGZip() - Method in class io.ktor.http.ContentType.Application
 
getHead() - Method in class io.ktor.http.HttpMethod.Companion
 
getHeaders() - Method in class io.ktor.http.content.OutgoingContent
Headers to set when sending this content
getHeaders() - Method in class io.ktor.http.content.PartData
of this part,
getHeaders() - Method in interface io.ktor.http.HttpMessage
getHeaders() - Method in interface io.ktor.http.HttpMessageBuilder
MessageBuilder class HeadersBuilder
getHost() - Method in class io.ktor.http.HttpHeaders
 
getHost() - Method in interface io.ktor.http.RequestConnectionPoint
Request host, useful for virtual hosts routing
getHost() - Method in class io.ktor.http.Url
name without port
getHost() - Method in class io.ktor.http.URLBuilder
name without port
getHostWithPort($receiver) - Static method in class io.ktor.http.URLUtilsKt
Host:port pair, not normalized so port is always specified even if the port is schema's default
getHtml() - Method in class io.ktor.http.ContentType.Text
 
getHttp() - Method in class io.ktor.http.ContentType.Message
 
getHTTP() - Method in class io.ktor.http.URLProtocol.Companion
HTTP with port 80
getHTTP2Settings() - Method in class io.ktor.http.HttpHeaders
 
getHTTP_1_0() - Method in class io.ktor.http.HttpProtocolVersion.Companion
HTTP/1.0 version.
getHTTP_1_1() - Method in class io.ktor.http.HttpProtocolVersion.Companion
HTTP/1.1 version.
getHTTP_2_0() - Method in class io.ktor.http.HttpProtocolVersion.Companion
HTTP/2.0 version.
getHttpDateFormat() - Static method in class io.ktor.http.HttpDateKt
Default HTTP date format
getHttpOnly() - Method in class io.ktor.http.Cookie
only transfer cookie over HTTP,
getHTTPS() - Method in class io.ktor.http.URLProtocol.Companion
secure HTTPS with port 443
getIf() - Method in class io.ktor.http.HttpHeaders
 
getIfMatch() - Method in class io.ktor.http.HttpHeaders
 
getIfModifiedSince() - Method in class io.ktor.http.HttpHeaders
 
getIfNoneMatch() - Method in class io.ktor.http.HttpHeaders
 
getIfRange() - Method in class io.ktor.http.HttpHeaders
 
getIfScheduleTagMatch() - Method in class io.ktor.http.HttpHeaders
 
getIfUnmodifiedSince() - Method in class io.ktor.http.HttpHeaders
 
getInline() - Method in class io.ktor.http.ContentDisposition.Companion
Content-Disposition: inline
getInsufficientStorage() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getInternalServerError() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getJarFile() - Method in class io.ktor.http.content.JarFileContent
is an instance of
getJavaScript() - Method in class io.ktor.http.ContentType.Application
 
getJavaScript() - Method in class io.ktor.http.ContentType.Text
 
getJPEG() - Method in class io.ktor.http.ContentType.Image
 
getJson() - Method in class io.ktor.http.ContentType.Application
 
getLastCount() - Method in class io.ktor.http.ContentRange.Suffix
number of tail bytes
getLastModified() - Method in class io.ktor.http.content.LastModifiedVersion
of the current content,
getLastModified() - Method in class io.ktor.http.HttpHeaders
 
getLengthRequired() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getLink() - Method in class io.ktor.http.HttpHeaders
 
getLocation() - Method in class io.ktor.http.HttpHeaders
 
getLocked() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getLockToken() - Method in class io.ktor.http.HttpHeaders
 
getMajor() - Method in class io.ktor.http.HttpProtocolVersion
specifies protocol major version.
getMaxAge() - Method in class io.ktor.http.Cookie
number of seconds to keep cookie
getMaxAgeSeconds() - Method in class io.ktor.http.CacheControl.MaxAge
max-age in seconds
getMaxForwards() - Method in class io.ktor.http.HttpHeaders
 
getMethod() - Method in interface io.ktor.http.RequestConnectionPoint
Request HTTP method
getMethodNotAllowed() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getMIMEVersion() - Method in class io.ktor.http.HttpHeaders
 
getMinor() - Method in class io.ktor.http.HttpProtocolVersion
specifies protocol minor version.
getMixed() - Method in class io.ktor.http.ContentDisposition.Companion
Content-Disposition: mixed
getMixed() - Method in class io.ktor.http.ContentType.MultiPart
 
getMovedPermanently() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getMP4() - Method in class io.ktor.http.ContentType.Audio
 
getMP4() - Method in class io.ktor.http.ContentType.Video
 
getMPEG() - Method in class io.ktor.http.ContentType.Audio
 
getMPEG() - Method in class io.ktor.http.ContentType.Video
 
getMultipleChoices() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getMultiStatus() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getMustRevalidate() - Method in class io.ktor.http.CacheControl.MaxAge
true
getName() - Method in class io.ktor.http.content.PartData
Optional part name based on Content-Disposition header
getName() - Method in class io.ktor.http.ContentDisposition
Content disposition name (from parameter named name)
getName() - Method in class io.ktor.http.Cookie
 
getName() - Method in class io.ktor.http.HeaderValueParam
of parameter
getName() - Method in class io.ktor.http.HttpProtocolVersion
specifies name of the protocol,
getName() - Method in class io.ktor.http.URLProtocol
of protocol
getNoContent() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getNonAuthoritativeInformation() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getNotAcceptable() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getNotFound() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getNotImplemented() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getNotModified() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getOctetStream() - Method in class io.ktor.http.ContentType.Application
 
getOGG() - Method in class io.ktor.http.ContentType.Audio
 
getOGG() - Method in class io.ktor.http.ContentType.Video
 
getOK() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getOptions() - Method in class io.ktor.http.HttpMethod.Companion
 
getOrderingType() - Method in class io.ktor.http.HttpHeaders
 
getOrigin() - Method in class io.ktor.http.HttpHeaders
 
getOriginalFileName() - Method in class io.ktor.http.content.PartData.FileItem
Original file name if present
getOverwrite() - Method in class io.ktor.http.HttpHeaders
 
getParameters() - Method in class io.ktor.http.auth.HttpAuthHeader.Parameterized
a list of auth parameters
getParameters() - Method in class io.ktor.http.HeaderValueWithParameters
 
getParameters() - Method in class io.ktor.http.Url
URL query parameters
getParameters() - Method in class io.ktor.http.URLBuilder
URL query parameters
getParams() - Method in class io.ktor.http.HeaderValue
for this value
getPartHeaders() - Method in class io.ktor.http.content.PartData
Deprecated. 
getPartialContent() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getPartName() - Method in class io.ktor.http.content.PartData
Deprecated. 
getPassword() - Method in class io.ktor.http.Url
password part of URL
getPassword() - Method in class io.ktor.http.URLBuilder
password part
getPatch() - Method in class io.ktor.http.HttpMethod.Companion
 
getPath() - Method in class io.ktor.http.Cookie
for which it is set
getPayloadTooLarge() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getPaymentRequired() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getPermanentRedirect() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getPlain() - Method in class io.ktor.http.ContentType.Text
 
getPNG() - Method in class io.ktor.http.ContentType.Image
 
getPort() - Method in interface io.ktor.http.RequestConnectionPoint
Request port, for example 80 or 443
getPort() - Method in class io.ktor.http.Url
the specified port or protocol default port
getPort() - Method in class io.ktor.http.URLBuilder
port number
getPosition() - Method in class io.ktor.http.HttpHeaders
 
getPost() - Method in class io.ktor.http.HttpMethod.Companion
 
getPragma() - Method in class io.ktor.http.HttpHeaders
 
getPreconditionFailed() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getPrefer() - Method in class io.ktor.http.HttpHeaders
 
getPreferenceApplied() - Method in class io.ktor.http.HttpHeaders
 
getProcessing() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getProperty(key) - Method in class io.ktor.http.content.OutgoingContent
Gets an extension property for this content
getProtocol() - Method in class io.ktor.http.Url
 
getProtocol() - Method in class io.ktor.http.URLBuilder
URL protocol
getProvider() - Method in class io.ktor.http.content.PartData.BinaryItem
of content bytes
getProvider() - Method in class io.ktor.http.content.PartData.FileItem
of content bytes
getProxyAuthenticate() - Method in class io.ktor.http.HttpHeaders
 
getProxyAuthenticationInfo() - Method in class io.ktor.http.HttpHeaders
 
getProxyAuthenticationRequired() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getProxyAuthorization() - Method in class io.ktor.http.HttpHeaders
 
getProxyMaxAgeSeconds() - Method in class io.ktor.http.CacheControl.MaxAge
max-age in seconds for caching proxies
getProxyRevalidate() - Method in class io.ktor.http.CacheControl.MaxAge
true
getPublicKeyPins() - Method in class io.ktor.http.HttpHeaders
 
getPublicKeyPinsReportOnly() - Method in class io.ktor.http.HttpHeaders
 
getPut() - Method in class io.ktor.http.HttpMethod.Companion
 
getQuality() - Method in class io.ktor.http.HeaderValue
Value's quality according to q parameter or 1.0 if missing
getQUIC() - Method in class io.ktor.http.HttpProtocolVersion.Companion
QUIC/1.0 version.
getQuickTime() - Method in class io.ktor.http.ContentType.Video
 
getRange() - Method in class io.ktor.http.HttpHeaders
 
getRanges() - Method in class io.ktor.http.RangesSpecifier
a list of requested ranges
getReferrer() - Method in class io.ktor.http.HttpHeaders
 
getRelated() - Method in class io.ktor.http.ContentType.MultiPart
 
getRemoteHost() - Method in interface io.ktor.http.RequestConnectionPoint
Client address or host name (generally not resolved to name for performance reasons). For io.ktor.application.ApplicationRequest.local instance could point to a proxy our application running behind. NEVER use it for user authentication as it can be easily falsified (user can simply set some HTTP headers such as X-Forwarded-Host so you should NEVER rely on it in any security checks. If you are going to use it to create a back-connection please do it with care as an offender can easily use it to force you to connect to some host that is not intended to be connected to so that may cause serious consequences.
getRequestedRangeNotSatisfiable() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getRequestHeaderFieldTooLarge() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getRequestTimeout() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getRequestURITooLong() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getResetContent() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getResourcePath() - Method in class io.ktor.http.content.JarFileContent
is an instance of a resource inside a Jar file
getRetryAfter() - Method in class io.ktor.http.HttpHeaders
 
getRss() - Method in class io.ktor.http.ContentType.Application
 
getScheduleReply() - Method in class io.ktor.http.HttpHeaders
 
getScheduleTag() - Method in class io.ktor.http.HttpHeaders
 
getScheme() - Method in interface io.ktor.http.RequestConnectionPoint
Request scheme, for example "http" or "https"
getSecure() - Method in class io.ktor.http.Cookie
send it via secure connection only
getSecWebSocketAccept() - Method in class io.ktor.http.HttpHeaders
 
getSecWebSocketExtensions() - Method in class io.ktor.http.HttpHeaders
 
getSecWebSocketKey() - Method in class io.ktor.http.HttpHeaders
 
getSecWebSocketProtocol() - Method in class io.ktor.http.HttpHeaders
 
getSecWebSocketVersion() - Method in class io.ktor.http.HttpHeaders
 
getSeeOther() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getServer() - Method in class io.ktor.http.HttpHeaders
 
getServiceUnavailable() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getSetCookie() - Method in class io.ktor.http.HttpHeaders
 
getSigned() - Method in class io.ktor.http.ContentType.MultiPart
 
getSLUG() - Method in class io.ktor.http.HttpHeaders
 
getSPDY_3() - Method in class io.ktor.http.HttpProtocolVersion.Companion
SPDY/3.0 version.
getSpecifiedPort() - Method in class io.ktor.http.Url
port number that was specified to override protocol
getStatus() - Method in class io.ktor.http.content.ByteArrayContent
Status code to set when sending this content
getStatus() - Method in class io.ktor.http.content.OutgoingContent
Status code to set when sending this content
getStatus() - Method in class io.ktor.http.content.OutgoingContent.ProtocolUpgrade
Status code to set when sending this content
getStatus() - Method in class io.ktor.http.content.TextContent
Status code to set when sending this content
getStatus() - Method in class io.ktor.http.content.WriterContent
Status code to set when sending this content
getStatusCode() - Method in enum io.ktor.http.content.VersionCheckResult
represents
getStreamProvider($receiver) - Static method in class io.ktor.http.content.MultipartJvmKt
Provides file item's content as an InputStream
getStrictTransportSecurity() - Method in class io.ktor.http.HttpHeaders
 
getSVG() - Method in class io.ktor.http.ContentType.Image
 
getSwitchingProtocols() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getSwitchProxy() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getTE() - Method in class io.ktor.http.HttpHeaders
 
getTemporaryRedirect() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getText() - Method in class io.ktor.http.content.TextContent
to be sent
getTimeout() - Method in class io.ktor.http.HttpHeaders
 
getTo() - Method in class io.ktor.http.ContentRange.Bounded
the last index the content should end at
getTooManyRequests() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getTrailer() - Method in class io.ktor.http.HttpHeaders
 
getTrailingQuery() - Method in class io.ktor.http.Url
keep trailing question character even if there are no query parameters
getTrailingQuery() - Method in class io.ktor.http.URLBuilder
keep a trailing question character even if there are no query parameters
getTransferEncoding() - Method in class io.ktor.http.HttpHeaders
 
getUnauthorized() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getUnit() - Method in class io.ktor.http.RangesSpecifier
range units,
getUnitToken() - Method in enum io.ktor.http.RangeUnits
Lower-case unit name
getUnprocessableEntity() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getUnsafeHeaders() - Method in class io.ktor.http.HttpHeaders
 
getUnsupportedMediaType() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getUpgrade() - Method in class io.ktor.http.HttpHeaders
 
getUpgradeRequired() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getUri() - Method in class io.ktor.http.content.URIFileContent
that is used as a source
getUri() - Method in class io.ktor.http.LinkHeader
Link URI part
getUri() - Method in interface io.ktor.http.RequestConnectionPoint
URI path with no host, port and no schema specification, but possibly with query
getUseProxy() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getUser() - Method in class io.ktor.http.Url
username part of URL
getUser() - Method in class io.ktor.http.URLBuilder
username part
getUserAgent() - Method in class io.ktor.http.HttpHeaders
 
getValue() - Method in class io.ktor.http.content.PartData.FormItem
of this field
getValue() - Method in class io.ktor.http.Cookie
 
getValue() - Method in class io.ktor.http.HeaderValue
 
getValue() - Method in class io.ktor.http.HeaderValueParam
of parameter
getValue() - Method in class io.ktor.http.HttpMethod
contains method name
getValue() - Method in class io.ktor.http.HttpStatusCode
is a numeric code.
getVariantAlsoNegotiates() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getVary() - Method in class io.ktor.http.HttpHeaders
 
getVCard() - Method in class io.ktor.http.ContentType.Text
 
getVersion() - Method in interface io.ktor.http.RequestConnectionPoint
Protocol version string
getVersionListProperty() - Static method in class io.ktor.http.content.VersionsKt
Specifies a key for VersionList extension property for class OutgoingContent
getVersionNotSupported() - Method in class io.ktor.http.HttpStatusCode.Companion
 
getVersions($receiver) - Static method in class io.ktor.http.content.VersionsKt
Gets or sets list of interface Version instances as an extension property on this content
getVia() - Method in class io.ktor.http.HttpHeaders
 
getVisibility() - Method in class io.ktor.http.CacheControl
specifies an optional visibility such as private or public
getWarning() - Method in class io.ktor.http.HttpHeaders
 
getWS() - Method in class io.ktor.http.URLProtocol.Companion
Web socket over HTTP on port 80
getWSS() - Method in class io.ktor.http.URLProtocol.Companion
Web socket over secure HTTPS on port 443
getWWWAuthenticate() - Method in class io.ktor.http.HttpHeaders
 
getXCorrelationId() - Method in class io.ktor.http.HttpHeaders
 
getXForwardedFor() - Method in class io.ktor.http.HttpHeaders
 
getXForwardedHost() - Method in class io.ktor.http.HttpHeaders
 
getXForwardedProto() - Method in class io.ktor.http.HttpHeaders
 
getXForwardedServer() - Method in class io.ktor.http.HttpHeaders
 
getXHttpMethodOverride() - Method in class io.ktor.http.HttpHeaders
 
getXIcon() - Method in class io.ktor.http.ContentType.Image
 
getXml() - Method in class io.ktor.http.ContentType.Application
 
getXml() - Method in class io.ktor.http.ContentType.Text
 
getXml_Dtd() - Method in class io.ktor.http.ContentType.Application
 
getXRequestId() - Method in class io.ktor.http.HttpHeaders
 
getZip() - Method in class io.ktor.http.ContentType.Application
 

H

Handling - Static variable in class io.ktor.http.ContentDisposition.Parameters
 
hashCode() - Method in class io.ktor.http.auth.HttpAuthHeader.Parameterized
 
hashCode() - Method in class io.ktor.http.auth.HttpAuthHeader.Single
 
hashCode() - Method in class io.ktor.http.content.CachingOptions
 
hashCode() - Method in class io.ktor.http.content.EntityTagVersion
 
hashCode() - Method in class io.ktor.http.content.LastModifiedVersion
 
hashCode() - Method in class io.ktor.http.ContentDisposition
 
hashCode() - Method in class io.ktor.http.ContentRange.Bounded
 
hashCode() - Method in class io.ktor.http.ContentRange.Suffix
 
hashCode() - Method in class io.ktor.http.ContentRange.TailFrom
 
hashCode() - Method in class io.ktor.http.ContentType
 
hashCode() - Method in class io.ktor.http.Cookie
 
hashCode() - Method in class io.ktor.http.HeaderValue
 
hashCode() - Method in class io.ktor.http.HeaderValueParam
 
hashCode() - Method in class io.ktor.http.HttpMethod
 
hashCode() - Method in class io.ktor.http.HttpProtocolVersion
 
hashCode() - Method in class io.ktor.http.HttpStatusCode
 
hashCode() - Method in class io.ktor.http.RangesSpecifier
 
hashCode() - Method in class io.ktor.http.Url
 
hashCode() - Method in class io.ktor.http.URLProtocol
 
Headers - Interface in io.ktor.http
Represents HTTP headers as a map from case-insensitive names to collection of String values
Headers.Companion - Class in io.ktor.http
 
HeadersBuilder - Class in io.ktor.http
 
HeadersBuilder(size) - Constructor for class io.ktor.http.HeadersBuilder
 
HeadersBuilder() - Constructor for class io.ktor.http.HeadersBuilder
 
HeadersImpl - Class in io.ktor.http
 
HeadersImpl(values) - Constructor for class io.ktor.http.HeadersImpl
 
HeadersImpl() - Constructor for class io.ktor.http.HeadersImpl
 
HeadersKt - Class in io.ktor.http
 
headersOf() - Static method in class io.ktor.http.HeadersKt
Returns empty headers
headersOf(name, value) - Static method in class io.ktor.http.HeadersKt
Returns interface Headers instance containing only one header with the specified name and value
headersOf(name, values) - Static method in class io.ktor.http.HeadersKt
Returns interface Headers instance containing only one header with the specified name and values
headersOf(pairs) - Static method in class io.ktor.http.HeadersKt
Returns interface Headers instance from pairs
HeadersSingleImpl - Class in io.ktor.http
 
HeadersSingleImpl(name, values) - Constructor for class io.ktor.http.HeadersSingleImpl
 
HeaderValue - Class in io.ktor.http
Represents a header value. Similar to class HeaderValueWithParameters
HeaderValue(value, params) - Constructor for class io.ktor.http.HeaderValue
Represents a header value. Similar to class HeaderValueWithParameters
HeaderValueEncoding - Enum in io.ktor.http.auth
Describes how a header should be encoded.
HeaderValueEncoding() - Constructor for enum io.ktor.http.auth.HeaderValueEncoding
Describes how a header should be encoded.
HeaderValueParam - Class in io.ktor.http
Represents a single value parameter
HeaderValueParam(name, value) - Constructor for class io.ktor.http.HeaderValueParam
Represents a single value parameter
HeaderValueWithParameters - Class in io.ktor.http
Represents a header value that consist of content followed by parameters. Useful for headers such as Content-Type, Content-Disposition and so on.
HeaderValueWithParameters(content, parameters) - Constructor for class 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.
HeaderValueWithParameters.Companion - Class in io.ktor.http
 
HeaderValueWithParametersKt - Class in io.ktor.http
 
hostIsIp(host) - Static method in class io.ktor.http.IpParserKt
Check if host is IPv4 or IPv6 address.
HrefLang - Static variable in class io.ktor.http.LinkHeader.Parameters
 
HttpAuthHeader - Class in io.ktor.http.auth
Describes an authentication header with a mandatory authScheme that usually is a standard class AuthScheme.
HttpAuthHeader.Companion - Class in io.ktor.http.auth
 
HttpAuthHeader.Parameterized - Class in io.ktor.http.auth
Describes a parameterized authentication header that is represented by a set of parameters encoded with encoding.
HttpAuthHeader.Parameters - Class in io.ktor.http.auth
Standard parameters for class HttpAuthHeader.
HttpAuthHeader.Single - Class in io.ktor.http.auth
Describes an authentication header that is represented by a single blob.
HttpAuthHeaderKt - Class in io.ktor.http.auth
 
HttpDateKt - Class in io.ktor.http
 
HttpHeaders - Class in io.ktor.http
 
HttpHeaderValueParserKt - Class in io.ktor.http
 
HttpMessage - Interface in io.ktor.http
A message either from the client or the server, that has HttpMessage.getHeaders associated.
HttpMessageBuilder - Interface in io.ktor.http
A builder message either for the client or the server, that has a HttpMessageBuilder.getHeaders builder associated.
HttpMessagePropertiesJvmKt - Class in io.ktor.http
 
HttpMessagePropertiesKt - Class in io.ktor.http
 
HttpMethod - Class in io.ktor.http
Represents an HTTP method (verb)
HttpMethod(value) - Constructor for class io.ktor.http.HttpMethod
Represents an HTTP method (verb)
HttpMethod.Companion - Class in io.ktor.http
 
HttpProtocolVersion - Class in io.ktor.http
Represents an HTTP protocol version.
HttpProtocolVersion(name, major, minor) - Constructor for class io.ktor.http.HttpProtocolVersion
Represents an HTTP protocol version.
HttpProtocolVersion.Companion - Class in io.ktor.http
 
HttpStatusCode - Class in io.ktor.http
Represents an HTTP status code and description.
HttpStatusCode(value, description) - Constructor for class io.ktor.http.HttpStatusCode
Represents an HTTP status code and description.
HttpStatusCode.Companion - Class in io.ktor.http
 
HttpStatusCodeKt - Class in io.ktor.http
 
HttpUrlEncodedKt - Class in io.ktor.http
 

I

ifModifiedSince($receiver, date) - Static method in class io.ktor.http.HttpMessagePropertiesJvmKt
Set If-Modified-Since header
ifNoneMatch($receiver, value) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Set If-None-Match header value
INSTANCE - Static variable in class io.ktor.http.auth.AuthScheme
Contains the standard auth schemes.
INSTANCE - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
Standard parameters for class HttpAuthHeader.
INSTANCE - Static variable in class io.ktor.http.content.MultiPartData.Empty
An empty multipart data stream
INSTANCE - Static variable in class io.ktor.http.ContentDisposition.Parameters
Frequently used content disposition parameter names
INSTANCE - Static variable in class io.ktor.http.ContentType.Application
Provides a list of standard subtypes of an application content type.
INSTANCE - Static variable in class io.ktor.http.ContentType.Audio
Provides a list of standard subtypes of an audio content type.
INSTANCE - Static variable in class io.ktor.http.ContentType.Image
Provides a list of standard subtypes of an image content type.
INSTANCE - Static variable in class io.ktor.http.ContentType.Message
Provides a list of standard subtypes of a message content type.
INSTANCE - Static variable in class io.ktor.http.ContentType.MultiPart
Provides a list of standard subtypes of a multipart content type.
INSTANCE - Static variable in class io.ktor.http.ContentType.Text
Provides a list of standard subtypes of a text content type.
INSTANCE - Static variable in class io.ktor.http.ContentType.Video
Provides a list of standard subtypes of a video content type.
INSTANCE - Static variable in class io.ktor.http.EmptyHeaders
Deprecated.
 
INSTANCE - Static variable in class io.ktor.http.EmptyParameters
Deprecated.
 
INSTANCE - Static variable in class io.ktor.http.HttpHeaders
 
INSTANCE - Static variable in class io.ktor.http.LinkHeader.Parameters
Known Link header parameters
INSTANCE - Static variable in class io.ktor.http.LinkHeader.Rel
Known rel parameter values
invoke($receiver, fullUrl) - Static method in class io.ktor.http.URLBuilderJvmKt
Construct class Url from String
io.ktor.content - package io.ktor.content
 
io.ktor.http - package io.ktor.http
 
io.ktor.http.auth - package io.ktor.http.auth
 
io.ktor.http.content - package io.ktor.http.content
 
io.ktor.http.websocket - package io.ktor.http.websocket
 
IpParserKt - Class in io.ktor.http
 
isEmpty() - Method in class io.ktor.http.EmptyHeaders
Deprecated.
 
isEmpty() - Method in class io.ktor.http.EmptyParameters
Deprecated.
 
isSecure($receiver) - Static method in class io.ktor.http.URLProtocolKt
Check if the protocol is secure
isSuccess($receiver) - Static method in class io.ktor.http.HttpStatusCodeKt
Checks if a given status code is a success code according to HTTP standards.
isUnsafe(header) - Method in class io.ktor.http.HttpHeaders
Check if header is unsafe. Header is unsafe if listed in HttpHeaders.getUnsafeHeaders
isValid(rangeUnitPredicate) - Method in class io.ktor.http.RangesSpecifier
Verify ranges
isWebsocket($receiver) - Static method in class io.ktor.http.URLProtocolKt
Check if the protocol is websocket

J

JarFileContent - Class in io.ktor.http.content
Represents an class OutgoingContent for a resource inside a Jar file
JarFileContent(jarFile, resourcePath, contentType) - Constructor for class io.ktor.http.content.JarFileContent
Represents an class OutgoingContent for a resource inside a Jar file
JarFileContent(zipFilePath, resourcePath, contentType) - Constructor for class io.ktor.http.content.JarFileContent
 

L

lastModified($receiver, dateTime) - Static method in class io.ktor.http.ApplicationResponsePropertiesJvmKt
Set 'Last-Modified` header value from dateTime
lastModified($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesJvmKt
Parse Last-Modified header
lastModified($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesJvmKt
Parse Last-Modified header
LastModifiedJavaTimeKt - Class in io.ktor.http.content
 
LastModifiedVersion(lastModified) - Static method in class io.ktor.http.content.LastModifiedJavaTimeKt
Construct class LastModifiedVersion version from a ZonedDateTime instance
LastModifiedVersion(lastModified) - Static method in class io.ktor.http.content.LastModifiedJavaTimeKt
Construct class LastModifiedVersion version from a FileTime instance
LastModifiedVersion - Class in io.ktor.http.content
This version passes the given lastModified date through the client provided http conditional headers If-Modified-Since and If-Unmodified-Since.
LastModifiedVersion(lastModified) - Constructor for class 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.
LastModifiedVersion(lastModified) - Constructor for class io.ktor.http.content.LastModifiedVersion
 
LinkHeader - Class in io.ktor.http
Represents a Link header value as per RFC 5988
LinkHeader(uri, params) - Constructor for class io.ktor.http.LinkHeader
Represents a Link header value as per RFC 5988
LinkHeader(uri, rel) - Constructor for class io.ktor.http.LinkHeader
 
LinkHeader(uri, rel) - Constructor for class io.ktor.http.LinkHeader
 
LinkHeader(uri, rel, type) - Constructor for class io.ktor.http.LinkHeader
 
LinkHeader.Parameters - Class in io.ktor.http
Known Link header parameters
LinkHeader.Rel - Class in io.ktor.http
Known rel parameter values
LocalFileContent - Class in io.ktor.http.content
OutgoingContent representing a local file with a specified contentType, ApplicationResponsePropertiesJvmKt.expires date and CachingOptionsKt.getCaching
LocalFileContent(file, contentType) - Constructor for class io.ktor.http.content.LocalFileContent
OutgoingContent representing a local file with a specified contentType, ApplicationResponsePropertiesJvmKt.expires date and CachingOptionsKt.getCaching
LocalFileContent(baseDir, relativePath, contentType) - Static method in class io.ktor.http.content.LocalFileContentKt
Creates an instance of class LocalFileContent for a file designated by relativePath in a baseDir
LocalFileContent(baseDir, relativePath, contentType) - Static method in class io.ktor.http.content.LocalFileContentKt
Creates an instance of class LocalFileContent for a file designated by relativePath in a baseDir
LocalFileContentKt - Class in io.ktor.http.content
 

M

match(pattern) - Method in class io.ktor.http.ContentType
Checks if this type matches a pattern type taking into account placeholder symbols * and parameters.
match(pattern) - Method in class io.ktor.http.ContentType
Checks if this type matches a pattern type taking into account placeholder symbols * and parameters.
MaxAge(maxAgeSeconds, proxyMaxAgeSeconds, mustRevalidate, proxyRevalidate, visibility) - Constructor for class io.ktor.http.CacheControl.MaxAge
Represents a cache control value with the specified max ages and re-validation strategies
maxAge($receiver, seconds) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Append Max-Age header value
Media - Static variable in class io.ktor.http.LinkHeader.Parameters
 
merge(length, maxRangeCount) - Method in class io.ktor.http.RangesSpecifier
Resolve and merge all overlapping and neighbours ranges
merge(length) - Method in class io.ktor.http.RangesSpecifier
Merges all overlapping and neighbours ranges. Currently gaps collapse is not supported but should be, one day.
mergeToSingle(length) - Method in class io.ktor.http.RangesSpecifier
Merge all ranges into a single absolute long range
MimesKt - Class in io.ktor.http
 
ModificationDate - Static variable in class io.ktor.http.ContentDisposition.Parameters
 
MultiPartData - Interface in io.ktor.http.content
Represents a multipart data stream that could be received from a call
MultiPartData.Empty - Class in io.ktor.http.content
An empty multipart data stream
MultipartJvmKt - Class in io.ktor.http.content
 
MultipartKt - Class in io.ktor.http.content
 

N

Name - Static variable in class io.ktor.http.ContentDisposition.Parameters
 
names() - Method in class io.ktor.http.EmptyHeaders
Deprecated.
 
names() - Method in class io.ktor.http.EmptyParameters
Deprecated.
 
Negotiate - Static variable in class io.ktor.http.auth.AuthScheme
Described in the RFC-4599:
Next - Static variable in class io.ktor.http.LinkHeader.Rel
 
NoCache(visibility) - Constructor for class io.ktor.http.CacheControl.NoCache
Represents a no-cache cache control value
NoContent() - Constructor for class io.ktor.http.content.OutgoingContent.NoContent
Variant of a class OutgoingContent without a payload
NoStore(visibility) - Constructor for class io.ktor.http.CacheControl.NoStore
Represents a no-store cache control value

O

OAuth - Static variable in class io.ktor.http.auth.AuthScheme
OAuth Authentication described in the RFC-6749:
OAuthCallback - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OAuthCallbackConfirmed - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OAuthConsumerKey - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OAuthNonce - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OAuthSignature - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OAuthSignatureMethod - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OAuthTimestamp - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OAuthToken - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OAuthTokenSecret - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OAuthVerifier - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OAuthVersion - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
OutgoingContent - Class in io.ktor.http.content
Information about the content to be sent to the peer, recognized by a client or server engine
OutgoingContent.ByteArrayContent - Class in io.ktor.http.content
Variant of a class OutgoingContent with payload represented as ByteArray
OutgoingContent.NoContent - Class in io.ktor.http.content
Variant of a class OutgoingContent without a payload
OutgoingContent.ProtocolUpgrade - Class in io.ktor.http.content
Variant of a class OutgoingContent for upgrading an HTTP connection
OutgoingContent.ReadChannelContent - Class in io.ktor.http.content
Variant of a class OutgoingContent with payload read from ByteReadChannel
OutgoingContent.WriteChannelContent - Class in io.ktor.http.content
Variant of a class OutgoingContent with payload written to ByteWriteChannel

P

parameter(name) - Method in class io.ktor.http.auth.HttpAuthHeader.Parameterized
Tries to extract the first value of a parameter name. Returns null when not found.
parameter(name) - Method in class io.ktor.http.HeaderValueWithParameters
The first value for the parameter with name comparing case-insensitively or null if no such parameters found
Parameterized(authScheme, parameters, encoding) - Constructor for class io.ktor.http.auth.HttpAuthHeader.Parameterized
Describes a parameterized authentication header that is represented by a set of parameters encoded with encoding.
Parameterized(authScheme, parameters, encoding) - Constructor for class io.ktor.http.auth.HttpAuthHeader.Parameterized
 
Parameters - Interface in io.ktor.http
Represents HTTP parameters as a map from case-insensitive names to collection of String values
Parameters.Companion - Class in io.ktor.http
 
ParametersBuilder - Class in io.ktor.http
 
ParametersBuilder(size) - Constructor for class io.ktor.http.ParametersBuilder
 
ParametersBuilder() - Constructor for class io.ktor.http.ParametersBuilder
 
ParametersImpl - Class in io.ktor.http
 
ParametersImpl(values) - Constructor for class io.ktor.http.ParametersImpl
 
ParametersImpl() - Constructor for class io.ktor.http.ParametersImpl
 
ParametersKt - Class in io.ktor.http
 
parametersOf() - Static method in class io.ktor.http.ParametersKt
Returns an empty parameters instance
parametersOf(name, value) - Static method in class io.ktor.http.ParametersKt
Creates a parameters instance containing only single pair
parametersOf(name, values) - Static method in class io.ktor.http.ParametersKt
Creates a parameters instance containing only single pair of name with multiple values
parametersOf(pairs) - Static method in class io.ktor.http.ParametersKt
Creates a parameters instance from the specified pairs
ParametersSingleImpl - Class in io.ktor.http
 
ParametersSingleImpl(name, values) - Constructor for class io.ktor.http.ParametersSingleImpl
 
parse(value) - Method in class io.ktor.http.ContentDisposition.Companion
Parse Content-Disposition header value
parse(value) - Method in class io.ktor.http.ContentType.Companion
Parses a string representing a Content-Type header into a class ContentType instance.
parse(value, init) - Method in class io.ktor.http.HeaderValueWithParameters.Companion
Parse header with parameter and pass it to init function to instantiate particular type
parse(method) - Method in class io.ktor.http.HttpMethod.Companion
Parse HTTP method by method string
parseAndSortContentTypeHeader(header) - Static method in class io.ktor.http.HttpHeaderValueParserKt
Parse Content-Type header values and sort them by quality and asterisks quantity
parseAndSortHeader(header) - Static method in class io.ktor.http.HttpHeaderValueParserKt
Parse header value and sort multiple values according to qualities
parseAuthorizationHeader(headerValue) - Static method in class io.ktor.http.auth.HttpAuthHeaderKt
Parses an authorization header headerValue into a class HttpAuthHeader.
parseClientCookiesHeader(cookiesHeader, skipEscaped) - Static method in class io.ktor.http.CookieKt
Parse client's Cookie header value
parseHeaderValue(text) - Static method in class io.ktor.http.HttpHeaderValueParserKt
Parse header value respecting multi-values
parseHeaderValue(text, parametersOnly) - Static method in class io.ktor.http.HttpHeaderValueParserKt
Parse header value respecting multi-values
parseQueryString(query, startIndex, limit) - Static method in class io.ktor.http.QueryKt
Parse query string withing starting at the specified startIndex but up to limit pairs
parseRangesSpecifier(rangeSpec) - Static method in class io.ktor.http.RangesKt
Parse Range header value
parseServerSetCookieHeader(cookiesHeader) - Static method in class io.ktor.http.CookieKt
Parse server's Set-Cookie header value
parseUrlEncodedParameters($receiver, defaultEncoding, limit) - Static method in class io.ktor.http.HttpUrlEncodedKt
Parse URL query parameters. Shouldn't be used for urlencoded forms because of + character.
PartData - Class in io.ktor.http.content
Represents a multipart/form-data entry. Could be a class PartData.FormItem or class PartData.FileItem
PartData.BinaryItem - Class in io.ktor.http.content
Represents a binary item
PartData.FileItem - Class in io.ktor.http.content
Represents a file item
PartData.FormItem - Class in io.ktor.http.content
Represents a multipart form item
path(components) - Method in class io.ktor.http.URLBuilder
Encode components to encodedPath
path(components) - Method in class io.ktor.http.URLBuilder
Encode components to encodedPath
plus($receiver, other) - Static method in class io.ktor.http.ParametersKt
Plus operator function that creates a new parameters instance from the original one concatenating with other
PreConnect - Static variable in class io.ktor.http.LinkHeader.Rel
 
Prefetch - Static variable in class io.ktor.http.LinkHeader.Rel
 
PreLoad - Static variable in class io.ktor.http.LinkHeader.Rel
 
PreRender - Static variable in class io.ktor.http.LinkHeader.Rel
 
ProtocolUpgrade() - Constructor for class io.ktor.http.content.OutgoingContent.ProtocolUpgrade
Variant of a class OutgoingContent for upgrading an HTTP connection

Q

QueryKt - Class in io.ktor.http
 
quote($receiver) - Static method in class io.ktor.http.HeaderValueWithParametersKt
Escape string using double quotes

R

RangesKt - Class in io.ktor.http
 
RangesSpecifier - Class in io.ktor.http
Range specifier for partial content requests (RFC 2616 sec 14.35.1)
RangesSpecifier(unit, ranges) - Constructor for class io.ktor.http.RangesSpecifier
Range specifier for partial content requests (RFC 2616 sec 14.35.1)
RangesSpecifier(unit, ranges) - Constructor for class io.ktor.http.RangesSpecifier
 
RangeUnits - Enum in io.ktor.http
Possible content range units: bytes and none
RangeUnits() - Constructor for enum io.ktor.http.RangeUnits
Possible content range units: bytes and none
readAllParts($receiver, p) - Static method in class io.ktor.http.content.MultipartKt
Parse multipart data stream and put all parts into a list
ReadChannelContent() - Constructor for class io.ktor.http.content.OutgoingContent.ReadChannelContent
Variant of a class OutgoingContent with payload read from ByteReadChannel
ReadDate - Static variable in class io.ktor.http.ContentDisposition.Parameters
 
readFrom() - Method in class io.ktor.http.content.JarFileContent
Provides ByteReadChannel for the content
readFrom() - Method in class io.ktor.http.content.LocalFileContent
Provides ByteReadChannel for the content
readFrom(range) - Method in class io.ktor.http.content.LocalFileContent
Provides ByteReadChannel for the given range of the content
readFrom() - Method in class io.ktor.http.content.OutgoingContent.ReadChannelContent
Provides ByteReadChannel for the content
readFrom(range) - Method in class io.ktor.http.content.OutgoingContent.ReadChannelContent
Provides ByteReadChannel for the given range of the content
readFrom() - Method in class io.ktor.http.content.URIFileContent
Provides ByteReadChannel for the content
readPart(p) - Method in class io.ktor.http.content.MultiPartData.Empty
Reads next part data or null if end of multipart stream encountered
readPart(p) - Method in interface io.ktor.http.content.MultiPartData
Reads next part data or null if end of multipart stream encountered
Realm - Static variable in class io.ktor.http.auth.HttpAuthHeader.Parameters
 
Rel - Static variable in class io.ktor.http.LinkHeader.Parameters
 
render(encoding) - Method in class io.ktor.http.auth.HttpAuthHeader.Parameterized
Encodes the header with a specified encoding.
render() - Method in class io.ktor.http.auth.HttpAuthHeader.Parameterized
Encodes the header with the default enum HeaderValueEncoding for this header.
render(encoding) - Method in class io.ktor.http.auth.HttpAuthHeader
Encodes the header with a specified encoding.
render() - Method in class io.ktor.http.auth.HttpAuthHeader
Encodes the header with the default enum HeaderValueEncoding for this header.
render() - Method in class io.ktor.http.auth.HttpAuthHeader.Single
Encodes the header with the default enum HeaderValueEncoding for this header.
render(encoding) - Method in class io.ktor.http.auth.HttpAuthHeader.Single
Encodes the header with a specified encoding.
renderCookieHeader(cookie) - Static method in class io.ktor.http.CookieKt
Format Set-Cookie header value
renderSetCookieHeader(cookie) - Static method in class io.ktor.http.CookieKt
Format Set-Cookie header value
renderSetCookieHeader(name, value, encoding, maxAge, expires, domain, path, secure, httpOnly, extensions, includeEncoding) - Static method in class io.ktor.http.CookieKt
Format Set-Cookie header value
RequestConnectionPoint - Interface in io.ktor.http
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.
Rev - Static variable in class io.ktor.http.LinkHeader.Parameters
 

S

setCaching($receiver, value) - Static method in class io.ktor.http.content.CachingOptionsKt
Gets or sets class CacheControl instance as an extension property on this content
setCookie($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse Set-Cookie header value
setEncodedPath(p) - Method in class io.ktor.http.URLBuilder
encoded URL path without query
setFragment(p) - Method in class io.ktor.http.URLBuilder
URL fragment
setHost(p) - Method in class io.ktor.http.URLBuilder
name without port
setPassword(p) - Method in class io.ktor.http.URLBuilder
password part
setPort(p) - Method in class io.ktor.http.URLBuilder
port number
setProperty(key, value) - Method in class io.ktor.http.content.OutgoingContent
Sets an extension property for this content
setProtocol(p) - Method in class io.ktor.http.URLBuilder
URL protocol
setTrailingQuery(p) - Method in class io.ktor.http.URLBuilder
keep a trailing question character even if there are no query parameters
setUser(p) - Method in class io.ktor.http.URLBuilder
username part
setVersions($receiver, value) - Static method in class io.ktor.http.content.VersionsKt
Gets or sets list of interface Version instances as an extension property on this content
Single(authScheme, blob) - Constructor for class io.ktor.http.auth.HttpAuthHeader.Single
Describes an authentication header that is represented by a single blob.
Size - Static variable in class io.ktor.http.ContentDisposition.Parameters
 
Stylesheet - Static variable in class io.ktor.http.LinkHeader.Rel
 
Suffix(lastCount) - Constructor for class io.ktor.http.ContentRange.Suffix
Represents a Content-Range bounded by tail size

T

TailFrom(from) - Constructor for class io.ktor.http.ContentRange.TailFrom
Represents a Content-Range bounded at the beginning (skip first bytes, show tail)
takeFrom($receiver, urlString) - Static method in class io.ktor.http.URLParserKt
Take url parts from urlString throws exception URLParserException
takeFrom($receiver, uri) - Static method in class io.ktor.http.URLUtilsJvmKt
Take URI components from uri
takeFrom($receiver, url) - Static method in class io.ktor.http.URLUtilsJvmKt
Take URI components from url
takeFrom($receiver, url) - Static method in class io.ktor.http.URLUtilsKt
Take components from another url builder
takeFrom($receiver, url) - Static method in class io.ktor.http.URLUtilsKt
Take components from another url
TextContent - Class in io.ktor.http.content
Represents a text content that could be sent
TextContent(text, contentType, status) - Constructor for class io.ktor.http.content.TextContent
Represents a text content that could be sent
Title - Static variable in class io.ktor.http.LinkHeader.Parameters
 
toHeaderParamsList($receiver) - Static method in class io.ktor.http.HttpHeaderValueParserKt
Construct a list of class HeaderValueParam from an iterable of pairs
toHttpDate($receiver) - Static method in class io.ktor.http.DateUtilsKt
Convert GMTDate to valid http date String
toHttpDateString($receiver) - Static method in class io.ktor.http.HttpDateKt
Format epoch milliseconds as HTTP date (GMT)
toHttpDateString($receiver) - Static method in class io.ktor.http.HttpDateKt
Format as HTTP date (GMT)
toString() - Method in class io.ktor.http.auth.HttpAuthHeader
Encodes the header with the default enum HeaderValueEncoding for this header.
toString() - Method in class io.ktor.http.CacheControl.MaxAge
 
toString() - Method in class io.ktor.http.CacheControl.NoCache
 
toString() - Method in class io.ktor.http.CacheControl.NoStore
 
toString() - Method in class io.ktor.http.content.CachingOptions
 
toString() - Method in class io.ktor.http.content.EntityTagVersion
 
toString() - Method in class io.ktor.http.content.LastModifiedVersion
 
toString() - Method in class io.ktor.http.content.TextContent
 
toString() - Method in class io.ktor.http.ContentRange.Bounded
 
toString() - Method in class io.ktor.http.ContentRange.Suffix
 
toString() - Method in class io.ktor.http.ContentRange.TailFrom
 
toString() - Method in class io.ktor.http.Cookie
 
toString() - Method in class io.ktor.http.EmptyHeaders
Deprecated.
 
toString() - Method in class io.ktor.http.EmptyParameters
Deprecated.
 
toString() - Method in class io.ktor.http.HeadersImpl
 
toString() - Method in class io.ktor.http.HeadersSingleImpl
 
toString() - Method in class io.ktor.http.HeaderValue
 
toString() - Method in class io.ktor.http.HeaderValueParam
 
toString() - Method in class io.ktor.http.HeaderValueWithParameters
 
toString() - Method in class io.ktor.http.HttpMethod
 
toString() - Method in class io.ktor.http.HttpProtocolVersion
 
toString() - Method in class io.ktor.http.HttpStatusCode
 
toString() - Method in class io.ktor.http.ParametersImpl
 
toString() - Method in class io.ktor.http.ParametersSingleImpl
 
toString() - Method in class io.ktor.http.RangesSpecifier
 
toString() - Method in class io.ktor.http.Url
 
toString() - Method in class io.ktor.http.URLProtocol
 
toURI($receiver) - Static method in class io.ktor.http.URLUtilsJvmKt
Convert class Url to URI
Type - Static variable in class io.ktor.http.LinkHeader.Parameters
 

U

UnsafeHeaderException - Exception in io.ktor.http
Thrown when an attempt to set unsafe header detected. A header is unsafe if listed in HttpHeaders.getUnsafeHeaders.
UnsafeHeaderException(header) - Constructor for exception io.ktor.http.UnsafeHeaderException
Thrown when an attempt to set unsafe header detected. A header is unsafe if listed in HttpHeaders.getUnsafeHeaders.
upgrade(input, output, engineContext, userContext, p) - Method in class io.ktor.http.content.OutgoingContent.ProtocolUpgrade
Upgrades an HTTP connection
URIFileContent - Class in io.ktor.http.content
Represents a content that is served from the specified uri
URIFileContent(uri, contentType) - Constructor for class io.ktor.http.content.URIFileContent
Represents a content that is served from the specified uri
URIFileContent(url, contentType) - Constructor for class io.ktor.http.content.URIFileContent
 
Url - Class in io.ktor.http
Represents an immutable URL
Url(protocol, host, specifiedPort, encodedPath, parameters, fragment, user, password, trailingQuery) - Constructor for class io.ktor.http.Url
Represents an immutable URL
Url(urlString) - Static method in class io.ktor.http.URLUtilsKt
Construct class Url from urlString
Url.Companion - Class in io.ktor.http
 
URLBuilder - Class in io.ktor.http
A URL builder with all mutable components
URLBuilder(protocol, host, port, user, password, encodedPath, parameters, fragment, trailingQuery) - Constructor for class io.ktor.http.URLBuilder
A URL builder with all mutable components
URLBuilder() - Constructor for class io.ktor.http.URLBuilder
A URL builder with all mutable components
URLBuilder(urlString) - Static method in class io.ktor.http.URLUtilsKt
Construct class URLBuilder from urlString
URLBuilder.Companion - Class in io.ktor.http
 
URLBuilderJvmKt - Class in io.ktor.http
 
URLBuilderKt - Class in io.ktor.http
 
URLDecodeException - Exception in io.ktor.http
URL decoder exception
URLDecodeException(message) - Constructor for exception io.ktor.http.URLDecodeException
URL decoder exception
URLParserException - Exception in io.ktor.http
Thrown when failed to parse URL
URLParserException(urlString, cause) - Constructor for exception io.ktor.http.URLParserException
Thrown when failed to parse URL
URLParserKt - Class in io.ktor.http
 
URLProtocol - Class in io.ktor.http
Represents URL protocol
URLProtocol(name, defaultPort) - Constructor for class io.ktor.http.URLProtocol
Represents URL protocol
URLProtocol.Companion - Class in io.ktor.http
 
URLProtocolKt - Class in io.ktor.http
 
URLUtilsJvmKt - Class in io.ktor.http
 
URLUtilsKt - Class in io.ktor.http
 
userAgent($receiver, content) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Set User-Agent header value
UtilsKt - Class in io.ktor.http.websocket
 

V

vary($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse Vary header value
vary($receiver) - Static method in class io.ktor.http.HttpMessagePropertiesKt
Parse Vary header value
Version - Interface in io.ktor.http.content
Represents content version
VersionCheckResult - Enum in io.ktor.http.content
Represent result of the version comparison between content being sent and HTTP request.
VersionCheckResult(statusCode) - Constructor for enum io.ktor.http.content.VersionCheckResult
Represent result of the version comparison between content being sent and HTTP request.
VersionsKt - Class in io.ktor.http.content
 
Visibility() - Constructor for enum io.ktor.http.CacheControl.Visibility
Controls caching by proxies

W

websocketServerAccept(nonce) - Static method in class io.ktor.http.websocket.UtilsKt
Calculates Sec-WebSocket-Accept header value
withCharset($receiver, charset) - Static method in class io.ktor.http.ContentTypesKt
Creates a copy of this type with the added charset parameter with charset value.
withoutParameters() - Method in class io.ktor.http.ContentType
Creates a copy of this type without any parameters
withParameter(name, value) - Method in class io.ktor.http.auth.HttpAuthHeader.Parameterized
Copies this class HttpAuthHeader.Parameterized appending a new parameter name.
withParameter(key, value) - Method in class io.ktor.http.ContentDisposition
Creates new with parameter appended
withParameter(name, value) - Method in class io.ktor.http.ContentType
Creates a copy of this type with the added parameter with the name and value.
withParameters(newParameters) - Method in class io.ktor.http.ContentDisposition
Creates new with parameters appended
withReplacedParameter(name, value) - Method in class io.ktor.http.auth.HttpAuthHeader.Parameterized
Copies this class HttpAuthHeader.Parameterized replacing parameters with name assigning new value or appending if no such parameters found. If there were several pairs they will be reduced into a single pair at position of first occurrence discarding following pairs with this name.
WriteChannelContent() - Constructor for class io.ktor.http.content.OutgoingContent.WriteChannelContent
Variant of a class OutgoingContent with payload written to ByteWriteChannel
WriterContent - Class in io.ktor.http.content
Represents a content that is produced by body function
WriterContent(body, contentType, status) - Constructor for class io.ktor.http.content.WriterContent
Represents a content that is produced by body function
writeTo(channel, p) - Method in class io.ktor.http.content.OutgoingContent.WriteChannelContent
Receives channel provided by the engine and writes all data to it
writeTo(channel, p) - Method in class io.ktor.http.content.WriterContent
Receives channel provided by the engine and writes all data to it
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links