From 051e833a4c248c821c8a3f3f7001cb6ef0e822c5 Mon Sep 17 00:00:00 2001 From: Jean de Klerk Date: Fri, 13 Jul 2018 14:07:32 -0700 Subject: docs: provide a section aggregating per-language server reflection tutorials This allows users of any language to find documentation about server reflection. I chose this document as the place to put it because it has quite good SEO for the term "server reflection grpc". --- doc/server-reflection.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'doc') diff --git a/doc/server-reflection.md b/doc/server-reflection.md index cceee1647f..43fc1d8c4d 100644 --- a/doc/server-reflection.md +++ b/doc/server-reflection.md @@ -15,6 +15,19 @@ This broadly involves two problems: determining what formats (which protobuf messages) a server’s method uses, and determining how to convert messages between human readable format and the (likely binary) wire format. +## Enabling server reflection + +Enabling server reflection differs language-to-language. Here are links to docs relevant to +each language: + +- [Java](https://github.com/grpc/grpc-java/blob/master/documentation/server-reflection-tutorial.md#enable-server-reflection) +- [Go](https://github.com/grpc/grpc-go/blob/master/Documentation/server-reflection-tutorial.md#enable-server-reflection) +- [C++](https://grpc.io/grpc/cpp/md_doc_server_reflection_tutorial.html) +- Python: (tutorial not yet written) +- C#: (tutorial not yet written) +- Ruby: not yet implemented [#2567](https://github.com/grpc/grpc/issues/2567) +- Node: not yet implemented [#2568](https://github.com/grpc/grpc/issues/2568) + ## Method reflection We want to be able to answer the following queries: -- cgit v1.2.3 From 4cc2e6031c6ccc84b5f53dc05c2992c97f263dd4 Mon Sep 17 00:00:00 2001 From: Jean de Klerk Date: Thu, 26 Jul 2018 08:20:21 -0700 Subject: Move to bottom --- doc/server-reflection.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'doc') diff --git a/doc/server-reflection.md b/doc/server-reflection.md index 43fc1d8c4d..bed09845d5 100644 --- a/doc/server-reflection.md +++ b/doc/server-reflection.md @@ -15,19 +15,6 @@ This broadly involves two problems: determining what formats (which protobuf messages) a server’s method uses, and determining how to convert messages between human readable format and the (likely binary) wire format. -## Enabling server reflection - -Enabling server reflection differs language-to-language. Here are links to docs relevant to -each language: - -- [Java](https://github.com/grpc/grpc-java/blob/master/documentation/server-reflection-tutorial.md#enable-server-reflection) -- [Go](https://github.com/grpc/grpc-go/blob/master/Documentation/server-reflection-tutorial.md#enable-server-reflection) -- [C++](https://grpc.io/grpc/cpp/md_doc_server_reflection_tutorial.html) -- Python: (tutorial not yet written) -- C#: (tutorial not yet written) -- Ruby: not yet implemented [#2567](https://github.com/grpc/grpc/issues/2567) -- Node: not yet implemented [#2568](https://github.com/grpc/grpc/issues/2568) - ## Method reflection We want to be able to answer the following queries: @@ -194,3 +181,16 @@ will need to index those FileDescriptorProtos by file and symbol and imports. One issue is that some grpc implementations are very loosely coupled with protobufs; in such implementations it probably makes sense to split apart these reflection APIs so as not to take an additional proto dependency. + +## Known Implementations + +Enabling server reflection differs language-to-language. Here are links to docs relevant to +each language: + +- [Java](https://github.com/grpc/grpc-java/blob/master/documentation/server-reflection-tutorial.md#enable-server-reflection) +- [Go](https://github.com/grpc/grpc-go/blob/master/Documentation/server-reflection-tutorial.md#enable-server-reflection) +- [C++](https://grpc.io/grpc/cpp/md_doc_server_reflection_tutorial.html) +- Python: (tutorial not yet written) +- C#: (tutorial not yet written) +- Ruby: not yet implemented [#2567](https://github.com/grpc/grpc/issues/2567) +- Node: not yet implemented [#2568](https://github.com/grpc/grpc/issues/2568) -- cgit v1.2.3 From 2898c199a22b66053c32222ca280aba1009c48a2 Mon Sep 17 00:00:00 2001 From: Jean de Klerk Date: Fri, 27 Jul 2018 08:25:05 -0700 Subject: Add C# doc --- doc/server-reflection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server-reflection.md b/doc/server-reflection.md index bed09845d5..c9b476599f 100644 --- a/doc/server-reflection.md +++ b/doc/server-reflection.md @@ -190,7 +190,7 @@ each language: - [Java](https://github.com/grpc/grpc-java/blob/master/documentation/server-reflection-tutorial.md#enable-server-reflection) - [Go](https://github.com/grpc/grpc-go/blob/master/Documentation/server-reflection-tutorial.md#enable-server-reflection) - [C++](https://grpc.io/grpc/cpp/md_doc_server_reflection_tutorial.html) +- [C#](https://github.com/grpc/grpc/blob/master/doc/csharp/server_reflection.md) - Python: (tutorial not yet written) -- C#: (tutorial not yet written) - Ruby: not yet implemented [#2567](https://github.com/grpc/grpc/issues/2567) - Node: not yet implemented [#2568](https://github.com/grpc/grpc/issues/2568) -- cgit v1.2.3