Skip to content

source_layout.md

Latest commit

 

History

History
57 lines (44 loc) · 2.21 KB

source_layout.md

File metadata and controls

57 lines (44 loc) · 2.21 KB
Raw

Layout of BFE Code Base

The latest code of BFE can be downloaded from the BFE open source project release page https://github.com/bfenetworks/bfe/releases. This chapter will introduce BFE v1.8.5 as an example.

At the top level of the code directory, you can see that BFE contains the following directories or files:

$ ls bfe/
ADOPTERS.md		CHANGELOG.md		CODE_OF_CONDUCT.md	CONTRIBUTING.md		CONTRIBUTORS.md
AGENTS.md		Dockerfile		GOVERNANCE.md		LICENSE			MAINTAINERS.md
Makefile		NOTICE			README-CN.md		README.md		SECURITY.md
VERSION			bfe.go			go.mod			go.sum			revive.toml		release_local.sh
bfe_balance		bfe_basic		bfe_bufio		bfe_config		bfe_debug
bfe_fcgi		bfe_http		bfe_http2		bfe_module		bfe_modules
bfe_net			bfe_proxy		bfe_route		bfe_server		bfe_spdy
bfe_stream		bfe_tls			bfe_util		bfe_wasmplugin		bfe_websocket
conf			docs			examples		snap			tests

The hierarchical structure of each directory is as follows:

source layout

The functional modules corresponding to each directory in top-down order are described below.

Network Protocol

  • bfe_net: network-related basic library
  • bfe_http: code for HTTP protocol
  • bfe_tls: code for TLS protocol
  • bfe_http2: code for HTTP2 protocol
  • bfe_spdy: code for SPDY protocol
  • bfe_stream: code for TLS proxy
  • bfe_websocket: code for WebSocket proxy
  • bfe_proxy: proxy related basic code

Traffic Routing and Balancing

  • bfe_route: code for traffic routing
  • bfe_balance: code for traffic balancing

Extension Modules

  • bfe_module: code for BFE plugin framework
  • bfe_modules: code for BFE extension modules, including access control, redirect, rewrite, WAF, rate limiting, AI gateway and WASM plugin modules
  • bfe_wasmplugin: code for BFE WASM plugin runtime and ABI adaptation

Service Framework

  • bfe_server: main parts of BFE server

Basic Libraries

  • bfe_basic: BFE basic library
  • bfe_config: configuration loading related code
  • bfe_debug: debug related code
  • bfe_util: BFE basic library related code

links

Previous: Chap26 Support More Protocols
Next: Chap28 Process Model