Where is the language reference or grammar for a service definition?

Question

Where is the language reference or grammar for a service definition?

cliffbdf opened this issue 8 years ago · comments

It would be really helpful to have a normative reference for service definitions. Thanks!

Kailash Sethuraman · Answer 1 · Fri Jan 06 2017 07:10:04 GMT+0800 (China Standard Time)

@cliffbdf could you elaborate further? We currently support the use of protocol buffers to define gRPC services and their documentation is here: https://developers.google.com/protocol-buffers/docs/proto3

Is that what you were looking for? Could you provide more details around what you are looking for?
If it is indeed the documentation for procol buffers, how / where can we link to it more prominently?

Cliff Berg · Answer 2 · Fri Jan 06 2017 07:16:48 GMT+0800 (China Standard Time)

Yes, I saw that, but messages are only part of a service specification - I was not able to find a normative reference for a service definition, including the methods that it defines. Best regards, Cliff

…

On Jan 5, 2017, at 6:10 PM, Kailash Sethuraman ***@***.***> wrote: @cliffbdf <https://github.com/cliffbdf> could you elaborate further? We currently support the use of protocol buffers to define gRPC services and their documentation is here: https://developers.google.com/protocol-buffers/docs/proto3 <https://developers.google.com/protocol-buffers/docs/proto3> Is that what you were looking for? Could you provide more details around what you are looking for? If it is indeed the documentation for procol buffers, how / where can we link to it more prominently? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#438 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AGRfw4c-vudhVUWWRU1Zlf_0CQ-el7PSks5rPXhNgaJpZM4LZH18>.

Kailash Sethuraman · Answer 3 · Fri Jan 06 2017 07:26:46 GMT+0800 (China Standard Time)

There is a small section on defining services here:
https://developers.google.com/protocol-buffers/docs/proto3#services
But i do agree that it is barebones and does to pass as normative.

https://github.com/grpc/grpc/tree/master/examples/protos has proto examples that you can refer in the meanwhile..

Would updating and improving the section above to ensure that it is normative resolve your concerns?

Cliff Berg · Answer 4 · Fri Jan 06 2017 08:00:02 GMT+0800 (China Standard Time)

Actually I did not see that - since protocol buffers is the underlying transport for gRPC, it is unexpected that service definitions would be documented in Protocol Buffers. But the guide is decent. Still, it leaves questions unanswered that a normative definition/guide would: e.g., in some examples I have seen, there are curly braces {} following an rpc prototype, but the example in the guide does not have {} - why? It would be nice to have an actual grammar definition, with each possible branch/option defined. Overall the guide is good though, and the underlying technology (gRPC and PB) looks awesome! Very best, Cliff

…

On Jan 5, 2017, at 6:26 PM, Kailash Sethuraman ***@***.***> wrote: There is a small section on defining services here: https://developers.google.com/protocol-buffers/docs/proto3#services <https://developers.google.com/protocol-buffers/docs/proto3#services> But i do agree that it is barebones and does to pass as normative. https://github.com/grpc/grpc/tree/master/examples/protos <https://github.com/grpc/grpc/tree/master/examples/protos> has proto examples that you can refer in the meanwhile.. Would updating and improving the section above to ensure that it is normative resolve your concerns? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#438 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AGRfw7Z8rRZqokA-cLdNWnOzsKyzbS4Sks5rPXw4gaJpZM4LZH18>.

Cliff Berg · Answer 5 · Thu Feb 23 2017 23:11:23 GMT+0800 (China Standard Time)

Hi Kailash - has the protoc compiiler been changed to generate different output? When I run it, protoc —java_out=my_dir TaskEngine.proto with this proto file (TaskEngine.proto), syntax = "proto3"; option java_multiple_files = true; option java_package = "scaledmarkets.piper"; option java_outer_classname = "TaskEngine"; package piper; service TaskEngineServant { rpc ping(Request) returns (Response) {} } message Request { } message Response { string message = 1; } it generates the following files: Request.java RequetOrBuilder.java Response.java ResponseOrBuilder.java TaskEngine.java Yes, the documentation <http://www.grpc.io/docs/tutorials/basic/java.html> says that it should generate something like, TaskEngineGrpc.java, containing TaskEngineGrpc.TaskEngineImplBase. Best regards, Cliff

…

On Jan 5, 2017, at 6:26 PM, Kailash Sethuraman ***@***.***> wrote: There is a small section on defining services here: https://developers.google.com/protocol-buffers/docs/proto3#services <https://developers.google.com/protocol-buffers/docs/proto3#services> But i do agree that it is barebones and does to pass as normative. https://github.com/grpc/grpc/tree/master/examples/protos <https://github.com/grpc/grpc/tree/master/examples/protos> has proto examples that you can refer in the meanwhile.. Would updating and improving the section above to ensure that it is normative resolve your concerns? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#438 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AGRfw7Z8rRZqokA-cLdNWnOzsKyzbS4Sks5rPXw4gaJpZM4LZH18>.

