1 // Copyright 2015 gRPC authors. 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 15 syntax = "proto3"; 16 17 option java_multiple_files = true; 18 option java_package = "io.grpc.examples.routeguide"; 19 option java_outer_classname = "RouteGuideProto"; 20 option objc_class_prefix = "RTG"; 21 22 package routeguide; 23 24 // Interface exported by the server. 25 service RouteGuide { 26 // A simple RPC. 27 // 28 // Obtains the feature at a given position. 29 // 30 // A feature with an empty name is returned if there's no feature at the given 31 // position. 32 rpc GetFeature(Point) returns (Feature) {} 33 34 // A server-to-client streaming RPC. 35 // 36 // Obtains the Features available within the given Rectangle. Results are 37 // streamed rather than returned at once (e.g. in a response message with a 38 // repeated field), as the rectangle may cover a large area and contain a 39 // huge number of features. 40 rpc ListFeatures(Rectangle) returns (stream Feature) {} 41 42 // A client-to-server streaming RPC. 43 // 44 // Accepts a stream of Points on a route being traversed, returning a 45 // RouteSummary when traversal is completed. 46 rpc RecordRoute(stream Point) returns (RouteSummary) {} 47 48 // A Bidirectional streaming RPC. 49 // 50 // Accepts a stream of RouteNotes sent while a route is being traversed, 51 // while receiving other RouteNotes (e.g. from other users). 52 rpc RouteChat(stream RouteNote) returns (stream RouteNote) {} 53 } 54 55 // Points are represented as latitude-longitude pairs in the E7 representation 56 // (degrees multiplied by 10**7 and rounded to the nearest integer). 57 // Latitudes should be in the range +/- 90 degrees and longitude should be in 58 // the range +/- 180 degrees (inclusive). 59 message Point { 60 int32 latitude = 1; 61 int32 longitude = 2; 62 } 63 64 // A latitude-longitude rectangle, represented as two diagonally opposite 65 // points "lo" and "hi". 66 message Rectangle { 67 // One corner of the rectangle. 68 Point lo = 1; 69 70 // The other corner of the rectangle. 71 Point hi = 2; 72 } 73 74 // A feature names something at a given point. 75 // 76 // If a feature could not be named, the name is empty. 77 message Feature { 78 // The name of the feature. 79 string name = 1; 80 81 // The point where the feature is detected. 82 Point location = 2; 83 } 84 85 // A RouteNote is a message sent while at a given point. 86 message RouteNote { 87 // The location from which the message is sent. 88 Point location = 1; 89 90 // The message to be sent. 91 string message = 2; 92 } 93 94 // A RouteSummary is received in response to a RecordRoute rpc. 95 // 96 // It contains the number of individual points received, the number of 97 // detected features, and the total distance covered as the cumulative sum of 98 // the distance between each point. 99 message RouteSummary { 100 // The number of points received. 101 int32 point_count = 1; 102 103 // The number of known features passed while traversing the route. 104 int32 feature_count = 2; 105 106 // The distance covered in metres. 107 int32 distance = 3; 108 109 // The duration of the traversal in seconds. 110 int32 elapsed_time = 4; 111 } 112
