ktor
Toggle table of contents
3.1.0
Select version
3.1.0
3.0.3
3.0.2
3.0.0
2.3.12
2.2.4
2.0.3
1.6.8
jvm
Platform filter
jvm
Switch theme
ktor
ktor-client-android
io.
ktor.
client.
engine.
android
Android
Android
Client
Engine
Android
Engine
Config
Android
Engine
Container
ktor-client-apache
io.
ktor.
client.
engine.
apache
Apache
Apache
Engine
Config
Apache
Engine
Container
ktor-client-apache5
io.
ktor.
client.
engine.
apache5
Apache5
Apache5Engine
Config
Apache5Engine
Container
ktor-client-cio
io.
ktor.
client.
engine.
cio
CIO
CIOEngine
Config
CIOEngine
Container
endpoint()
Endpoint
Config
Fail
To
Connect
Exception
io.
ktor.
client.
plugins.
websocket.
cio
web
Socket
Raw()
web
Socket
Raw
Session()
ws
Raw()
wss
Raw()
ktor-client-core
io.
ktor.
client
Http
Client
Http
Client()
Http
Client
Config
Http
Client
Engine
Container
io.
ktor.
client.
call
body()
Double
Receive
Exception
Http
Client
Call
Companion
No
Transformation
Found
Exception
Receive
Pipeline
Exception
save()
Unsupported
Content
Type
Exception
Unsupported
Upgrade
Protocol
Exception
io.
ktor.
client.
content
Local
File
Content
Local
File
Content()
Progress
Listener
io.
ktor.
client.
engine
call
Context()
Client
Engine
Closed
Exception
config()
DEFAULT_
CAPABILITIES
engines
http()
Http
Client
Engine
Http
Client
Engine
Base
Http
Client
Engine
Capability
Http
Client
Engine
Config
Http
Client
Engine
Factory
KTOR_
DEFAULT_
USER_
AGENT
merge
Headers()
Proxy
Builder
Proxy
Config
Proxy
Type
SOCKS
HTTP
UNKNOWN
resolve
Address()
type
io.
ktor.
client.
engine.
js
[js]Js
Error
[wasm
Js]Js
Error
Js
Js
Client()
Js
Client
Engine
Config
io.
ktor.
client.
fetch
[js]Abort
Controller
[js]Abort
Signal
[js]Add
Event
Listener
Options
[js]Array
Buffer
[js]Array
Buffer
Constructor
[js]Array
Buffer
View
[js]Array
Like
[js]Blob
[js]Body
[js]Event
[js]Event
Listener
[js]Event
Listener
Object
[js]Event
Listener
Options
[js]Event
Target
[js]fetch()
[js]Form
Data
[js]Headers
[js]invoke()
[js]Pipe
Options
[js]Readable
Stream
[js]Readable
Stream
BYOBReader
[js]Readable
Stream
Default
Reader
[js]Readable
Stream
Read
Result
[js]Request
[js]Request
Init
[js]Response
[js]Uint8Array
[js]Uint8Array
Constructor
[js]Writable
Stream
[js]Writable
Stream
Default
Writer
[wasm
Js]Abort
Controller
[wasm
Js]Abort
Signal
[wasm
Js]Add
Event
Listener
Options
[wasm
Js]Array
Buffer
[wasm
Js]Array
Buffer
Constructor
[wasm
Js]Array
Buffer
View
[wasm
Js]Array
Like
[wasm
Js]Blob
[wasm
Js]Body
[wasm
Js]Event
[wasm
Js]Event
Listener
[wasm
Js]Event
Listener
Object
[wasm
Js]Event
Listener
Options
[wasm
Js]Event
Target
[wasm
Js]fetch()
[wasm
Js]Form
Data
[wasm
Js]Headers
[wasm
Js]invoke()
[wasm
Js]Pipe
Options
[wasm
Js]Readable
Stream
[wasm
Js]Readable
Stream
BYOBReader
[wasm
Js]Readable
Stream
Default
Reader
[wasm
Js]Readable
Stream
Read
Result
[wasm
Js]Request
[wasm
Js]Request
Init
[wasm
Js]Response
[wasm
Js]Uint8Array
[wasm
Js]Uint8Array
Constructor
[wasm
Js]Writable
Stream
[wasm
Js]Writable
Stream
Default
Writer
Array
Buffer
Like
get()
set()
io.
ktor.
client.
network.
sockets
Connect
Timeout
Exception
Interrupted
IOException
Socket
Timeout
Exception
Socket
Timeout
Exception()
io.
ktor.
client.
plugins
add
Default
Response
Validation()
Body
Progress
Browser
User
Agent()
Call
Exception
Handler
Call
Request
Exception
Handler
Charsets()
Client
Request
Exception
Connect
Timeout
Exception()
convert
Long
Timeout
To
Int
With
Infinite
As
Zero()
convert
Long
Timeout
To
Long
With
Infinite
As
Zero()
Curl
User
Agent()
Data
Conversion
Default
Request
Default
Request
Builder
Plugin
default
Request()
default
Transformers()
expect
Success
Http
Call
Validator
Http
Call
Validator
Config
Http
Client
Plugin
Http
Plain
Text
Http
Plain
Text
Config
Http
Redirect
Http
Redirect
Config
Http
Request
Lifecycle
Http
Request
Retry
Http
Request
Retry
Config
Http
Request
Retry
Event
Http
Request
Timeout
Exception
Http
Response
Redirect
Event
Http
Response
Validator()
Http
Retry
Delay
Context
Http
Retry
Event
Data
Http
Retry
Modify
Request
Context
Http
Retry
Should
Retry
Context
Http
Send
Config
Plugin
Http
Send
Interceptor
Http
Timeout
Http
Timeout
Capability
Http
Timeout
Config
Companion
is
Saved
on
Download()
on
Upload()
plugin()
plugin
Or
Null()
Redirect
Response
Exception
Response
Exception
Response
Validator
retry()
Save
Body
Plugin
Save
Body
Plugin
Config
Send
Count
Exceed
Exception
Sender
Server
Response
Exception
Setup
Request
Context
skip
Saving
Body()
Socket
Timeout
Exception()
timeout()
User
Agent
User
Agent
Config
io.
ktor.
client.
plugins.
api
Client
Hook
Client
Plugin
Client
Plugin
Builder
Client
Plugin
Instance
create
Client
Plugin()
Monitoring
Event
On
Request
Context
On
Response
Context
Send
Sender
Sending
Request
Setup
Request
Transform
Request
Body
Context
Transform
Response
Body
Context
io.
ktor.
client.
plugins.
cache
Http
Cache
Companion
Config
Http
Cache
Entry
Invalid
Cache
State
Exception
io.
ktor.
client.
plugins.
cache.
storage
Cached
Response
Data
Cache
Storage
Companion
File
Storage()
Http
Cache
Storage
Companion
store()
io.
ktor.
client.
plugins.
cookies
Accept
All
Cookies
Storage
add
Cookie()
Constant
Cookies
Storage
cookies()
Cookies
Storage
fill
Defaults()
get()
Http
Cookies
Companion
Config
matches()
io.
ktor.
client.
plugins.
internal
Save
Body
Abandoned
Read
Exception
io.
ktor.
client.
plugins.
observer
Response
Handler
Response
Observer
Response
Observer
Config
wrap()
wrap
With
Content()
io.
ktor.
client.
plugins.
sse
Client
SSESession
Client
SSESession
With
Deserialization
Default
Client
SSESession
deserialize()
server
Sent
Events()
server
Sent
Events
Session()
SSE
sse()
SSECapability
SSEClient
Content
SSEClient
Exception
SSEConfig
SSESession
sse
Session()
SSESession
With
Deserialization
io.
ktor.
client.
plugins.
websocket
Client
Web
Socket
Session
converter
Default
Client
Web
Socket
Session
ping
Interval
receive
Deserialized()
send
Serialized()
web
Socket()
Web
Socket
Capability
Web
Socket
Exception
Web
Socket
Extensions
Capability
Web
Sockets
Config
Plugin
Web
Sockets()
web
Socket
Session()
ws()
wss()
io.
ktor.
client.
request
accept()
basic
Auth()
bearer
Auth()
Client
Upgrade
Content
cookie()
Default
Http
Request
delete()
get()
head()
header()
headers()
host
Http
Request
Http
Request
Builder
Companion
Http
Request
Data
Http
Request
Pipeline
Phases
Http
Response
Data
Http
Send
Pipeline
Phases
invoke()
is
Sse
Reconnection
Request()
is
Sse
Request()
is
Upgrade
Request()
options()
parameter()
patch()
port
post()
prepare
Delete()
prepare
Get()
prepare
Head()
prepare
Options()
prepare
Patch()
prepare
Post()
prepare
Put()
prepare
Request()
put()
request()
Response
Adapter
Response
Adapter
Attribute
Key
set
Body()
SSEClient
Response
Adapter
take
From()
url()
io.
ktor.
client.
request.
forms
append()
Channel
Provider
Form
Builder
form
Data()
Form
Data
Content
Form
Part
Input
Provider
Multi
Part
Form
Data
Content
prepare
Form()
prepare
Form
With
Binary
Data()
submit
Form()
submit
Form
With
Binary
Data()
io.
ktor.
client.
statement
body
As
Bytes()
body
As
Channel()
body
As
Text()
content
Default
Http
Response
discard
Remaining()
Http
Receive
Pipeline
Phases
Http
Response
Http
Response
Container
Http
Response
Pipeline
Phases
Http
Statement
read
Bytes()
read
Raw
Bytes()
request
io.
ktor.
client.
utils
build
Headers()
Cache
Control
client
Dispatcher()
DEFAULT_
HTTP_
BUFFER_
SIZE
DEFAULT_
HTTP_
POOL_
SIZE
drop
Compression
Headers()
Empty
Content
Http
Client
Default
Pool
Http
Request
Created
Http
Request
Is
Ready
For
Sending
Http
Response
Cancelled
Http
Response
Received
Http
Response
Receive
Fail
Http
Response
Receive
Failed
unwrap
Cancellation
Exception()
wrap
Headers()
ktor-client-curl
io.
ktor.
client.
engine.
curl
Curl
Curl
Client
Engine
Config
Curl
Illegal
State
Exception
Curl
Runtime
Exception
ktor-client-darwin
io.
ktor.
client.
engine.
darwin
Challenge
Handler
Darwin
Darwin
Client
Engine
Config
Darwin
Http
Request
Exception
Ktor
NSURLSession
Delegate
Ktor
NSURLSession
Delegate()
io.
ktor.
client.
engine.
darwin.
certificates
Certificate
Pinner
Builder
Pinned
Certificate
Companion
io.
ktor.
client.
engine.
ios
Ios
Ios
Client
Engine
Config
Ios
Http
Request
Exception
io.
ktor.
client.
engine.
ios.
certificates
Certificate
Pinner
Pinned
Certificate
ktor-client-darwin-legacy
io.
ktor.
client.
engine.
darwin
Challenge
Handler
Darwin
Http
Request
Exception
Darwin
Legacy
Darwin
Legacy
Client
Engine
Config
Ktor
Legacy
NSURLSession
Delegate
Ktor
Legacy
NSURLSession
Delegate()
io.
ktor.
client.
engine.
darwin.
certificates
Legacy
Certificate
Pinner
Builder
Legacy
Pinned
Certificate
Companion
ktor-client-java
io.
ktor.
client.
engine.
java
Java
Java
Http
Config
Java
Http
Engine
Java
Http
Engine
Container
ktor-client-jetty
io.
ktor.
client.
engine.
jetty
Jetty
Jetty
Engine
Config
Jetty
Engine
Container
ktor-client-jetty-jakarta
io.
ktor.
client.
engine.
jetty.
jakarta
Jetty
Jetty
Engine
Config
Jetty
Engine
Container
ktor-client-mock
io.
ktor.
client.
engine.
mock
Mock
Engine
Companion
Mock
Engine
Config
Mock
Request
Handler
Mock
Request
Handle
Scope
respond()
respond
Bad
Request()
respond
Error()
respond
Ok()
respond
Redirect()
to
Byte
Array()
to
Byte
Read
Packet()
ktor-client-okhttp
io.
ktor.
client.
engine.
okhttp
Ok
Http
Ok
Http
Config
Ok
Http
Engine
Ok
Http
Engine
Container
Unsupported
Frame
Type
Exception
ktor-client-auth
io.
ktor.
client.
plugins.
auth
Auth
Auth
Circuit
Breaker
Auth
Config
Auth
Provider
auth
Provider()
auth
Providers
io.
ktor.
client.
plugins.
auth.
providers
basic()
Basic
Auth
Config
Basic
Auth
Credentials
Basic
Auth
Provider
bearer()
Bearer
Auth
Config
Bearer
Auth
Provider
Bearer
Tokens
digest()
Digest
Auth
Config
Digest
Auth
Credentials
Digest
Auth
Provider
Refresh
Tokens
Params
ktor-client-bom-remover
io.
ktor.
client.
plugins.
bomremover
BOMRemover
ktor-client-call-id
io.
ktor.
client.
plugins.
callid
Call
Id
Call
Id
Config
ktor-client-content-negotiation
io.
ktor.
client.
plugins.
contentnegotiation
Content
Converter
Exception
Content
Negotiation
Content
Negotiation
Config
exclude()
Json
Content
Type
Matcher
ktor-client-content-negotiation-tests
io.
ktor.
client.
plugins.
contentnegotiation.
tests
Abstract
Client
Content
Negotiation
Test
Response
Test
Sealed
A
B
User
Widget
Data
Data
Type
Json
Content
Negotiation
Test
Wrapper
Json
Websockets
Test
User
Sealed
A
B
Sealed
Wrapper
ktor-client-encoding
io.
ktor.
client.
plugins.
compression
applied
Decoders
compress()
Content
Encoding
Content
Encoding
Config
Mode
Compress
Request
Decompress
Response
All
Unsupported
Content
Encoding
Exception
ktor-client-json
io.
ktor.
client.
plugins.
json
default
Serializer()
Json()
Json
Plugin
Config
Plugin
Json
Serializer
serializers
serializers
Store
ktor-client-gson
io.
ktor.
client.
plugins.
gson
Gson
Serializer
ktor-client-jackson
io.
ktor.
client.
plugins.
jackson
Jackson
Serializer
ktor-client-serialization
[root]
[js]Serializer
Initializer
[wasm
Js]Serializer
Initializer
initializer
io.
ktor.
client.
plugins.
kotlinx.
serializer
Kotlinx
Serializer
Companion
ktor-client-logging
io.
ktor.
client.
plugins.
logging
ANDROID
DEFAULT
EMPTY
Logger
Companion
Logging
Logging
Config
Logging
Format
Default
Ok
Http
Log
Level
ALL
HEADERS
BODY
INFO
NONE
MDCContext()
Message
Length
Limiting
Logger
SIMPLE
ktor-client-resources
io.
ktor.
client.
plugins.
resources
delete()
get()
head()
href()
options()
patch()
post()
prepare
Delete()
prepare
Get()
prepare
Head()
prepare
Options()
prepare
Patch()
prepare
Post()
prepare
Put()
prepare
Request()
put()
request()
Resources
ktor-client-test-base
io.
ktor.
client.
test.
base
after()
Client
Engine
Test
Client
Loader
config()
Engine
Selection
Rule
perform
Test
With
Engine()
TCP_
SERVER
test()
TEST_
SERVER
TEST_
SERVER_
TLS
TEST_
WEBSOCKET_
SERVER
Test
Client
Builder
Test
Info
Companion
test
Info
test
With
Engine()
ktor-client-tests
io.
ktor.
client.
tests
Http
Client
Test
Https
Test
io.
ktor.
client.
tests.
utils
make
Array()
make
String()
Test
With
Ktor
ktor-client-winhttp
io.
ktor.
client.
engine.
winhttp
Win
Http
Win
Http
Client
Engine
Config
Win
Http
Security
Protocol
Default
Tls10
Tls11
Tls12
Tls13
ktor-http
io.
ktor.
content
Byte
Array
Content
Text
Content
io.
ktor.
http
append()
append
Encoded
Path
Segments()
append
Path
Segments()
append
Url
Full
Path()
authority
Bad
Content
Type
Format
Exception
build
Url()
Cache
Control
Max
Age
No
Cache
No
Store
Visibility
Public
Private
cache
Control()
charset()
clone()
Content
Disposition
Companion
Parameters
content
Length()
Content
Range
Bounded
Suffix
Tail
From
content
Range
Header
Value()
Content
Type
Application
Audio
Companion
Font
Image
Message
Multi
Part
Text
Video
content
Type()
Content
Type
Matcher
Cookie
Cookie
Encoding
RAW
DQUOTES
URI_
ENCODING
BASE64_
ENCODING
cookies()
date()
decode
Cookie
Value()
decode
URLPart()
decode
URLQuery
Component()
DEFAULT_
PORT
default
For
File()
default
For
File
Extension()
default
For
File
Path()
default
For
Path()
encode
Cookie
Value()
encoded
Path
encode
OAuth()
encode
URLParameter()
encode
URLPath()
encode
URLPath
Part()
encode
URLQuery
Component()
escape
If
Needed()
etag()
expires()
file
Extensions()
form
Url
Encode()
form
Url
Encode
To()
from
Cookie
To
Gmt
Date()
from
File
Extension()
from
File
Path()
from
Http
To
Gmt
Date()
full
Path
Headers
Companion
headers()
Headers
Builder
Headers
Impl
headers
Of()
Headers
Single
Impl
Header
Value
Header
Value
Param
Header
Value
With
Parameters
Companion
host
Is
Ip()
host
With
Port
host
With
Port
If
Specified
Http
Headers
Http
Message
Http
Message
Builder
Http
Method
Companion
Http
Protocol
Version
Companion
Http
Status
Code
Companion
if
Modified
Since()
if
None
Match()
Illegal
Header
Name
Exception
Illegal
Header
Value
Exception
invoke()
is
Absolute
Path
is
Relative
Path
is
Secure()
is
Success()
is
Websocket()
last
Modified()
Link
Header
Parameters
Rel
max
Age()
origin
Parameters
Companion
parameters()
Parameters
Builder
Parameters
Builder()
Parameters
Builder
Impl
Parameters
Impl
parameters
Of()
Parameters
Single
Impl
parse
And
Sort
Content
Type
Header()
parse
And
Sort
Header()
parse
Client
Cookies
Header()
parse
Header
Value()
parse
Query
String()
parse
Ranges
Specifier()
parse
Server
Set
Cookie
Header()
parse
Url()
parse
Url
Encoded
Parameters()
path()
path
Components()
plus()
protocol
With
Authority
quote()
Ranges
Specifier
Range
Units
Bytes
None
render
Cookie
Header()
render
Set
Cookie
Header()
Request
Connection
Point
set()
set
Cookie()
take
From()
to
Header
Params
List()
to
Http
Date()
to
URI()
Unsafe
Header
Exception
Url
Companion
Url()
URLBuilder
Companion
URLBuilder()
URLDecode
Exception
URLParser
Exception
URLProtocol
Companion
Url
Serializer
user
Agent()
vary()
with
Charset()
with
Charset
If
Needed()
io.
ktor.
http.
auth
Auth
Scheme
Header
Value
Encoding
QUOTED_
WHEN_
REQUIRED
QUOTED_
ALWAYS
URI_
ENCODE
Http
Auth
Header
Companion
Parameterized
Parameters
Single
parse
Authorization
Header()
parse
Authorization
Headers()
io.
ktor.
http.
content
as
Flow()
Byte
Array
Content
caching
Caching
Options
Caching
Property
Channel
Writer
Content
compressed()
Entity
Tag
Version
Companion
Entity
Tag
Version()
for
Each
Part()
is
Empty()
Last
Modified
Version
Last
Modified
Version()
Multi
Part
Data
Empty
Null
Body
Outgoing
Content
Byte
Array
Content
Content
Wrapper
No
Content
Protocol
Upgrade
Read
Channel
Content
Write
Channel
Content
Output
Stream
Content
Part
Data
Binary
Channel
Item
Binary
Item
File
Item
Form
Item
read
All
Parts()
stream
Provider
Text
Content
URIFile
Content
Version
Version
Check
Result
OK
NOT_
MODIFIED
PRECONDITION_
FAILED
Version
List
Property
versions
Writer
Content
io.
ktor.
http.
header
Accept
Encoding
Companion
io.
ktor.
http.
parsing
Parse
Exception
io.
ktor.
http.
websocket
websocket
Server
Accept()
ktor-http-cio
io.
ktor.
http.
cio
CIOHeaders
CIOMultipart
Data
Base
Connection
Options
Companion
decode
Chunked()
Decoder
Job
encode
Chunked()
Encoder
Job
expect
Http
Body()
expect
Http
Upgrade()
Http
Headers
Map
Http
Message
Multipart
Event
Epilogue
Multipart
Part
Preamble
parse
Headers()
parse
Http
Body()
parse
Multipart()
parse
Request()
parse
Response()
Parser
Exception
Request
Request
Response
Builder
Response
io.
ktor.
http.
cio.
internals
Mutable
Range
parse
Dec
Long()
Unsupported
Media
Type
Exception
CIO
ktor-io
io.
ktor.
utils.
io
as
Byte
Write
Channel()
as
Sink()
as
Source()
attach
Job()
available
For
Read
available
For
Write
await
Free
Space()
Buffered
Byte
Write
Channel
Byte
Channel
Byte
Read
Channel
Companion
Byte
Read
Channel()
Byte
String()
Byte
Write
Channel
cancel()
Cancellation
Exception
Channel
Job
close()
Closed
Byte
Channel
Exception
Closed
Read
Channel
Exception
Closed
Write
Channel
Exception
Concurrent
IOException
copy
And
Close()
copy
To()
counted()
Counted
Byte
Read
Channel
Counted
Byte
Write
Channel
discard()
discard
Exact()
exhausted()
flush
If
Needed()
get
Cancellation
Exception()
Internal
API
invoke
On
Completion()
is
Cancelled
is
Completed
join()
Jvm
Serializable
Jvm
Serializer
Jvm
Serializer
Replacement()
Ktor
Dsl
Ktor
Experimental
API
look
Ahead()
Look
Ahead
Session
look
Ahead
Suspend()
Look
Ahead
Suspend
Session
on
Close()
peek()
Public
APICandidate
read()
read
Available()
read
Buffer()
read
Byte()
read
Byte
Array()
read
Double()
reader()
Reader
Job
Reader
Scope
read
Float()
read
Fully()
read
Int()
read
Long()
read
Packet()
read
Remaining()
read
Short()
read
Text()
read
Until()
read
UTF8Line()
read
UTF8Line
To()
release()
rethrow
Close
Cause
If
Needed()
skip
Delimiter()
skip
If
Found()
to
Byte
Array()
total
Bytes
Read
write()
write
Available()
write
Buffer()
write
Byte()
write
Byte
Array()
write
Byte
Buffer()
write
Double()
write
Float()
write
Fully()
write
Int()
write
Long()
write
Packet()
writer()
Writer
Job
Writer
Scope
write
Short()
write
Source()
write
String()
write
String
Utf8()
io.
ktor.
utils.
io.
bits
high
Byte
high
Int
high
Short
low
Byte
low
Int
low
Short
reverse
Byte
Order()
io.
ktor.
utils.
io.
charsets
Charset
[js]Companion
[posix]Companion
[wasm
Js]Companion
charset
Charset
Decoder
Charset
Encoder
Charsets
decode()
encode()
encode
To
Byte
Array()
for
Name()
is
Supported()
Malformed
Input
Exception
name
to
Byte
Array()
to
Js
Array()
Too
Long
Line
Exception
io.
ktor.
utils.
io.
core
append()
Buffer
Buffer
Limit
Exceeded
Exception
build()
build
Packet()
Byte
Order
Companion
BIG_
ENDIAN
LITTLE_
ENDIAN
Byte
Packet
Builder
Byte
Packet
Builder()
Byte
Read
Packet
Byte
Read
Packet()
Byte
Read
Packet
Empty
can
Read()
Closeable
copy()
copy
To()
discard()
end
Of
Input
Input
is
Empty
is
Not
Empty
Memory
Output
preview()
read()
read
Available()
read
Bytes()
read
Fully()
read
Short
Little
Endian()
read
Text()
read
Text
Exact()
read
Text
Exact
Characters()
release()
remaining
Sink()
size
store
Int
At()
String()
take
While()
to
Byte
Array()
use()
with
Memory()
write()
write
Byte
Buffer()
write
Fully()
write
Packet()
write
Text()
io.
ktor.
utils.
io.
core.
internal
Chunk
Buffer
read
Direct()
write
Direct()
write
Remaining
io.
ktor.
utils.
io.
errors
EOFException
IOException
Posix
Exception
Address
Already
In
Use
Exception
Bad
File
Descriptor
Exception
Bad
Message
Exception
Companion
Connection
Aborted
Exception
Connection
Refused
Exception
Connection
Reset
Exception
Interrupted
Exception
Invalid
Argument
Exception
No
Memory
Exception
No
Such
File
Exception
Not
Connected
Exception
Not
Socket
Exception
Overflow
Exception
Posix
Errno
Exception
Timeout
IOException
Try
Again
Exception
io.
ktor.
utils.
io.
jvm.
javaio
copy
To()
to
Byte
Read
Channel()
to
Input
Stream()
to
Output
Stream()
io.
ktor.
utils.
io.
jvm.
nio
as
Source()
to
Byte
Read
Channel()
Write
Suspend
Session
write
Suspend
Session()
write
While()
io.
ktor.
utils.
io.
locks
Lock
Reentrant
Lock
reentrant
Lock()
synchronized()
Synchronized
Object
with
Lock()
io.
ktor.
utils.
io.
pool
Byte
Array
Pool
Byte
Buffer
Pool
Default
Pool
Direct
Byte
Buffer
Pool
No
Pool
Impl
Object
Pool
Single
Instance
Pool
use
Borrowed()
use
Instance()
io.
ktor.
utils.
io.
streams
as
Byte
Write
Channel()
as
Input()
input
Stream()
read
Packet
At
Least()
write
Packet()
ktor-network
io.
ktor.
network.
selector
Actor
Selector
Manager
build
Or
Close()
Closed
Channel
Cancellation
Exception
Interest
Suspensions
Map
Companion
Selectable
Select
Interest
Companion
READ
WRITE
ACCEPT
CONNECT
CLOSE
Selector
Manager
Companion
Selector
Manager()
Selector
Manager
Support
Closed
Selector
Cancellation
Exception
Socket
Error
io.
ktor.
network.
sockets
ABound
Socket
Acceptable
AConnected
Socket
AReadable
ASocket
a
Socket()
await
Closed()
AWritable
Bound
Datagram
Socket
Configurable
Connected
Datagram
Socket
Connection
connection()
Datagram
Datagram
Read
Channel
Datagram
Read
Write
Channel
Datagram
Write
Channel
Inet
Socket
Address
is
Closed
open
Read
Channel()
open
Write
Channel()
port
Read
Write
Socket
Server
Socket
Socket
Socket
Address
Socket
Builder
Socket
Options
Acceptor
Options
Peer
Socket
Options
TCPClient
Socket
Options
UDPSocket
Options
Socket
Timeout
Exception
tcp
No
Delay()
Tcp
Socket
Builder
to
Java
Address()
Type
Of
Service
Companion
UDPSocket
Builder
Unix
Socket
Address
io.
ktor.
network.
util
Default
Byte
Buffer
Pool
Default
Datagram
Byte
Buffer
Pool
ktor-network-tls
io.
ktor.
network.
tls
add
Certificate
Chain()
add
Key
Store()
Certificate
And
Key
CIOCipher
Suites
Cipher
Suite
Cipher
Type
GCM
CBC
keys
Generation
Algorithm()
No
Private
Key
Exception
OID
Companion
Secret
Exchange
Type
ECDHE
RSA
Server
Key
Exchange
Type
Companion
Explicit
Prime
Explicit
Char
Named
Curve
take
From()
tls()
TLSAlert
Level
Companion
WARNING
FATAL
TLSAlert
Type
Companion
Decryption
Failed_
RESERVED
Close
Notify
Unexpected
Message
Bad
Record
Mac
Record
Overflow
Decompression
Failure
Handshake
Failure
No
Certificate_
RESERVED
Bad
Certificate
Unsupported
Certificate
Certificate
Revoked
Certificate
Expired
Certificate
Unknown
Illegal
Parameter
Unknown
Ca
Access
Denied
Decode
Error
Decrypt
Error
Export
Restriction_
RESERVED
Protocol
Version
Insufficient
Security
Internal
Error
User
Canceled
No
Renegotiation
Unsupported
Extension
TLSConfig
TLSConfig
Builder
TLSException
Tls
Exception
TLSHandshake
Type
Companion
Hello
Request
Client
Hello
Server
Hello
Certificate
Server
Key
Exchange
Certificate
Request
Server
Done
Certificate
Verify
Client
Key
Exchange
Finished
Tls
Peer
Unverified
Exception
TLSRecord
Type
Companion
Change
Cipher
Spec
Alert
Handshake
Application
Data
TLSVersion
Companion
SSL3
TLS10
TLS11
TLS12
io.
ktor.
network.
tls.
extensions
by
Code()
Hash
Algorithm
Companion
NONE
MD5
SHA1
SHA224
SHA256
SHA384
SHA512
INTRINSIC
Hash
And
Sign
Companion
Named
Curve
Companion
sect163k1
sect163r1
sect163r2
sect193r1
sect193r2
sect233k1
sect233r1
sect239k1
sect283k1
sect283r1
sect409k1
sect409r1
sect571k1
sect571r1
secp160k1
secp160r1
secp160r2
secp192k1
secp192r1
secp224k1
secp224r1
secp256k1
secp256r1
secp384r1
secp521r1
Point
Format
UNCOMPRESSED
ANSIX962_
COMPRESSED_
PRIME
ANSIX962_
COMPRESSED_
CHAR2
Signature
Algorithm
Companion
ANON
RSA
DSA
ECDSA
ED25519
ED448
Supported
Named
Curves
Supported
Point
Formats
Supported
Signature
Algorithms
TLSExtension
Type
Companion
SERVER_
NAME
MAX_
FRAGMENT_
LENGTH
CLIENT_
CERTIFICATE_
URL
TRUSTED_
CA_
KEYS
TRUNCATED_
HMAC
STATUS_
REQUEST
ELLIPTIC_
CURVES
EC_
POINT_
FORMAT
SIGNATURE_
ALGORITHMS
ktor-network-tls-certificates
io.
ktor.
network.
tls.
certificates
build
Key
Store()
Certificate
Builder
generate
Certificate()
Key
Store
Builder
Key
Type
CA
Server
Client
save
To
File()
trust
Managers
trust
Store()
ktor-server-cio
io.
ktor.
server.
cio
CIO
CIOApplication
Engine
Configuration
Engine
Main
Http
Request
Handler
Http
Server
Http
Server
Settings
io.
ktor.
server.
cio.
backend
http
Server()
Server
Incoming
Connection
Server
Request
Scope
start
Server
Connection
Pipeline()
ktor-server-config-yaml
io.
ktor.
server.
config.
yaml
Yaml
Config
Yaml
Config()
Yaml
Config
Loader
ktor-server-core
io.
ktor.
server.
application
Application
application
Application
Call
Application
Call
Pipeline
Application
Phase
Application
Environment
Application
Events
Application
Plugin
Application
Started
Application
Starting
Application
Stopped
Application
Stopping
Application
Stop
Preparing
Base
Application
Plugin
Base
Route
Scoped
Plugin
call
Call
Context
create
Application
Plugin()
create
Route
Scoped
Plugin()
Duplicate
Application
Plugin
Exception
Duplicate
Plugin
Exception
Event
Definition
Event
Handler
find
Plugin
In
Route()
Hook
host
install()
Invalid
Body
Exception
is
Handled
log
Missing
Application
Plugin
Exception
On
Call
Context
On
Call
Receive
Context
On
Call
Respond
Context
Pipeline
Call
Plugin
plugin()
Plugin
Builder
Plugin
Instance
plugin
Or
Null()
plugin
Registry
port
receive
Type
Route
Scoped
Plugin
Route
Scoped
Plugin
Builder
Server
Config
server
Config()
Server
Config
Builder
Server
Ready
Transform
Body
Context
uninstall()
uninstall
All
Plugins()
uninstall
Plugin()
io.
ktor.
server.
application.
hooks
Before
Response
Transform
Call
Failed
Call
Setup
Metrics
Monitoring
Event
Receive
Request
Bytes
Response
Body
Ready
For
Send
Context
Response
Sent
io.
ktor.
server.
config
[js
And
Wasm
Shared]add
Config
Loader()
[posix]add
Config
Loader()
Application
Config
Application
Config()
Application
Configuration
Exception
Application
Config
Value
Config
Loader
Companion
config
Loaders
Hocon
Application
Config
Hocon
Config
Loader
Map
Application
Config
merge()
merge
With()
try
Get
String()
try
Get
String
List()
with
Fallback()
io.
ktor.
server.
engine
[js
And
Wasm
Shared]Application
Environment
Impl
Nix
[posix]Application
Environment
Impl
Nix
add
Shutdown
Hook()
Application
Engine
Configuration
Application
Engine
Factory
application
Environment()
Application
Environment
Builder
Base
Application
Call
Base
Application
Engine
Configuration
Base
Application
Request
Base
Application
Response
Body
Length
Is
Too
Long
Body
Length
Is
Too
Small
Companion
Invalid
Header
For
Content
Response
Already
Sent
Exception
Command
Line
Config
Command
Line
Config()
Config
Keys
connector()
Connector
Type
Companion
default
Engine
Pipeline()
default
Exception
Status
Code()
Default
Uncaught
Exception
Handler
Embedded
Server
embedded
Server()
Engine
Connector
Builder
Engine
Connector
Config
Engine
Pipeline
Companion
Engine
SSLConnector
Builder
Engine
SSLConnector
Config
handle
Failure()
install
Default
Transformations()
launch
On
Cancellation()
load
Common
Configuration()
log
Error()
Shut
Down
Url
Companion
Config
Engine
Plugin
ssl
Connector()
stop()
stop
Server
On
Cancellation()
with
Port()
io.
ktor.
server.
engine.
internal
Closed
Channel
Exception
io.
ktor.
server.
http
http
Date
Format
link()
push()
to
Http
Date
String()
io.
ktor.
server.
http.
content
angular()
backbone()
Caching
Options()
Compressed
File
Type
BROTLI
GZIP
default()
default
Resource()
ember()
file()
files()
File
System
Paths
Companion
Http
Status
Code
Content
ignore
Files()
is
Compression
Suppressed
is
Decompression
Suppressed
is
Static
Content()
Jar
File
Content
Last
Modified
Version()
Local
File
Content
Local
File
Content()
Local
Path
Content
Local
Path
Content()
pre
Compressed()
react()
resolve
Resource()
resource()
resource
Classpath
Resource()
resources()
single
Page
Application()
SPAConfig
static()
static
Base
Package
Static
Content
Config
Static
File
Location
Property
static
Files()
static
File
System()
static
Resources()
static
Root
Folder
static
Zip()
suppress
Compression()
suppress
Decompression()
Suppression
Attribute
transform
Default
Content()
vue()
io.
ktor.
server.
logging
MDCProvider
mdc
Provider
to
Log
String()
io.
ktor.
server.
plugins
Bad
Request
Exception
Cannot
Transform
Content
To
Type
Exception
Content
Transformation
Exception
Missing
Request
Parameter
Exception
Mutable
Origin
Connection
Point
mutable
Origin
Connection
Point
Mutable
Origin
Connection
Point
Key
Not
Found
Exception
origin
Parameter
Conversion
Exception
Payload
Too
Large
Exception
Unsupported
Media
Type
Exception
io.
ktor.
server.
request
accept()
accept
Charset()
accept
Charset
Items()
accept
Encoding()
accept
Encoding
Items()
accept
Items()
accept
Language()
accept
Language
Items()
Application
Receive
Pipeline
Phases
Application
Request
authorization()
cache
Control()
content
Charset()
content
Length()
Content
Transformation
Exception
content
Type()
document()
encode
Parameters()
form
Field
Limit
header()
host()
http
Method
http
Version
is
Chunked()
is
Multipart()
location()
path()
Pipeline
Request
port()
query
String()
ranges()
receive()
receive
Channel()
receive
Multipart()
receive
Nullable()
receive
Or
Null()
receive
Parameters()
receive
Stream()
receive
Text()
Request
Already
Consumed
Exception
Request
Cookies
uri
user
Agent()
io.
ktor.
server.
response
append
If
Absent()
Application
Response
Application
Send
Pipeline
Phases
cache
Control()
content
Range()
Default
Response
Push
Builder
default
Text
Content
Type()
etag()
expires()
header()
last
Modified()
Pipeline
Response
respond()
respond
Bytes()
respond
Bytes
Writer()
respond
File()
respond
Nullable()
respond
Output
Stream()
respond
Path()
respond
Redirect()
respond
Source()
respond
Text()
respond
Text
Writer()
Response
Cookies
Response
Headers
Response
Push
Builder
response
Type
Use
Http2Push
io.
ktor.
server.
routing
accept()
And
Route
Selector
application
Constant
Parameter
Route
Selector
content
Type()
create
Route
From
Path()
delete()
get()
get
All
Routes()
head()
header()
host()
Host
Route
Selector
Companion
Http
Accept
Route
Selector
Http
Header
Route
Selector
Http
Method
Route
Selector
Http
Multi
Accept
Route
Selector
Ignore
Trailing
Slash
insert
Phase
After()
insert
Phase
Before()
intercept()
local
Port()
Local
Port
Route
Selector
Companion
method()
optional
Param()
Optional
Parameter
Route
Selector
options()
Or
Route
Selector
param()
Parameter
Route
Selector
patch()
Path
Segment
Constant
Route
Selector
Path
Segment
Optional
Parameter
Route
Selector
Path
Segment
Parameter
Route
Selector
Path
Segment
Regex
Route
Selector
Companion
Path
Segment
Selector
Builder
Path
Segment
Tailcard
Route
Selector
Path
Segment
Wildcard
Route
Selector
port()
post()
put()
Root
Route
Selector
Route
route()
Route
Selector
Route
Selector
Evaluation
Companion
Failure
Success
Routing
routing()
Routing
Call
Routing
Context
Routing
Failure
Status
Code
Routing
Handler
Routing
Node
Routing
Path
Companion
Routing
Path
Segment
Routing
Path
Segment
Kind
Constant
Parameter
Routing
Pipeline
Call
Routing
Pipeline
Request
Routing
Pipeline
Response
Routing
Request
Routing
Resolve
Context
Routing
Resolve
Result
Failure
Success
Routing
Resolve
Trace
Routing
Resolve
Trace
Entry
Routing
Response
Routing
Root
Plugin
Trailing
Slash
Route
Selector
io.
ktor.
server.
util
[common]get
Or
Fail()
Copy
On
Write
Hash
Map
create
From
Call()
get
Value()
Greenwich
Mean
Time
normalize
Path
Components()
to
GMTDate()
to
Local
Date
Time()
to
Zoned
Date
Time()
url()
ktor-server-jetty
io.
ktor.
server.
jetty
Engine
Main
Jetty
Jetty
Application
Call
Jetty
Application
Engine
Jetty
Application
Engine
Base
Configuration
Jetty
Application
Response
io.
ktor.
server.
jetty.
internal
Jetty
Upgrade
Impl
ktor-server-jetty-jakarta
io.
ktor.
server.
jetty.
jakarta
Engine
Main
Jetty
Jetty
Application
Call
Jetty
Application
Engine
Jetty
Application
Engine
Base
Configuration
Jetty
Application
Response
io.
ktor.
server.
jetty.
jakarta.
internal
Jetty
Upgrade
Impl
ktor-server-netty
io.
ktor.
server.
netty
Engine
Main
Event
Loop
Group
Proxy
Companion
Netty
Netty
Application
Call
Netty
Application
Engine
Configuration
Netty
Application
Request
Netty
Application
Request
Headers
Netty
Application
Response
Companion
Netty
Channel
Initializer
Companion
suspend
Await()
suspend
Write
Await()
io.
ktor.
server.
netty.
cio
Netty
Response
Pipeline
Exception
ktor-server-auth
io.
ktor.
server.
auth
Application
Call
Predicate
authenticate()
Authentication
Companion
authentication
Authentication
Checked
Authentication
Config
Authentication
Context
Companion
Authentication
Failed
Cause
Error
Invalid
Credentials
No
Credentials
Authentication
Function
Authentication
Interceptors
Authentication
Procedure
Challenge
Authentication
Provider
Config
Authentication
Route
Selector
Authentication
Strategy
Optional
First
Successful
Required
basic()
basic
Authentication
Credentials()
Basic
Authentication
Provider
Config
bearer()
Bearer
Authentication
Provider
Config
Bearer
Token
Credential
Challenge
Function
Credential
digest()
digest
Authentication
Credentials()
Digest
Authentication
Provider
Config
Digest
Credential
Digest
Provider
Function
Dynamic
Provider
Config
expected
Digest()
Forbidden
Response
form()
Form
Auth
Challenge
Context
Form
Auth
Challenge
Function
Form
Authentication
Provider
Config
oauth()
OAuth1a
Exception
Missing
Token
Exception
OAuth2Exception
Invalid
Grant
Invalid
Nonce
Missing
Access
Token
Unknown
Exception
Unsupported
Grant
Type
OAuth2Redirect
Error
OAuth2Request
Parameters
OAuth2Response
Parameters
OAuth
Access
Token
Response
OAuth1a
OAuth2
OAuth
Authentication
Provider
Config
OAuth
Callback
Error
Token
Pair
Token
Single
OAuth
Grant
Types
OAuth
Key
OAuth
Server
Settings
OAuth1a
Server
Settings
OAuth2Server
Settings
OAuth
Version
V10a
V20
parse
Authorization
Header()
Principal
principal()
Route
Authentication
Config
session()
Session
Auth
Challenge
Function
Session
Auth
Challenge
Key
Session
Authentication
Provider
Companion
Config
Session
Challenge
Context
to
Digest
Credential()
Unauthorized
Response
User
Hashed
Table
Auth
User
Id
Principal
User
Password
Credential
verifier()
verify
With
OAuth2()
ktor-server-auth-jwt
io.
ktor.
server.
auth.
jwt
jwt()
JWTAuth
Challenge
Function
JWTAuthentication
Provider
Config
JWTChallenge
Context
JWTConfigure
Function
JWTCredential
JWTPayload
Holder
JWTPrincipal
ktor-server-auth-ldap
io.
ktor.
server.
auth.
ldap
ldap
Authenticate()
ktor-server-auto-head-response
io.
ktor.
server.
plugins.
autohead
Auto
Head
Response
ktor-server-body-limit
io.
ktor.
server.
plugins.
bodylimit
Request
Body
Limit
Request
Body
Limit
Config
ktor-server-caching-headers
io.
ktor.
server.
plugins.
cachingheaders
caching
Caching
Headers
Caching
Headers
Config
ktor-server-call-id
io.
ktor.
server.
plugins.
callid
Call
Id
call
Id
Call
Id
Config
call
Id
Mdc()
Call
Id
Provider
Call
Id
Verifier
generate()
Rejected
Call
Id
Exception
ktor-server-call-logging
io.
ktor.
server.
plugins.
calllogging
Call
Logging
Call
Logging
Config
processing
Time
Millis()
ktor-server-compression
io.
ktor.
server.
plugins.
compression
applied
Decoders
Compression
Compression
Config
Mode
Compress
Response
Decompress
Request
All
Compression
Encoder
Builder
Compression
Encoder
Config
Compression
Options
condition()
Conditions
Holder
Builder
deflate()
exclude
Content
Type()
gzip()
identity()
match
Content
Type()
minimum
Size()
ktor-server-conditional-headers
io.
ktor.
server.
plugins.
conditionalheaders
Conditional
Headers
Conditional
Headers
Config
parse
Versions()
versions
For()
ktor-server-content-negotiation
io.
ktor.
server.
plugins.
contentnegotiation
Accept
Header
Contributor
Content
Negotiation
Content
Negotiation
Config
Content
Type
With
Quality
suitable
Charset()
ktor-server-cors
io.
ktor.
server.
plugins.
cors
CORS
CORSConfig
Companion
max
Age
Duration
io.
ktor.
server.
plugins.
cors.
routing
CORS
ktor-server-csrf
io.
ktor.
server.
plugins.
csrf
CSRF
CSRFConfig
ktor-server-data-conversion
io.
ktor.
server.
plugins.
dataconversion
conversion
Service
Data
Conversion
ktor-server-default-headers
io.
ktor.
server.
plugins.
defaultheaders
Default
Headers
Default
Headers
Config
Clock
ktor-server-double-receive
io.
ktor.
server.
plugins.
doublereceive
Double
Receive
Double
Receive
Config
ktor-server-forwarded-header
io.
ktor.
server.
plugins.
forwardedheaders
FORWARDED_
PARSED_
KEY
Forwarded
Headers
Forwarded
Headers
Config
Forwarded
Header
Value
XForwarded
Headers
XForwarded
Headers
Config
XForwarded
Header
Values
ktor-server-freemarker
io.
ktor.
server.
freemarker
Free
Marker
Free
Marker
Content
respond
Template()
ktor-server-hsts
io.
ktor.
server.
plugins.
hsts
HSTS
HSTSConfig
HSTSHost
Config
max
Age
Duration
ktor-server-html-builder
io.
ktor.
server.
html
each()
Html
Content
insert()
Placeholder
Placeholder
Item
Placeholder
List
respond
Html()
respond
Html
Template()
Template
Template
Placeholder
ktor-server-http-redirect
io.
ktor.
server.
plugins.
httpsredirect
Https
Redirect
Https
Redirect
Config
ktor-server-i18n
io.
ktor.
i18n
I18n
i18n()
I18n
Configuration
ktor-server-jte
io.
ktor.
server.
jte
Jte
Jte
Config
Jte
Content
respond
Template()
ktor-server-method-override
io.
ktor.
server.
plugins.
methodoverride
XHttp
Method
Override
XHttp
Method
Override
Config
ktor-server-metrics
io.
ktor.
server.
metrics.
dropwizard
Dropwizard
Metrics
Dropwizard
Metrics
Config
ktor-server-metrics-micrometer
io.
ktor.
server.
metrics.
micrometer
Micrometer
Metrics
Micrometer
Metrics
Config
ktor-server-mustache
io.
ktor.
server.
mustache
Mustache
Mustache
Config
Mustache
Content
respond
Template()
ktor-server-openapi
io.
ktor.
server.
plugins.
openapi
open
API()
Open
APIConfig
ktor-server-partial-content
io.
ktor.
server.
plugins.
partialcontent
Partial
Content
Partial
Content
Config
ktor-server-pebble
io.
ktor.
server.
pebble
Pebble
Pebble
Configuration
Pebble
Content
respond
Template()
ktor-server-rate-limit
io.
ktor.
server.
plugins.
ratelimit
Rate
Limit
rate
Limit()
Rate
Limit
Config
Rate
Limiter
Companion
State
Available
Exhausted
Rate
Limit
Name
Rate
Limit
Provider
Config
Rate
Limit
Route
Selector
ktor-server-request-validation
io.
ktor.
server.
plugins.
requestvalidation
Request
Validation
Request
Validation
Config
Validator
Builder
Request
Validation
Exception
Validation
Result
Invalid
Valid
Validator
ktor-server-resources
io.
ktor.
server.
resources
delete()
get()
handle()
head()
href()
options()
patch()
post()
put()
resource()
Resources
ktor-server-sessions
io.
ktor.
server.
sessions
Cache
Cache
Storage
clear()
cookie()
Cookie
Configuration
Cookie
Id
Session
Builder
Cookie
Session
Builder
Current
Session
DEFAULT_
SESSION_
MAX_
AGE
default
Session
Serializer()
directory
Session
Storage()
generate
Session
Id()
get()
get
Or
Set()
header()
Header
Id
Session
Builder
Header
Session
Builder
max
Age
reflection
Session
Serializer()
Same
Site
same
Site
session
Id
Session
Not
Yet
Configured
Exception
Session
Provider
Sessions
sessions
Sessions
Config
Session
Serializer
Session
Storage
Session
Storage
Memory
Session
Tracker
Session
Tracker
By
Id
Session
Tracker
By
Value
Session
Transport
Session
Transport
Cookie
Session
Transport
Header
Session
Transport
Transformer
Session
Transport
Transformer
Encrypt
Companion
Session
Transport
Transformer
Message
Authentication
set()
Too
Late
Session
Set
Exception
transform
Read()
transform
Write()
io.
ktor.
server.
sessions.
serialization
Kotlinx
Backward
Compatible
Session
Serializer()
Kotlinx
Session
Serializer()
ktor-server-sse
io.
ktor.
server.
sse
Heartbeat
heartbeat()
send()
Server
SSESession
Server
SSESession
With
Serialization
SSE
sse()
SSEServer
Content
ktor-server-status-pages
io.
ktor.
server.
plugins.
statuspages
exception()
Handler
Function
status
File()
Status
Pages
Status
Pages
Config
Status
Context
ktor-server-swagger
io.
ktor.
server.
plugins.
swagger
Swagger
Config
swagger
UI()
ktor-server-thymeleaf
io.
ktor.
server.
thymeleaf
respond
Template()
Thymeleaf
Thymeleaf
Content
ktor-server-velocity
io.
ktor.
server.
velocity
engine()
respond
Template()
Velocity
Velocity
Content
Velocity
Tools
ktor-server-webjars
io.
ktor.
server.
webjars
Webjars
Webjars
Config
ktor-server-websockets
io.
ktor.
server.
websocket
application
converter
Default
Web
Socket
Server
Session
ping
Interval
ping
Period
receive
Deserialized()
send
Serialized()
timeout
web
Socket()
web
Socket
Raw()
Web
Sockets
Plugin
Web
Socket
Options
Web
Sockets()
Web
Socket
Server
Session
Web
Socket
Upgrade
Companion
ktor-server-servlet
io.
ktor.
server.
servlet
Async
Servlet
Application
Call
Async
Servlet
Application
Request
Async
Servlet
Application
Response
Companion
Default
Servlet
Upgrade
java
Security
Principal
Ktor
Servlet
put
Servlet
Attributes()
Servlet
Application
Engine
Companion
Servlet
Application
Request
Servlet
Application
Request
Cookies
Servlet
Application
Request
Headers
Servlet
Application
Response
Servlet
Context
Attribute
servlet
Request
Attributes
Servlet
Upgrade
Servlet
Upgrade
Handler
Upgrade
Request
web
Resources()
Web
Resources
Config
io.
ktor.
server.
servlet.
v4
do
Push()
ktor-server-servlet-jakarta
io.
ktor.
server.
servlet.
jakarta
Async
Servlet
Application
Call
Async
Servlet
Application
Request
Async
Servlet
Application
Response
Companion
Default
Servlet
Upgrade
java
Security
Principal
Ktor
Servlet
put
Servlet
Attributes()
Servlet
Application
Engine
Companion
Servlet
Application
Request
Servlet
Application
Request
Cookies
Servlet
Application
Request
Headers
Servlet
Application
Response
Servlet
Context
Attribute
servlet
Request
Attributes
Servlet
Upgrade
Servlet
Upgrade
Handler
Upgrade
Request
web
Resources()
Web
Resources
Config
io.
ktor.
server.
servlet.
jakarta.
v4
do
Push()
ktor-server-test-base
io.
ktor.
server.
test.
base
Base
Test
Engine
Test
Base
Companion
High
Load
Http
Generator
Companion
Stress
Test
Condition
ktor-server-test-host
io.
ktor.
server.
testing
Application
Test
Builder
Client
Provider
create
Test
Environment()
Expected
Test
Exception
External
Services
Builder
It
it()
On
on()
run
Test
Application()
Test
Application
Test
Application()
test
Application()
Test
Application
Builder
Test
Application
Call
Test
Application
Engine
Configuration
Test
Application
Request
Test
Application
Response
Test
Engine
with
Application()
with
Test
Application()
io.
ktor.
server.
testing.
client
Invalid
Test
Request
Exception
Test
Http
Client
Config
Test
Http
Client
Engine
Companion
ktor-server-test-suites
io.
ktor.
server.
testing.
suites
Client
Cert
Test
Suite
Companion
Compression
Test
Suite
Config
Test
Suite
Connection
Test
Suite
Content
Test
Suite
Companion
count
Engine
Stress
Suite
Http
Server
Common
Test
Suite
Http
Server
Jvm
Test
Suite
Server
Plugins
Test
Suite
Sustainability
Test
Suite
Custom
Fail
Web
Socket
Engine
Suite
ktor-server-tomcat
io.
ktor.
server.
tomcat
Engine
Main
Tomcat
Tomcat
Application
Engine
Companion
Configuration
ktor-server-tomcat-jakarta
io.
ktor.
server.
tomcat.
jakarta
Engine
Main
Tomcat
Tomcat
Application
Engine
Companion
Configuration
ktor-call-id
io.
ktor.
callid
CALL_
ID_
DEFAULT_
DICTIONARY
Ktor
Call
Id
Context
Element
Companion
with
Call
Id()
ktor-events
io.
ktor.
events
Event
Definition
Event
Handler
Events
raise
Catching()
ktor-resources
io.
ktor.
resources
href()
Resource
Resources
Configuration
Resource
Serialization
Exception
io.
ktor.
resources.
serialization
Resources
Format
Parameter
ktor-serialization
io.
ktor.
serialization
Configuration
Content
Converter
Content
Convert
Exception
deserialize()
Json
Convert
Exception
serialize()
suitable
Charset()
suitable
Charset
Or
Null()
Websocket
Content
Converter
Websocket
Content
Convert
Exception
Websocket
Converter
Not
Found
Exception
Websocket
Deserialize
Exception
ktor-serialization-gson
io.
ktor.
serialization.
gson
gson()
Gson
Converter
Gson
Websocket
Content
Converter
ktor-serialization-jackson
io.
ktor.
serialization.
jackson
jackson()
Jackson
Converter
Jackson
Websocket
Content
Converter
ktor-serialization-kotlinx
io.
ktor.
serialization.
kotlinx
add
Extension
Provider()
guess
Serializer()
Kotlinx
Serialization
Converter
Kotlinx
Serialization
Extension
Kotlinx
Serialization
Extension
Provider
Kotlinx
Websocket
Serialization
Converter
serialization()
serializer
For
Type
Info()
ktor-serialization-kotlinx-cbor
io.
ktor.
serialization.
kotlinx.
cbor
cbor()
Default
Cbor
ktor-serialization-kotlinx-json
io.
ktor.
serialization.
kotlinx.
json
Default
Json
Experimental
Json
Converter
json()
json
Io()
Kotlinx
Serialization
Json
Extension
Provider
ktor-serialization-kotlinx-protobuf
io.
ktor.
serialization.
kotlinx.
protobuf
Default
Proto
Buf
protobuf()
ktor-serialization-kotlinx-tests
io.
ktor.
serialization.
kotlinx.
test
Abstract
Contextual
Serialization
Test
Abstract
Serialization
Test
Abstract
Server
Serialization
Kotlinx
Test
Github
Profile
User
Data
User
Data
Serializer
ktor-serialization-kotlinx-xml
io.
ktor.
serialization.
kotlinx.
xml
Default
Xml
xml()
ktor-serialization-tests
io.
ktor.
serialization.
test
Abstract
Server
Serialization
Test
Child
Entity
My
Entity
ktor-sse
io.
ktor.
sse
COLON
END_
OF_
LINE
END_
OF_
LINE_
VARIANTS
Server
Sent
Event
Server
Sent
Event
Metadata
SPACE
Typed
Server
Sent
Event
ktor-test-base
io.
ktor.
test
and
Then()
DEFAULT_
RETRIES
retry
Test()
run
Test
With
Data()
Test
Case
Test
Execution
Result
Test
Failure
Test
Success
io.
ktor.
test.
junit
assert
All()
assert
Serializable()
Error
Collector
Error
Collector
Test
Multiple
Failure
Exception
ktor-websocket-serialization
io.
ktor.
websocket.
serialization
receive
Deserialized
Base()
send
Serialized
Base()
ktor-websockets
io.
ktor.
websocket
close()
close
Exceptionally()
Close
Reason
Codes
Companion
NORMAL
GOING_
AWAY
PROTOCOL_
ERROR
CANNOT_
ACCEPT
CLOSED_
ABNORMALLY
NOT_
CONSISTENT
VIOLATED_
POLICY
TOO_
BIG
NO_
EXTENSION
INTERNAL_
ERROR
SERVICE_
RESTART
TRY_
AGAIN_
LATER
Default
Web
Socket
Session
Default
Web
Socket
Session()
extension()
extension
Or
Null()
Frame
Binary
Close
Companion
Ping
Pong
Text
Frame
Parser
State
HEADER0
LENGTH
MASK_
KEY
BODY
Frame
Too
Big
Exception
Frame
Type
Companion
TEXT
BINARY
CLOSE
PING
PONG
parse
Web
Socket
Extensions()
PINGER_
DISABLED
ping
Interval
Protocol
Violation
Exception
Raw
Web
Socket()
read
Bytes()
read
Frame()
read
Reason()
read
Text()
send()
Serializer
Simple
Frame
Collector
timeout
Web
Socket
Deflate
Extension
Companion
Config
Web
Socket
Extension
Web
Socket
Extension
Factory
Web
Socket
Extension
Header
Web
Socket
Extensions
Config
Web
Socket
Reader
Web
Socket
Session
Web
Socket
Writer
write
Frame()
ktor-test-dispatcher
io.
ktor.
test.
dispatcher
run
Test
With
Real
Time()
test
Suspend()
ktor-utils
io.
ktor.
util
append
All()
append
Filtered()
append
If
Name
Absent()
append
If
Name
And
Value
Absent()
as
Stream()
Attribute
Key
Attribute
Key()
Attributes
Attributes()
Attributes
Js
build()
Case
Insensitive
Map
case
Insensitive
Map()
Case
Insensitive
Set
chomp()
combine
Safe()
contains()
Content
Encoder
copy()
copy
To
Both()
create
Fixed
Thread
Dispatcher()
create
LRUCache()
decode
Base64Bytes()
decode
Base64String()
decode
String()
Deflate
deflated()
Deflate
Encoder
Digest
Digest()
encode
Base64()
Encoder
Equatable
Attribute
Key
escape
HTML()
filter()
flatten
Entries()
flatten
For
Each()
generate
Nonce()
Generate
Only
Nonce
Manager
get
Digest
Function()
GZip
GZip
Encoder
Hash
hex()
Identity
Identity
Encoder
is
Lower
Case()
move
To()
move
To
Byte
Array()
Nonce
Manager
normalize
And
Relativize()
Platform
Js
Js
Platform
Browser
Node
Jvm
Native
Wasm
Js
platform
Platform
Utils
print
Debug
Tree()
put
All()
read()
read
Short()
root
Cause
sha1()
Silent
Supervisor()
split()
Stateless
Hmac
Nonce
Manager
String
Values
Companion
String
Values
Builder
String
Values
Builder
Impl
String
Values
Impl
String
Values
Single
Impl
Thread
Info
to
Byte
Array()
to
Char
Array()
to
Js
Array()
to
Lower
Case
Preserving
ASCIIRules()
to
Map()
to
Upper
Case
Preserving
ASCIIRules()
unmodifiable()
values
Of()
Worker
Stacktrace
write()
io.
ktor.
util.
cio
buffered
Writer()
Channel
IOException
Channel
Read
Exception
Channel
Write
Exception
Ktor
Default
Pool
pass()
read
Channel()
to
Byte
Array()
to
Byte
Read
Channel()
use()
write
Channel()
writer()
io.
ktor.
util.
collections
Concurrent
Map
Concurrent
Set()
Copy
On
Write
Hash
Map
Lock
Free
MPSCQueue
shared
List()
shared
List
Of()
shared
Map()
io.
ktor.
util.
converters
Conversion
Service
Data
Conversion
Configuration
Data
Conversion
Exception
Default
Conversion
Service
Delegating
Conversion
Service
Configuration
io.
ktor.
util.
date
[js]Invalid
Timestamp
Exception
[wasm
Js]Invalid
Timestamp
Exception
get
Time
Millis()
GMTDate
Companion
GMTDate()
GMTDate
Parser
Companion
Invalid
Date
String
Exception
minus()
Month
Companion
JANUARY
FEBRUARY
MARCH
APRIL
MAY
JUNE
JULY
AUGUST
SEPTEMBER
OCTOBER
NOVEMBER
DECEMBER
plus()
to
Date()
to
Jvm
Date()
truncate
To
Seconds()
Week
Day
Companion
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY
io.
ktor.
util.
debug
add
To
Context
In
Debug
Mode()
init
Context
In
Debug
Mode()
use
Context
Element
In
Debug
Mode()
io.
ktor.
util.
debug.
plugins
Plugin
Name
Key
Plugins
Trace
Key
Plugin
Trace
Element
Plugin
Event
STARTED
FINISHED
io.
ktor.
util.
internal
init
Cause
Bridge()
io.
ktor.
util.
logging
[js
And
Wasm
Shared]Log
Level
TRACE
DEBUG
INFO
WARN
ERROR
NONE
[posix]Log
Level
TRACE
DEBUG
INFO
WARN
ERROR
error()
is
Trace
Enabled
Ktor
Simple
Logger()
Logger
trace()
io.
ktor.
util.
network
address
hostname
Network
Address
Network
Address()
port
Resolved
Network
Address()
Unresolved
Address
Exception
io.
ktor.
util.
pipeline
execute()
intercept()
Invalid
Phase
Exception
Pipeline
Pipeline
Context
Pipeline
Interceptor
Pipeline
Phase
io.
ktor.
util.
reflect
instance
Of()
Js
Type
load
Service
Or
Null()
load
Services()
load
Services
As
Sequence()
platform
Type
reified
Type
Type
Type
Info
type
Info()
type
Info
Impl()
ktor-server-servlet-jakarta
/
io.ktor.server.servlet.jakarta
/
javaSecurityPrincipal
java
Security
Principal
val
ApplicationRequest
.
javaSecurityPrincipal
:
Principal
?
Returns Java's JAAS Principal
Report a problem