Eric Gribkoff · Answer 6 · Fri Feb 24 2017 00:27:48 GMT+0800 (China Standard Time)

You need to tell protoc about the gRPC Java plugin in order to get the TaskEngineGrpc.java output.

From the grpc-java/compiler/ directory, run this to generate the plugin:

../gradlew java_pluginExecutable

And invoke with:

protoc --plugin=protoc-gen-grpc-java=/path/to/grpc-java/compiler/build/exe/java_plugin/protoc-gen-grpc-java --grpc-java_out=. "TaskEngine.proto"

See https://github.com/grpc/grpc-java/blob/master/compiler/README.md for more details.

Cliff Berg · Answer 7 · Fri Feb 24 2017 02:37:10 GMT+0800 (China Standard Time)

Multiple build operations failed.

C++ compiler failed while compiling java_plugin.cpp. C++ compiler failed while compiling java_generator.h. C++ compiler failed while compiling java_generator.cpp. See the complete log at: file:///Users/cliffordberg/Library/grpc-java-1.1.2/compiler/build/tmp/compileJava_pluginExecutableJava_pluginCpp/output.txt * Try: Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. BUILD FAILED Total time: 4 mins 15.099 secs Clifford-Bergs-MacBook-Pro:compiler cliffordberg$

Eric Gribkoff · Answer 8 · Fri Feb 24 2017 03:10:41 GMT+0800 (China Standard Time)

What version of protoc is installed? (protoc --version). It's also possible you need to specify the search paths for header files and libraries, see https://github.com/grpc/grpc-java/blob/master/COMPILING.md#mac.

Cliff Berg · Answer 9 · Fri Feb 24 2017 05:32:45 GMT+0800 (China Standard Time)

On Feb 23, 2017, at 2:10 PM, Eric Gribkoff ***@***.***> wrote: What version of protoc is installed? (protoc --version). It's also possible you need to specify the search paths for header files and libraries, see https://github.com/grpc/grpc-java/blob/master/COMPILING.md#mac <https://github.com/grpc/grpc-java/blob/master/COMPILING.md#mac>.

protoc version: libprotoc 3.1.0 I tried setting CXXFLAGS and LDFLAGS as in the notes for mac, but still an error. I am using El Capitan (OSX 10.11.6) - please seel below. Would you be able to upload a binary for the release? Or send me one? Right now the release only contains a zip of the source code. Clifford-Bergs-MacBook-Pro:grpc-java-1.1.2 cliffordberg$ ../gradlew java_pluginExecutable -bash: ../gradlew: No such file or directory Clifford-Bergs-MacBook-Pro:grpc-java-1.1.2 cliffordberg$ cd compiler Clifford-Bergs-MacBook-Pro:compiler cliffordberg$ ../gradlew java_pluginExecutable The Task.leftShift(Closure) method has been deprecated and is scheduled to be removed in Gradle 5.0. Please use Task.doLast(Action) instead. at build_8nzznohhcg3bttwglgwjuqr47$_run_closure1$_closure7$_closure22$_closure24.doCall(/Users/cliffordberg/Library/grpc-java-1.1.2/build.gradle:110) *** Building codegen requires Protobuf version 3.1.0 *** Please refer to https://github.com/grpc/grpc-java/blob/master/COMPILING.md#how-to-build-code-generation-plugin :grpc-compiler:compileJava_pluginExecutableJava_pluginCpp /Users/cliffordberg/Library/grpc-java-1.1.2/compiler/src/java_plugin/cpp/java_generator.h:8:10: fatal error: 'google/protobuf/io/zero_copy_stream.h' file not found #include <google/protobuf/io/zero_copy_stream.h> ^ 1 error generated. In file included from /Users/cliffordberg/Library/grpc-java-1.1.2/compiler/src/java_plugin/cpp/java_plugin.cpp:8: /Users/cliffordberg/Library/grpc-java-1.1.2/compiler/src/java_plugin/cpp/java_generator.h:8:10: fatal error: 'google/protobuf/io/zero_copy_stream.h' file not found #include <google/protobuf/io/zero_copy_stream.h> ^ 1 error generated. In file included from /Users/cliffordberg/Library/grpc-java-1.1.2/compiler/src/java_plugin/cpp/java_generator.cpp:1: /Users/cliffordberg/Library/grpc-java-1.1.2/compiler/src/java_plugin/cpp/java_generator.h:8:10: fatal error: 'google/protobuf/io/zero_copy_stream.h' file not found #include <google/protobuf/io/zero_copy_stream.h> ^ 1 error generated. :grpc-compiler:compileJava_pluginExecutableJava_pluginCpp FAILED FAILURE: Build failed with an exception. * What went wrong: Execution failed for task ':grpc-compiler:compileJava_pluginExecutableJava_pluginCpp'.

Multiple build operations failed.

