{"id":6312,"date":"2018-06-23T19:53:18","date_gmt":"2018-06-23T19:53:18","guid":{"rendered":"http:\/\/putridparrot.com\/blog\/?p=6312"},"modified":"2018-06-23T19:55:52","modified_gmt":"2018-06-23T19:55:52","slug":"using-grpc-with-protocol-buffers","status":"publish","type":"post","link":"https:\/\/putridparrot.com\/blog\/using-grpc-with-protocol-buffers\/","title":{"rendered":"Using gRPC with Protocol Buffers"},"content":{"rendered":"

In the last post, Using Protocol Buffers<\/a>, we looked at creating .proto files and how we generate C# code from them along with how to stream the binary data created by the generated code.<\/p>\n

Let’s now look at how we might like to use Protocol Buffers “over the wire”.<\/p>\n

Whilst we can write our own sockets code and stream data via this, there’s a close relationship between gRPC and Protocol Buffers which allows us to generate RPC code using the. proto file.<\/p>\n

Let’s begin by adding a service and a method to the .proto file, so add the following<\/p>\n

\r\nservice MusicService {\r\n   rpc Query(NotesRequest) returns (NotesResponse) {\r\n   }\r\n}\r\n<\/pre>\n
In the last post, I mentioned the NoteResponse was designed for use in the remoting code. Here it’s our return type.<\/em><\/p>\n
To generate the gRPC code we need to make some additions to our previously defined Pre-Build event. Before we can do that, we need some more tools installed. So using nuget install the following package, Grpc.Tools, while you’re at it, if you’re working with the VS project previously defined, also add the package Grpc.<\/p>\n
Now, append the following to the Pre-Build command (formatted to be a little more readable)<\/p>\n
\r\n--grpc_out $(ProjectDir) \r\n--plugin=protoc-gen-grpc=$(SolutionDir)packages\\Grpc.Tools.1.12.0\\tools\\windows_x86\\grpc_csharp_plugin.exe\r\n<\/pre>\n
In my case, rebuilding my VS solution will result in a new file MusicGrpc.cs<\/em> which I’ll need to include in the project.<\/p>\n
If you’ve created a Console application already, this can act as the server, so you’ll need to create another Console application to be our client. I won’t go through all the steps for adding the files etc. but let’s just jump straight into looking at the server code.<\/p>\n
The Server<\/strong><\/p>\n
Add a new class, mine’s MusicServer we derive this from the gRPC generated MusicServiceBase, like this<\/p>\n
\r\nusing System.Threading.Tasks;\r\nusing Grpc.Core;\r\nusing PutridParrot.Music;\r\n\r\nnamespace Server\r\n{\r\n    public class MusicServer : MusicService.MusicServiceBase\r\n    {\r\n        public override Task<NotesResponse> Query(\r\n           NotesRequest request, \r\n           ServerCallContext context)\r\n        {\r\n            if (request.Key == Note.C)\r\n            {\r\n                return Task.FromResult(new NotesResponse\r\n                {\r\n                    Name = request.Name,\r\n                    Key = request.Key,\r\n                    Notes =\r\n                    {\r\n                        Note.C, Note.E, Note.G\r\n                    }\r\n                });\r\n            }\r\n            return base.Query(request, context);\r\n        }\r\n    }\r\n}\r\n<\/pre>\n
Obviously the functionality here is rather limited, but you get the idea, the Query method was generated for us by protoc, and we simply supply our implementation.<\/p>\n
To run up the server, we change our Main method to look like this<\/p>\n
\r\nvar server = new Grpc.Core.Server\r\n{\r\n   Services = \r\n   {\r\n      MusicService.BindService(new MusicServer())\r\n   },\r\n   Ports = \r\n   { \r\n      new ServerPort("127.0.0.1", \r\n         50051, \r\n         ServerCredentials.Insecure)\r\n   }\r\n};\r\n\r\nserver.Start();\r\n\r\nConsole.ReadKey();\r\nserver.ShutdownAsync().Wait();\r\n<\/pre>\n
This is pretty self-explanatory, we supply the Server with the Services and the ports, then start the server.<\/p>\n
The Client<\/strong><\/p>\n
The client code looks like this<\/p>\n
\r\nvar channel = new Channel(\r\n   "127.0.0.1:50051", \r\n   ChannelCredentials.Insecure);\r\n\r\nvar client = new MusicService.MusicServiceClient(channel);\r\n\r\nvar request = new NotesRequest\r\n{\r\n   Key = Note.C,\r\n   Name = "Major"\r\n};\r\n\r\nvar response = client.Query(request);\r\n\r\n\/\/ output the results\r\nforeach (var note in response.Notes)\r\n{\r\n   Console.WriteLine(note);\r\n}\r\n      \r\nchannel.ShutdownAsync().Wait();\r\n<\/pre>\n
As you can see, we create a Channel which is the equivalent of a socket connection, passing in the and port information.<\/p>\n
Next we create an instance of the MusicServiceClient which was generated by protoc for us. Everything else is as you’d expect, we create our request object call our rpc method passing in the request and a response object is returned.<\/p>\n
Code available here https:\/\/github.com\/putridparrot\/blog-projects\/tree\/master\/ProtocolBuffers\/CSharp<\/p>\n","protected":false},"excerpt":{"rendered":"
In the last post, Using Protocol Buffers, we looked at creating .proto files and how we generate C# code from them along with how to stream the binary data created by the generated code. Let’s now look at how we might like to use Protocol Buffers “over the wire”. Whilst we can write our own […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[221,220],"tags":[],"class_list":["post-6312","post","type-post","status-publish","format-standard","hentry","category-grpc","category-protocol-buffers"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/6312","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/comments?post=6312"}],"version-history":[{"count":5,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/6312\/revisions"}],"predecessor-version":[{"id":6322,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/6312\/revisions\/6322"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=6312"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=6312"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=6312"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}