Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 42 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,34 +18,36 @@ You can use it to:
* hadoop_rpc (may be opensourced)
* [rdma](https://en.wikipedia.org/wiki/Remote_direct_memory_access) support
* [thrift](docs/en/thrift.md) support, thread-safe, more friendly and performant than the official clients.
* all sorts of protocols used in Baidu: [baidu_std](docs/cn/baidu_std.md), [streaming_rpc](docs/en/streaming_rpc.md), hulu_pbrpc, [sofa_pbrpc](https://github.com/baidu/sofa-pbrpc), nova_pbrpc, public_pbrpc, ubrpc and nshead-based ones.
* all sorts of protocols used in Baidu: [baidu_std](docs/en/baidu_std.md), [streaming_rpc](docs/en/streaming_rpc.md), hulu_pbrpc, [sofa_pbrpc](https://github.com/baidu/sofa-pbrpc), nova_pbrpc, public_pbrpc, ubrpc and nshead-based ones.
* Build [HA](https://en.wikipedia.org/wiki/High_availability) distributed services using an industrial-grade implementation of [RAFT consensus algorithm](https://raft.github.io) which is opensourced at [braft](https://github.com/brpc/braft)
* Servers can handle requests [synchronously](docs/en/server.md) or [asynchronously](docs/en/server.md#asynchronous-service).
* Clients can access servers [synchronously](docs/en/client.md#synchronus-call), [asynchronously](docs/en/client.md#asynchronous-call), [semi-synchronously](docs/en/client.md#semi-synchronous-call), or use [combo channels](docs/en/combo_channel.md) to simplify sharded or parallel accesses declaratively.
* Debug services [via http](docs/en/builtin_service.md), and run [cpu](docs/cn/cpu_profiler.md), [heap](docs/cn/heap_profiler.md) and [contention](docs/cn/contention_profiler.md) profilers.
* Debug services [via http](docs/en/builtin_service.md), and run [cpu](docs/en/cpu_profiler.md), [heap](docs/en/heap_profiler.md) and [contention](docs/en/contention_profiler.md) profilers.
* Get [better latency and throughput](docs/en/overview.md#better-latency-and-throughput).
* [Extend bRPC](docs/en/new_protocol.md) with the protocols used in your organization quickly, or customize components, including [naming services](docs/cn/load_balancing.md#命名服务) (dns, zk, etcd), [load balancers](docs/cn/load_balancing.md#负载均衡) (rr, random, consistent hashing)
* [Extend bRPC](docs/en/new_protocol.md) with the protocols used in your organization quickly, or customize components, including [naming services](docs/en/load_balancing.md) (dns, zk, etcd), [load balancers](docs/en/load_balancing.md) (rr, random, consistent hashing)

# Try it!

* Read [overview](docs/en/overview.md) to know where bRPC can be used and its advantages.
* Read [getting started](docs/cn/getting_started.md) for building steps and play with [examples](https://github.com/apache/brpc/tree/master/example/).
* Read [getting started](docs/en/getting_started.md) for building steps and play with [examples](https://github.com/apache/brpc/tree/master/example/).
* Docs:
* [Performance benchmark](docs/cn/benchmark.md)
* [Performance benchmark](docs/en/benchmark.md)
* [bvar](docs/en/bvar.md)
* [bvar_c++](docs/cn/bvar_c++.md)
* [bthread](docs/cn/bthread.md)
* [bthread or not](docs/cn/bthread_or_not.md)
* [thread-local](docs/cn/thread_local.md)
* [Execution Queue](docs/cn/execution_queue.md)
* [bvar_c++](docs/en/bvar_c++.md)
* [bthread](docs/en/bthread.md)
* [bthread or not](docs/en/bthread_or_not.md)
* [thread-local](docs/en/thread_local.md)
* [Execution Queue](docs/en/execution_queue.md)
* [bthread tracer](docs/en/bthread_tracer.md)
* [bthread tagged task group](docs/en/bthread_tagged_task_group.md)
* Client
* [Basics](docs/en/client.md)
* [Error code](docs/en/error_code.md)
* [Combo channels](docs/en/combo_channel.md)
* [Access http/h2](docs/en/http_client.md)
* [Access gRPC](docs/en/http_derivatives.md#h2grpc)
* [Access thrift](docs/en/thrift.md#client-accesses-thrift-server)
* [Access UB](docs/cn/ub_client.md)
* [Access thrift](docs/en/thrift.md#client-accesses-thrift-server)
* [Access UB](docs/en/ub_client.md)
* [Streaming RPC](docs/en/streaming_rpc.md)
* [Access redis](docs/en/redis_client.md)
* [Access memcached](docs/en/memcache_client.md)
Expand All @@ -56,32 +58,37 @@ You can use it to:
* [Serve http/h2](docs/en/http_service.md)
* [Serve gRPC](docs/en/http_derivatives.md#h2grpc)
* [Serve thrift](docs/en/thrift.md#server-processes-thrift-requests)
* [Serve Nshead](docs/cn/nshead_service.md)
* [Debug server issues](docs/cn/server_debugging.md)
* [Serve Nshead](docs/en/nshead_service.md)
* [Debug server issues](docs/en/server_debugging.md)
* [Server push](docs/en/server_push.md)
* [Avalanche](docs/cn/avalanche.md)
* [Auto ConcurrencyLimiter](docs/cn/auto_concurrency_limiter.md)
* [Avalanche](docs/en/avalanche.md)
* [Auto ConcurrencyLimiter](docs/en/auto_concurrency_limiter.md)
* [Media Server](https://github.com/brpc/media-server)
* [json2pb](docs/cn/json2pb.md)
* [json2pb](docs/en/json2pb.md)
* [Builtin Services](docs/en/builtin_service.md)
* [status](docs/en/status.md)
* [vars](docs/en/vars.md)
* [connections](docs/cn/connections.md)
* [flags](docs/cn/flags.md)
* [rpcz](docs/cn/rpcz.md)
* [cpu_profiler](docs/cn/cpu_profiler.md)
* [heap_profiler](docs/cn/heap_profiler.md)
* [contention_profiler](docs/cn/contention_profiler.md)
* [connections](docs/en/connections.md)
* [flags](docs/en/flags.md)
* [rpcz](docs/en/rpcz.md)
* [cpu_profiler](docs/en/cpu_profiler.md)
* [heap_profiler](docs/en/heap_profiler.md)
* [contention_profiler](docs/en/contention_profiler.md)
* Tools
* [rpc_press](docs/cn/rpc_press.md)
* [rpc_replay](docs/cn/rpc_replay.md)
* [rpc_view](docs/cn/rpc_view.md)
* [benchmark_http](docs/cn/benchmark_http.md)
* [parallel_http](docs/cn/parallel_http.md)
* [rpc_press](docs/en/rpc_press.md)
* [rpc_replay](docs/en/rpc_replay.md)
* [rpc_view](docs/en/rpc_view.md)
* [benchmark_http](docs/en/benchmark_http.md)
* [parallel_http](docs/en/parallel_http.md)
* Others
* [IOBuf](docs/en/iobuf.md)
* [Streaming Log](docs/en/streaming_log.md)
* [FlatMap](docs/cn/flatmap.md)
* [FlatMap](docs/en/flatmap.md)
* [Coroutine](docs/en/coroutine.md)
* [Circuit Breaker](docs/en/circuit_breaker.md)
* [RDMA](docs/en/rdma.md)
* [Bazel Support](docs/en/bazel_support.md)
* [Wireshark baidu_std dissector plugin](docs/en/wireshark_baidu_std.md)
* [bRPC introduction](docs/cn/brpc_intro.pptx)(training material)
* [A tutorial on building large-scale services](docs/en/tutorial_on_building_services.pptx)(training material)
* [bRPC internal](docs/en/brpc_internal.pptx)(training material)
Expand All @@ -90,12 +97,12 @@ You can use it to:
* [Atomic instructions](docs/en/atomic_instructions.md)
* [IO](docs/en/io.md)
* [Threading Overview](docs/en/threading_overview.md)
* [Load Balancing](docs/cn/load_balancing.md)
* [Locality-aware](docs/cn/lalb.md)
* [Consistent Hashing](docs/cn/consistent_hashing.md)
* [Memory Management](docs/cn/memory_management.md)
* [Timer keeping](docs/cn/timer_keeping.md)
* [bthread_id](docs/cn/bthread_id.md)
* [Load Balancing](docs/en/load_balancing.md)
* [Locality-aware](docs/en/lalb.md)
* [Consistent Hashing](docs/en/consistent_hashing.md)
* [Memory Management](docs/en/memory_management.md)
* [Timer keeping](docs/en/timer_keeping.md)
* [bthread_id](docs/en/bthread_id.md)
* Use cases
* [User cases](community/cases.md)

Expand Down
9 changes: 8 additions & 1 deletion README_cn.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[English version](README.md)

[![Build Status](https://api.travis-ci.com/apache/brpc.svg?branch=master)](https://travis-ci.com/github/apache/brpc)
[![Linux Build Status](https://github.com/apache/brpc/actions/workflows/ci-linux.yml/badge.svg)](https://github.com/apache/brpc/actions/workflows/ci-linux.yml)
[![MacOs Build Status](https://github.com/apache/brpc/actions/workflows/ci-macos.yml/badge.svg)](https://github.com/apache/brpc/actions/workflows/ci-macos.yml)

![brpc logo (light)](docs/images/logo.png#gh-light-mode-only)
![brpc logo (dark)](docs/images/logo-white.png#gh-dark-mode-only)
Expand Down Expand Up @@ -39,6 +40,7 @@
* [thread-local](docs/cn/thread_local.md)
* [Execution Queue](docs/cn/execution_queue.md)
* [bthread tracer](docs/cn/bthread_tracer.md)
* [bthread tagged task group](docs/cn/bthread_tagged_task_group.md)
* Client
* [基础功能](docs/cn/client.md)
* [错误码](docs/cn/error_code.md)
Expand Down Expand Up @@ -83,6 +85,11 @@
* [IOBuf](docs/cn/iobuf.md)
* [Streaming Log](docs/cn/streaming_log.md)
* [FlatMap](docs/cn/flatmap.md)
* [协程](docs/cn/coroutine.md)
* [熔断](docs/cn/circuit_breaker.md)
* [RDMA](docs/cn/rdma.md)
* [Bazel构建支持](docs/cn/bazel_support.md)
* [Wireshark baidu_std协议解析插件](docs/cn/wireshark_baidu_std.md)
* [bRPC外功修炼宝典](docs/cn/brpc_intro.pptx)(培训材料)
* [搭建大型服务入门](docs/en/tutorial_on_building_services.pptx)(培训材料)
* [bRPC内功修炼宝典](docs/en/brpc_internal.pptx)(培训材料)
Expand Down
5 changes: 5 additions & 0 deletions docs/cn/couchbase_example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Couchbase 示例

本文档尚未翻译为中文。

请参阅[英文版](../en/couchbase_example.md)获取完整内容。
7 changes: 7 additions & 0 deletions docs/en/auto_concurrency_limiter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# auto concurrency limiter

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/auto_concurrency_limiter.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/baidu_std.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# uaidu std

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/baidu_std.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/benchmark.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# uenchmark

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/benchmark.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/benchmark_http.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# uenchmark http

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/benchmark_http.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/bthread.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# uthread

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/bthread.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/bthread_id.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# uthread id

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/bthread_id.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/bthread_or_not.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# uthread or not

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/bthread_or_not.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/bthread_tagged_task_group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# uthread tagged task group

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/bthread_tagged_task_group.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/bthread_tracer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# uthread tracer

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/bthread_tracer.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/case_apicontrol.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# case apicontrol

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/case_apicontrol.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/case_baidu_dsp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# case uaidu dsp

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/case_baidu_dsp.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/case_elf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# case elf

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/case_elf.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/case_ubrpc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# case uurpc

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/case_ubrpc.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/circuit_breaker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# circuit ureaker

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/circuit_breaker.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/connections.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# connections

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/connections.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/consistent_hashing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# consistent hashing

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/consistent_hashing.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/contention_profiler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# contention profiler

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/contention_profiler.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/coroutine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# coroutine

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/coroutine.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/cpu_profiler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# cpu profiler

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/cpu_profiler.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/endpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# endpoint

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/endpoint.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/execution_queue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# execution queue

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/execution_queue.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/flags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# flags

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/flags.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/flatmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# flatmap

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/flatmap.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/heap_profiler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# heap profiler

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/heap_profiler.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/json2pb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# json2pb

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/json2pb.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/load_balancing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# load ualancing

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/load_balancing.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/mbvar_c++.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# muvar c++

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/mbvar_c++.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/memory_management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# memory management

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/memory_management.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/nshead_service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# nshead service

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/nshead_service.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
7 changes: 7 additions & 0 deletions docs/en/parallel_http.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# parallel http

This document has not yet been translated into English.

Please refer to the [Chinese version](../cn/parallel_http.md) for the full content.

Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.
Loading
Loading