# fangfengxiang/lua-yar architecture

> Architecture diagram of the GitHub repository fangfengxiang/lua-yar, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fangfengxiang/lua-yar
- Repository: https://github.com/fangfengxiang/lua-yar

## Overview

Lua-Yar is a pure-Lua Yar RPC framework. A client calls a remote method using a selected transport; a server accepts requests, dispatches registered methods, and returns results. The README also documents JSON/Msgpack codecs, protocol compatibility, custom packagers, hooks, and several host environments. The source excerpts were unavailable, so internal module connections are left unverified rather than presented as observed calls.

Main entry points: [`src/yar/server/init.lua`](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/init.lua) (Server API), [`src/yar/client.lua`](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/client.lua) (RPC Client), [`src/yar/transport/transport.lua`](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/transport.lua) (Transport Selection), [`src/yar/protocol/protocol.lua`](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/protocol/protocol.lua) (Protocol)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["RPC API"]
  node_client["RPC Client<br/>[client.lua]"]
  node_errors["RPC Errors<br/>[error.lua]"]
  node_logging["Logging<br/>[log.lua]"]
  node_utilities["Utilities<br/>[util.lua]"]
end

subgraph group_wire["Wire Format"]
  node_request["Request Message<br/>[request.lua]"]
  node_response["Response Message<br/>[response.lua]"]
  node_protocol["Protocol<br/>[protocol.lua]"]
  node_header["Protocol Header<br/>[header.lua]"]
  node_framing["Binary Framing<br/>[framing.lua]"]
  node_packager["Packager Registry<br/>[packager.lua]"]
  node_json["JSON Codec<br/>[json.lua]"]
  node_msgpack["Msgpack Codec<br/>[msgpack.lua]"]
end

subgraph group_transport["Transports"]
  node_transport_api["Transport Selection<br/>[transport.lua]"]
  node_resolve["Address Resolution<br/>[resolve.lua]"]
  node_http_transport["HTTP Transport<br/>[http.lua]"]
  node_tcp_transport["TCP Transport<br/>[tcp.lua]"]
  node_socket["Socket I/O<br/>[socket.lua]"]
  node_transport_constants["Transport Constants<br/>[constants.lua]"]
end

subgraph group_server["Server Runtime"]
  node_server_api["Server API<br/>[init.lua]"]
  node_dispatcher["Method Dispatcher<br/>[dispatcher.lua]"]
  node_daemon["Server Daemon<br/>[daemon.lua]"]
  node_http_server["HTTP Server<br/>[http.lua]"]
  node_tcp_server["TCP Server<br/>[tcp.lua]"]
  node_server_constants["Server Constants<br/>[constants.lua]"]
end

node_caller(("Application"))
node_remote(("Remote Yar Service"))

node_caller -->|"calls"| node_client
node_client -->|"RPC request"| node_remote
node_caller -->|"registers methods"| node_server_api
node_caller -->|"starts server"| node_server_api
node_server_api -.->|"dispatches"| node_dispatcher
node_client -.->|"builds request"| node_request
node_client -.->|"handles response"| node_response
node_protocol -.->|"uses header"| node_header
node_protocol -.->|"frames data"| node_framing
node_packager -.->|"selects codec"| node_json
node_packager -.->|"selects codec"| node_msgpack
node_client -.->|"selects transport"| node_transport_api
node_transport_api -.->|"routes HTTP"| node_http_transport
node_transport_api -.->|"routes TCP"| node_tcp_transport
node_transport_api -.->|"resolves address"| node_resolve
node_tcp_transport -.->|"uses sockets"| node_socket
node_server_api -.->|"listens HTTP"| node_http_server
node_server_api -.->|"listens TCP"| node_tcp_server
node_server_api -.->|"runs loop"| node_daemon

