fastapi Architecture Docs
Home / Function/ websocket_endpoint() — fastapi Function Reference

websocket_endpoint() — fastapi Function Reference

Architecture documentation for the websocket_endpoint() function in tutorial003_py39.py from the fastapi codebase.

Function python FastAPI Routing calls 4

Entity Profile

Dependency Diagram

graph TD
  9dba2689_548c_65af_d963_050993507c3b["websocket_endpoint()"]
  1cc0df18_a262_3520_422c_6ce4f27e3b54["tutorial003_py39.py"]
  9dba2689_548c_65af_d963_050993507c3b -->|defined in| 1cc0df18_a262_3520_422c_6ce4f27e3b54
  c1da2a55_247a_7198_2a59_d8aa20b35871["connect()"]
  9dba2689_548c_65af_d963_050993507c3b -->|calls| c1da2a55_247a_7198_2a59_d8aa20b35871
  c2690806_6e87_c353_7b36_a0899c36dbd8["send_personal_message()"]
  9dba2689_548c_65af_d963_050993507c3b -->|calls| c2690806_6e87_c353_7b36_a0899c36dbd8
  a5412e7a_143e_482b_92bf_f504c73ffad6["broadcast()"]
  9dba2689_548c_65af_d963_050993507c3b -->|calls| a5412e7a_143e_482b_92bf_f504c73ffad6
  826f39eb_5f5b_cb43_a16d_1fe440bf16a7["disconnect()"]
  9dba2689_548c_65af_d963_050993507c3b -->|calls| 826f39eb_5f5b_cb43_a16d_1fe440bf16a7
  style 9dba2689_548c_65af_d963_050993507c3b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/websockets/tutorial003_py39.py lines 72–81

async def websocket_endpoint(websocket: WebSocket, client_id: int):
    await manager.connect(websocket)
    try:
        while True:
            data = await websocket.receive_text()
            await manager.send_personal_message(f"You wrote: {data}", websocket)
            await manager.broadcast(f"Client #{client_id} says: {data}")
    except WebSocketDisconnect:
        manager.disconnect(websocket)
        await manager.broadcast(f"Client #{client_id} left the chat")

Domain

Subdomains

Defined In

Calls

Source

Frequently Asked Questions

What does websocket_endpoint() do?
websocket_endpoint() is a function in the fastapi codebase, defined in docs_src/websockets/tutorial003_py39.py.
Where is websocket_endpoint() defined?
websocket_endpoint() is defined in docs_src/websockets/tutorial003_py39.py at line 72.
What does websocket_endpoint() call?
websocket_endpoint() calls 4 function(s): broadcast, connect, disconnect, send_personal_message.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free