grpc-rs - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #typescript #golang #machine-learning #deep-learning #windows #cli #kubernetes #vue #pytorch #security #mcp

grpc-rs

(★ 1,852)

The gRPC library for Rust built on C Core library and futures

파일 탐색기

최종 버전 다운로드 (.zip)

- config.toml
- - bug_report.md
  - feature_request.md
  - something-else.md
- - bug_fix.md
  - feature.md
  - something-else.md
- - 31167.supp
  - ci.yml
- - bench.rs
  - client.rs
  - lib.rs
  - main.rs
  - server.rs
  - util.rs
  - worker.rs
- Cargo.toml
- README.md
- - codegen.rs
  - lib.rs
  - prost_codegen.rs
  - util.rs
- Cargo.toml
- - bindings.rs
- - grpc_wrap.rs
  - lib.rs
- build.rs
- Cargo.toml
- grpc
- grpc_wrap.cc
- link-deps.rs
- - lib.rs
  - proto.rs
  - service.rs
- - health_check.rs
- Cargo.toml
- README.md
- - client.rs
  - lib.rs
  - server.rs
- - tests.rs
- Cargo.toml
- - ca.pem
  - server1.key
  - server1.pem
- - lib.rs
  - proto.rs
  - util.rs
- Cargo.toml
- - client.rs
  - mod.rs
  - server.rs
- - auth_context.rs
  - credentials.rs
  - mod.rs
- - callback.rs
  - executor.rs
  - mod.rs
  - promise.rs
- buf.rs
- channel.rs
- channelz.rs
- client.rs
- codec.rs
- cq.rs
- env.rs
- error.rs
- lib.rs
- log_util.rs
- metadata.rs
- quota.rs
- server.rs
- - log_util.rs
- - lib.rs
  - util.rs
- - tests.rs
- Cargo.toml
- - main.rs
- Cargo.toml
.clang-format
.clang-tidy
.gitignore
.gitmodules
Cargo.toml
CHANGELOG.md
CODE_OF_CONDUCT.md
cross_compile.md
LICENSE
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/tikv/grpc-rs

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd grpc-rs

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Rust

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Rust (rustup) rustup으로 설치하면 cargo도 함께 설치됩니다.

$ cargo xtask submodule # if you just cloned the repository

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ cargo build

Rust 프로젝트를 컴파일합니다.

$ cargo install protobuf-codegen

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ cargo install grpcio-compiler

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ cargo xtask bindgen

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ cargo build가 에러 없이 끝나면 성공입니다. target/ 폴더에 실행 파일이 생성됩니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# gRPC-rs

`gRPC-rs` is a Rust wrapper of [gRPC Core](https://github.com/grpc/grpc). [gRPC](http://www.grpc.io) is a high performance, open source universal RPC framework that puts mobile and HTTP/2 first.

[![Crates.io](https://img.shields.io/crates/v/grpcio.svg?maxAge=2592000)](https://crates.io/crates/grpcio)
[![docs.rs](https://docs.rs/grpcio/badge.svg)](https://docs.rs/grpcio)
[![Build Status](https://github.com/tikv/grpc-rs/workflows/CI/badge.svg)](https://github.com/tikv/grpc-rs/actions)
[![Build Status](https://travis-ci.org/tikv/grpc-rs.svg)](https://travis-ci.org/tikv/grpc-rs)

## Status

This project is still under development. The following features with the check marks are supported:

- [x] Basic asynchronous unary/steaming call
- [x] SSL
- [x] Generic call
- [x] Connection level compression
- [x] Interoperability test
- [x] QPS benchmark
- [ ] Custom metadata
- [x] Health check
- [ ] Reflection
- [X] Authentication
- [ ] Load balance, client side is fully supported, server side load report is not implemented yet.

## Prerequisites

- CMake >= 3.8.0
- Rust >= 1.36.0
- binutils >= 2.22
- LLVM and Clang >= 3.9 if you need to generate bindings at compile time.

For Linux and MacOS, you also need to install gcc 7.3+ (or clang 6+) too.

Bindings are pre-generated for x86_64/arm64 Linux. For other platforms, bindings are generated at compile time.

For Windows, you also need to install following software:

- Active State Perl
- yasm
- Visual Studio 2015+

## Build

```
$ cargo xtask submodule # if you just cloned the repository
$ cargo build
```

### Error linking OpenSSL

If you're getting linker errors when building your project using `gRPC-rs`, head
down to the `openssl` feature section for a possible fix.

## Usage

To generate the sources from proto files:

### Option 1 - Manual Generation

1. Install the protobuf compiler:

```
$ cargo install protobuf-codegen
```

2. Install the gRPC compiler:

```
$ cargo install grpcio-compiler
```

3. Generate the sources:

```
$ protoc --rust_out=. --grpc_out=. --plugin=protoc-gen-grpc=`which grpc_rust_plugin` example.proto
```

### Option 2 - Programmatic Generation

Programmatic generation can be used to generate Rust modules from proto files
via your `build.rs` by using [protoc-grpcio](https://crates.io/crates/protoc-grpcio).

For more information and examples see
[README](https://github.com/mtp401/protoc-grpcio/blob/master/README.md).

To include this project as a dependency:

```
[dependencies]
grpcio = "0.13"
```

### Feature `boringssl`

`boringssl` feature enables support for TLS encryption and some authentication
mechanism. When you do not need it, for example when working in intranet,
you can disable it by using the following configuration:
```
[dependencies]
grpcio = { version = "0.13", default-features = false, features = ["protobuf-codec"] }
```

### Feature `prost-codec` and `protobuf-codec`

`gRPC-rs` uses `protobuf` crate by default. If you want to use `prost` instead, you can enable
`prost-codec` feature. You probably only want to enable only one of the two features. Though
grpcio is completely fine with both features enabled at the same time, grpcio-compiler
will not going to work as expected.

### Feature `openssl` and `openssl-vendored`

`gRPC-rs` comes vendored with `gRPC Core`, which by default uses BoringSSL
instead of OpenSSL. This may cause linking issues due to symbol clashes and/or
missing symbols when another one of your dependencies uses OpenSSL. To resolve
this, you can tell `gRPC-rs` to use OpenSSL too by specifying `"openssl"` in
your `Cargo.toml`'s features list for `gprcio`, which requires openssl (>=1.0.2). E.g.:

```toml
[dependencies]
grpcio = { version = "0.13", features = ["openssl"] }
```

Feature `openssl-vendored` is the same as feature `openssl` except it will build openssl from
bundled sources.

## Performance

See [benchmark](https://github.com/tikv/grpc-rs/tree/master/benchmark) to find out how to run a benchmark by yourself.

Cross Compile
-------------
See [cross_compile](cross_compile.md)

Contributing
------------

Make sure to format and test the code before sending a PR.

If the content in grpc-sys/grpc is updated, you may need to regenerate bindings:

```
$ cargo xtask bindgen
```