click node_client "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/client.lua"
click node_request "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/message/request.lua"
click node_response "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/message/response.lua"
click node_protocol "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/protocol/protocol.lua"
click node_header "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/protocol/header.lua"
click node_framing "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/protocol/framing.lua"
click node_packager "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/packager/packager.lua"
click node_json "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/packager/json.lua"
click node_msgpack "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/packager/msgpack.lua"
click node_transport_api "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/transport.lua"
click node_resolve "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/resolve.lua"
click node_http_transport "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/http.lua"
click node_tcp_transport "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/tcp.lua"
click node_socket "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/socket.lua"
click node_server_api "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/init.lua"
click node_dispatcher "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/dispatcher.lua"
click node_daemon "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/daemon.lua"
click node_http_server "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/http.lua"
click node_tcp_server "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/tcp.lua"
click node_server_constants "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/constants.lua"
click node_transport_constants "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/constants.lua"
click node_errors "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/error.lua"
click node_logging "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/log.lua"
click node_utilities "https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/util.lua"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_client,node_errors,node_logging,node_utilities toneBlue
class node_request,node_response,node_protocol,node_header,node_framing,node_packager,node_json,node_msgpack toneAmber
class node_transport_api,node_resolve,node_http_transport,node_tcp_transport,node_socket,node_transport_constants toneMint
class node_server_api,node_dispatcher,node_daemon,node_http_server,node_tcp_server,node_server_constants toneRose
class node_caller,node_remote toneIndigo
```

## Components

### RPC API

- [RPC Client](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/client.lua): `src/yar/client.lua`
- [RPC Errors](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/error.lua): `src/yar/error.lua`
- [Logging](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/log.lua): `src/yar/log.lua`
- [Utilities](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/util.lua): `src/yar/util.lua`

### Wire Format

- [Request Message](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/message/request.lua): `src/yar/message/request.lua`
- [Response Message](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/message/response.lua): `src/yar/message/response.lua`
- [Protocol](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/protocol/protocol.lua): `src/yar/protocol/protocol.lua`
- [Protocol Header](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/protocol/header.lua): `src/yar/protocol/header.lua`
- [Binary Framing](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/protocol/framing.lua): `src/yar/protocol/framing.lua`
- [Packager Registry](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/packager/packager.lua): `src/yar/packager/packager.lua`
- [JSON Codec](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/packager/json.lua): `src/yar/packager/json.lua`
- [Msgpack Codec](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/packager/msgpack.lua): `src/yar/packager/msgpack.lua`

### Transports

- [Transport Selection](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/transport.lua): `src/yar/transport/transport.lua`
- [Address Resolution](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/resolve.lua): `src/yar/transport/resolve.lua`
- [HTTP Transport](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/http.lua): `src/yar/transport/http.lua`
- [TCP Transport](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/tcp.lua): `src/yar/transport/tcp.lua`
- [Socket I/O](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/socket.lua): `src/yar/transport/socket.lua`
- [Transport Constants](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/transport/constants.lua): `src/yar/transport/constants.lua`

### Server Runtime

- [Server API](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/init.lua): `src/yar/server/init.lua`
- [Method Dispatcher](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/dispatcher.lua): `src/yar/server/dispatcher.lua`
- [Server Daemon](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/daemon.lua): `src/yar/server/daemon.lua`
- [HTTP Server](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/http.lua): `src/yar/server/http.lua`
- [TCP Server](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/tcp.lua): `src/yar/server/tcp.lua`
- [Server Constants](https://github.com/fangfengxiang/lua-yar/blob/main/src/yar/server/constants.lua): `src/yar/server/constants.lua`

### Other components

- **Application**
- **Remote Yar Service**

## Connections

- Application → RPC Client: calls (evidence: `README.md`)
- RPC Client → Remote Yar Service: RPC request (evidence: `README.md`)
- Application → Server API: registers methods (evidence: `README.md`)
- Application → Server API: starts server (evidence: `README.md`)
- Server API → Method Dispatcher: dispatches
- RPC Client → Request Message: builds request
- RPC Client → Response Message: handles response
- Protocol → Protocol Header: uses header
- Protocol → Binary Framing: frames data
- Packager Registry → JSON Codec: selects codec
- Packager Registry → Msgpack Codec: selects codec
- RPC Client → Transport Selection: selects transport
- Transport Selection → HTTP Transport: routes HTTP
- Transport Selection → TCP Transport: routes TCP
- Transport Selection → Address Resolution: resolves address
- TCP Transport → Socket I/O: uses sockets
- Server API → HTTP Server: listens HTTP
- Server API → TCP Server: listens TCP
- Server API → Server Daemon: runs loop
