[GitHub] [incubator-teaclave] m4sterchain commented on a change in pull request #327: [docs] Add doc for the RPC framework

[GitBox <gi...@apache.org>]

m4sterchain commented on a change in pull request #327:
URL: https://github.com/apache/incubator-teaclave/pull/327#discussion_r433561466



##########
File path: rpc/README.md
##########
@@ -0,0 +1,43 @@
+---
+permalink: /rpc
+---
+
+# RPC
+
+This directory contains an RPC implementation over attested TLS connection
+written in Rust, providing trusted channels to send and handle requests.
+RPC interfaces and request/response messages can be defined in ProtoBuf and
+used for generating Rust structs and traits to implement services or client
+function to send requests.
+
+Similar with other RPC frameworks, there are several concepts of RPC in
+Teaclave.
+
+## Channel and Client
+
+A channel in RPC represent a connection to the target service. Clients can use
+the channel to send requests. In Teaclave, we implement `SgxTrustedTlsChannel`,
+which can establish and attested a remote connection. For example, to connect
+the management service, you need to establish a trusted channel with the service
+first. Then, create a client of management service with the channel. At last,
+you can use this client to send requests like `InvokeTask`.
+
+When constructing a client, you can use the `SgxTrustedTlsClientConfig` to setup
+TLS and attestation configs.
+
+## Server and Service
+
+Server is an entity to listening a network address, processing incoming
+messages, and forwarding requests to certain service. Similar with channel in
+Teaclave, we implement `SgxTrustedTlsServer`, which can establish a attested TLS

Review comment:
       a -> an




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@teaclave.apache.org
For additional commands, e-mail: notifications-help@teaclave.apache.org