How ktorio/ktor works
Ktor is a Kotlin asynchronous framework for building HTTP services and clients. The documented server workflow is application setup and feature installation, request routing and handling, then a response served by an embedded or container engine. The tree also shows client engines, networking, WebSockets/SSE, sessions, and a test host as distinct capabilities. Several connections beyond the README workflow are uncertain because most implementation files were not sampled; those links are omitted or marked unverified rather than inferred from names alone.
Main entry points: HttpClient.kt HTTP client · BaseApplicationEngine.kt Base engine · Application.kt Application · EnginePipeline.kt Engine pipeline
Components 22
Server runtime
- Application
ktor-server/ktor-server-core/common/src/io/ktor/server/application/Application.kt - Embedded server
ktor-server/ktor-server-core/common/src/io/ktor/server/engine/EmbeddedServer.kt - Engine API
ktor-server/ktor-server-core/common/src/io/ktor/server/engine/ApplicationEngine.kt - Base engine
ktor-server/ktor-server-core/common/src/io/ktor/server/engine/BaseApplicationEngine.kt - Engine pipeline
ktor-server/ktor-server-core/common/src/io/ktor/server/engine/EnginePipeline.kt - Netty host
ktor-server/ktor-server-netty/jvm/src/io/ktor/server/netty/NettyApplicationEngine.kt - Servlet host
ktor-server/ktor-server-servlet/jvm/src/io/ktor/server/servlet/ServletApplicationEngine.kt - Routing
ktor-server/ktor-server-core/common/src/io/ktor/server/routing - Request handling
ktor-server/ktor-server-core/common/src/io/ktor/server/request/PipelineRequest.kt - Response handling
ktor-server/ktor-server-core/common/src/io/ktor/server/response
HTTP and networking
- HTTP statuses
ktor-http/common/src/io/ktor/http/HttpStatusCode.kt - HTTP headers
ktor-http/common/src/io/ktor/http/HttpHeaders.kt - Network sockets
ktor-network/common/src/io/ktor/network/sockets/SocketEngine.kt - Coroutine pipeline
ktor-utils/common/src/io/ktor/util/pipeline/PipelineContext.kt
Client runtime
- HTTP client
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt - Client engines
ktor-client/ktor-client-cio/common/src/io/ktor/client/engine/cio/CIOEngine.kt - Client plugins
ktor-client/ktor-client-core/common/src/io/ktor/client/plugins
Protocols and extensions
- WebSockets
ktor-client/ktor-client-core/common/src/io/ktor/client/plugins/websocket/WebSockets.kt - Server-sent events
ktor-client/ktor-client-core/common/src/io/ktor/client/plugins/sse/SSE.kt - Sessions
ktor-server/ktor-server-plugins/ktor-server-sessions/common/src/io/ktor/server/sessions/SessionStorage.kt
Testing
- Test application host
ktor-server/ktor-server-test-host/common/src/io/ktor/server/testing/TestApplicationEngine.kt
Other components
- Application developer
Connections 23
- Application developer → Embedded server: configures
- Embedded server → Application: creates
- Embedded server → Engine API: starts
- Application developer → Routing: installs routes
- Routing → Request handling: handles requests
- Request handling → Response handling: produces response
- Response handling → Application developer: returns result
- Engine API → Base engine: implemented by
ktor-server/ktor-server-core/common/src/io/ktor/server/engine/BaseApplicationEngine.kt - Base engine → Engine pipeline: configures
ktor-server/ktor-server-core/common/src/io/ktor/server/engine/BaseApplicationEngine.kt - Netty host → Application: hosts
ktor-server/ktor-server-netty/jvm/src/io/ktor/server/netty/NettyApplicationEngine.kt - Netty host → Engine pipeline: uses
ktor-server/ktor-server-netty/jvm/src/io/ktor/server/netty/NettyApplicationEngine.kt - Servlet host → Application: hosts
ktor-server/ktor-server-servlet/jvm/src/io/ktor/server/servlet/ServletApplicationEngine.kt - Servlet host → Engine pipeline: uses
ktor-server/ktor-server-servlet/jvm/src/io/ktor/server/servlet/ServletApplicationEngine.kt - Base engine → HTTP statuses: selects fallback
ktor-server/ktor-server-core/common/src/io/ktor/server/engine/BaseApplicationEngine.kt - Base engine → HTTP headers: checks host header
ktor-server/ktor-server-core/common/src/io/ktor/server/engine/BaseApplicationEngine.kt - Engine pipeline → Coroutine pipeline: uses execution model
- Application developer → HTTP client: makes HTTP calls
- HTTP client → Client engines: dispatches requests
- HTTP client → Client plugins: installs plugins
- HTTP client → WebSockets: opens sessions
- HTTP client → Server-sent events: opens streams
- Application → Sessions: can install
- Application developer → Test application host: tests application