Protocol Buffer Services

From NovaOrdis Knowledge Base
Revision as of 01:54, 11 May 2024 by Ovidiu (talk | contribs) (Created page with "=Internal= Protocol Buffers can define services that use messages to exchange data. A '''service''' is a set of '''endpoints''', introduced by the <code>rpc</code> keyword, with different semantics that can be used to call into the service, by sending a request, and then receiving a response. <syntaxhighlight lang='protobuf'> service SomeService { rpc SomeEndpoint(SomeRequest) returns (SomeResponse); rpc SomeOtherEndpoint(SomeOtherRequest) returns (So...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Internal

Protocol Buffers can define services that use messages to exchange data.

A service is a set of endpoints, introduced by the rpc keyword, with different semantics that can be used to call into the service, by sending a request, and then receiving a response.

service SomeService {
  rpc SomeEndpoint(SomeRequest) returns (SomeResponse);
  rpc SomeOtherEndpoint(SomeOtherRequest) returns (SomeOtherResponse);
}

message SomeRequest {
  ...
}

message SomeResponse {
  ...
}

message SomeOtherRequest {
  ...
}

message SomeOtherResponse {
  ...
}

This is how you define an API.

The service and the client code is generated by a framework, and the preferred one is gRPC.

gRPC and Protocol Buffer Services