vane 0.9.2

A flow-based reverse proxy with multi-layer routing and programmable pipelines.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

---
title: WebSocket
description: Bidirectional tunneling and upgrades.
icon: Replace
---

import { Step, Steps } from 'fumadocs-ui/components/steps';

## Logic Flow

WebSockets require a "Protocol Upgrade" within L7. Vane handles this via a multi-phase process.

<Steps>
<Step>
### Ingress & Capture

The Adapter detects the upgrade request and "steals" the upgrade handle from Hyper before the request body is processed.

<Mermaid
	chart="
graph LR
    Client[Client] -->|GET /ws| Hyper
    Hyper -->|Parse| Adapter
    Adapter -->|Extract Future| Handle[Client Upgrade Handle]
    Handle -->|Store| Container[Container ProtocolData]
    Adapter -->|Request| Flow[Flow Engine]
"
/>
</Step>

<Step>
### Upstream Negotiation

The `FetchUpstream` middleware connects to the backend. If the backend accepts the upgrade (HTTP 101), Vane captures the _upstream_ upgrade handle.

<Mermaid
	chart="
graph LR
    Flow -->|Execute| Upstream[Fetch Upstream]
    Upstream -->|GET /ws| Backend
    Backend -->|HTTP 101| Upstream
    Upstream -->|Extract Future| Handle[Upstream Upgrade Handle]
    Handle -->|Store| Container
"
/>
</Step>

<Step>
### Tunnel Establishment

The `SendResponse` terminator detects both handles. It sends the final 101 response to the client (triggering the switch) and spawns a background tunnel.

<Mermaid
	chart="
graph LR
    Terminator -->|Check Handles| Container
    Terminator -->|Send HTTP 101| Client
    Terminator -->|Spawn| Tunnel[Tunnel Task]
    
    ClientIO[Client Socket] <-->|Bi-Directional Copy| Tunnel
    UpstreamIO[Backend Socket] <-->|Bi-Directional Copy| Tunnel
"
/>
</Step>
</Steps>