C++ compiler failed while compiling java_generator.h. C++ compiler failed while compiling java_plugin.cpp. C++ compiler failed while compiling java_generator.cpp. See the complete log at: file:///Users/cliffordberg/Library/grpc-java-1.1.2/compiler/build/tmp/compileJava_pluginExecutableJava_pluginCpp/output.txt * Try: Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. BUILD FAILED Total time: 6.823 secs Clifford-Bergs-MacBook-Pro:compiler cliffordberg$ echo $CXXFLAGS -I/usr/local/include Clifford-Bergs-MacBook-Pro:compiler cliffordberg$ echo $LDFLAGS -L/usr/local/lib Clifford-Bergs-MacBook-Pro:compiler cliffordberg$

Cliff Berg · Answer 10 · Fri Mar 03 2017 06:54:41 GMT+0800 (China Standard Time)

Hi - Will it be possible to post a binary build of protoc for the Mac? Very best, Cliff

…

On Feb 23, 2017, at 4:32 PM, Cliff Berg ***@***.***> wrote: > On Feb 23, 2017, at 2:10 PM, Eric Gribkoff ***@***.*** ***@***.***>> wrote: > > What version of protoc is installed? (protoc --version). It's also possible you need to specify the search paths for header files and libraries, see https://github.com/grpc/grpc-java/blob/master/COMPILING.md#mac <https://github.com/grpc/grpc-java/blob/master/COMPILING.md#mac>. > protoc version: libprotoc 3.1.0 I tried setting CXXFLAGS and LDFLAGS as in the notes for mac, but still an error. I am using El Capitan (OSX 10.11.6) - please seel below. Would you be able to upload a binary for the release? Or send me one? Right now the release only contains a zip of the source code. Clifford-Bergs-MacBook-Pro:grpc-java-1.1.2 cliffordberg$ ../gradlew java_pluginExecutable -bash: ../gradlew: No such file or directory Clifford-Bergs-MacBook-Pro:grpc-java-1.1.2 cliffordberg$ cd compiler Clifford-Bergs-MacBook-Pro:compiler cliffordberg$ ../gradlew java_pluginExecutable The Task.leftShift(Closure) method has been deprecated and is scheduled to be removed in Gradle 5.0. Please use Task.doLast(Action) instead. at build_8nzznohhcg3bttwglgwjuqr47$_run_closure1$_closure7$_closure22$_closure24.doCall(/Users/cliffordberg/Library/grpc-java-1.1.2/build.gradle:110) *** Building codegen requires Protobuf version 3.1.0 *** Please refer to https://github.com/grpc/grpc-java/blob/master/COMPILING.md#how-to-build-code-generation-plugin <https://github.com/grpc/grpc-java/blob/master/COMPILING.md#how-to-build-code-generation-plugin> :grpc-compiler:compileJava_pluginExecutableJava_pluginCpp /Users/cliffordberg/Library/grpc-java-1.1.2/compiler/src/java_plugin/cpp/java_generator.h:8:10: fatal error: 'google/protobuf/io/zero_copy_stream.h' file not found #include <google/protobuf/io/zero_copy_stream.h> ^ 1 error generated. In file included from /Users/cliffordberg/Library/grpc-java-1.1.2/compiler/src/java_plugin/cpp/java_plugin.cpp:8: /Users/cliffordberg/Library/grpc-java-1.1.2/compiler/src/java_plugin/cpp/java_generator.h:8:10: fatal error: 'google/protobuf/io/zero_copy_stream.h' file not found #include <google/protobuf/io/zero_copy_stream.h> ^ 1 error generated. In file included from /Users/cliffordberg/Library/grpc-java-1.1.2/compiler/src/java_plugin/cpp/java_generator.cpp:1: /Users/cliffordberg/Library/grpc-java-1.1.2/compiler/src/java_plugin/cpp/java_generator.h:8:10: fatal error: 'google/protobuf/io/zero_copy_stream.h' file not found #include <google/protobuf/io/zero_copy_stream.h> ^ 1 error generated. :grpc-compiler:compileJava_pluginExecutableJava_pluginCpp FAILED FAILURE: Build failed with an exception. * What went wrong: Execution failed for task ':grpc-compiler:compileJava_pluginExecutableJava_pluginCpp'. > Multiple build operations failed. C++ compiler failed while compiling java_generator.h. C++ compiler failed while compiling java_plugin.cpp. C++ compiler failed while compiling java_generator.cpp. See the complete log at: file:///Users/cliffordberg/Library/grpc-java-1.1.2/compiler/build/tmp/compileJava_pluginExecutableJava_pluginCpp/output.txt <file:///Users/cliffordberg/Library/grpc-java-1.1.2/compiler/build/tmp/compileJava_pluginExecutableJava_pluginCpp/output.txt> * Try: Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. BUILD FAILED Total time: 6.823 secs Clifford-Bergs-MacBook-Pro:compiler cliffordberg$ echo $CXXFLAGS -I/usr/local/include Clifford-Bergs-MacBook-Pro:compiler cliffordberg$ echo $LDFLAGS -L/usr/local/lib Clifford-Bergs-MacBook-Pro:compiler cliffordberg$