# vkcom/knet architecture

> Architecture diagram of the GitHub repository vkcom/knet, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vkcom/knet
- Repository: https://github.com/vkcom/knet

## Overview

##### Project Type and Purpose
- This is a multi‑module Android networking library (“KNet”) that wraps Google’s Cronet engine, adds a core HTTP client layer, and provides an OkHttp integration adapter. Its goal is to give Android apps easy access to HTTP/3/QUIC, HTTP/2, metrics, interceptors, logging, and fallback points.

##### File‑Structure Analysis
- Top‑level Gradle files (build.gradle, settings.gradle, dependencies.gradle, etc.) orchestrate a 3‑module Gradle project under the `knet` directory.
- knet/core – The pure Kotlin HTTP client core (pipeline, request/response abstractions, interceptors, metrics, utilities, exceptions).
- knet/cronet – The Cronet‑backed engine module (JNI libs, Cronet API jars, builders, dispatcher, native pools, CronetConfig, logging).
- knet/okcronet – The OkHttp interceptor adapter module (adapts KNet core to OkHttp’s Interceptor API).

##### Key README Insights
- Initialization flows: build a `CronetKnetEngine`, configure QUIC/HTTP2, timeouts, cache, pools, metrics, interceptors → wrap into core `Knet` → optionally wrap into an OkHttp interceptor.
- Emphasizes extensibility (interceptors, metrics listeners) and upcoming integrations (ExoPlayer, Ktor, Flipper).

##### Main Components
a. **Android Application** (host app)
b. **KNet Core** module – contains `KnetEngine`, `HttpPipeline`, interceptors, metrics, exceptions
c. **Cronet Engine** module – JNI layer, Cronet native libs, `CronetKnetEngine`, network dispatcher, QUIC/HTTP2 config
d. **OkHttp Adapter** module – `KnetToOkHttpInterceptor`
e. **External Dependencies** – Cronet native libraries, OkHttp, Android framework, ByteArrayPools

##### Relationships and Data Flow
- App calls → `CronetKnetEngine.Build(...)` → Cronet Engine config & initialization (native libs, thread pools, cache)
- CronetKnetEngine → passed into `Knet.Build(cronetEngine)` → instantiates core `KnetEngine`
- `KnetEngine` creates an `HttpPipeline` (chain of interceptors) → user interceptors → final executor
- Executor hands off to Cronet dispatcher (native network I/O) → returns `HttpResponse` back up the pipeline
- Optionally, wrap the `KnetEngine` into an OkHttp Interceptor to let OkHttp use it as its transport
- Metric listeners plug into core pipeline, Cronet logging plugs in at the Cronet layer

##### Architectural Patterns and Principles
- **Modularization**: separates core HTTP abstraction, Cronet‑specific engine, and OkHttp adapter into independent modules.
- **Builder Pattern**: heavy use in CronetKnetEngine.Build and Knet.Build to allow fluent configuration.
- **Interceptor Chain**: core pipeline uses chain‑of‑responsibility to allow request/response modification and retry logic.
- **Adapter Pattern**: wraps KNet into OkHttp interceptor.
- **Native Bridging**: JNI libs for Cronet, with thread pools, byte‑buffer pools, locking.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Top-level Application
    App["Android Application"]:::external

    %% Cronet Engine Module
    subgraph "Cronet Engine Module"
        direction TB
        CEBuilder["CronetEngineBuilder"]:::cronet
        CEEngine["CronetKnetEngine"]:::cronet
        CEDispatcher["CronetDispatcher"]:::cronet
        CEGPLoader["CronetLibLoader"]:::cronet
        subgraph "Cronet Config"
            direction TB
            CronetQuic["CronetQuic"]:::cronet
            CronetCache["CronetCache"]:::cronet
        end
    end

    %% KNet Core Module
    subgraph "KNet Core Module"
        direction TB
        KnetCore["Knet"]:::core
        KnetEngine["KnetEngine"]:::core
        PipelineFactory["HttpPipelineFactory"]:::core
        Pipeline["HttpPipeline"]:::core
        Executor["HttpExecutor"]:::core
        Interceptor["HttpInterceptor"]:::core
        Metrics["HttpMetricsListener"]:::core
    end

    %% OkHttp Adapter Module
    subgraph "OkHttp Adapter Module"
        direction TB
        Adapter["KnetToOkHttpInterceptor"]:::adapter
        ReqFilter["OkHttpRequestFilter"]:::adapter
        ExtAdapters["ExtensionAdapters"]:::adapter
    end

    %% External Dependencies
    subgraph "External Dependencies"
        direction TB
        NativeLibs["Cronet Native Libs"]:::external
        OkHttpExt["OkHttp"]:::external
        AndroidFW["Android Framework"]:::external
        BytePools["ByteArrayPools"]:::external
    end

    %% Data and Control Flows
    App -->|"build CronetKnetEngine"| CEBuilder
    CEBuilder -- dashed --> CEEngine
    CEEngine -->|"inject engine into Knet.Build()"| KnetCore
    KnetCore --> KnetEngine
    KnetEngine --> PipelineFactory
    PipelineFactory --> Pipeline
    Pipeline --> Interceptor
    Interceptor --> Executor
    Executor -->|"native dispatch"| CEDispatcher
    CEDispatcher -->|HttpResponse| Executor
    KnetCore -->|"wrap into OkHttp interceptor"| Adapter
    Adapter --> OkHttpExt

    %% External integrations
    CEGPLoader --> NativeLibs
    CronetQuic --> CEEngine
    CronetCache --> CEEngine
    Metrics --> KnetEngine
    AndroidFW --> CEEngine
    BytePools --> Executor

    %% Click Events for component mapping
    click KnetCore "https://github.com/vkcom/knet/blob/main/knet/core/src/main/java/com/vk/knet/core/Knet.kt"
    click KnetEngine "https://github.com/vkcom/knet/blob/main/knet/core/src/main/java/com/vk/knet/core/KnetEngine.kt"
    click Pipeline "https://github.com/vkcom/knet/blob/main/knet/core/src/main/java/com/vk/knet/core/http/HttpPipeline.kt"
    click PipelineFactory "https://github.com/vkcom/knet/blob/main/knet/core/src/main/java/com/vk/knet/core/http/HttpPipelineFactory.kt"
    click Executor "https://github.com/vkcom/knet/blob/main/knet/core/src/main/java/com/vk/knet/core/http/HttpExecutor.kt"
    click Interceptor "https://github.com/vkcom/knet/blob/main/knet/core/src/main/java/com/vk/knet/core/http/HttpInterceptor.kt"
    click Metrics "https://github.com/vkcom/knet/blob/main/knet/core/src/main/java/com/vk/knet/core/http/metric/HttpMetricsListener.kt"

    click CEEngine "https://github.com/vkcom/knet/blob/main/knet/cronet/src/main/java/com/vk/knet/cornet/CronetKnetEngine.kt"
    click CEBuilder "https://github.com/vkcom/knet/blob/main/knet/cronet/src/main/java/com/vk/knet/cornet/CronetEngineBuilder.kt"
    click CEDispatcher "https://github.com/vkcom/knet/blob/main/knet/cronet/src/main/java/com/vk/knet/cornet/CronetDispatcher.kt"
    click CEGPLoader "https://github.com/vkcom/knet/blob/main/knet/cronet/src/main/java/com/vk/knet/cornet/CronetLibLoader.kt"

    click Adapter "https://github.com/vkcom/knet/blob/main/knet/okcronet/src/main/java/com/vk/knet/okcronet/KnetToOkHttpInterceptor.kt"
    click ReqFilter "https://github.com/vkcom/knet/blob/main/knet/okcronet/src/main/java/com/vk/knet/okcronet/OkHttpRequestFilter.kt"
    click ExtAdapters "https://github.com/vkcom/knet/blob/main/knet/okcronet/src/main/java/com/vk/knet/okcronet/ExtensionAdapters.kt"

    %% Styles
    classDef core fill:#cfe2f3,stroke:#2a6f97,color:#0b3d91
    classDef cronet fill:#d9ead3,stroke:#267326,color:#274e13
    classDef adapter fill:#ffe599,stroke:#b58900,color:#614700
    classDef external fill:#f2f2f2,stroke:#999999,color:#333333
    class CEBuilder,CEEngine,CEDispatcher,CEGPLoader,CronetQuic,CronetCache cronet
    class KnetCore,KnetEngine,PipelineFactory,Pipeline,Executor,Interceptor,Metrics core
    class Adapter,ReqFilter,ExtAdapters adapter
    class App,NativeLibs,OkHttpExt,AndroidFW,BytePools external
```
