routeguide

package
v1.10.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 28, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package routeguide is a generated protocol buffer package.

It is generated from these files: 

route_guide.proto

It has these top-level messages: 

Point
Rectangle
Feature
RouteNote
RouteSummary

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterRouteGuideServer 

func RegisterRouteGuideServer(s *grpc.Server, srv RouteGuideServer)

Types

type Feature 

type Feature struct {
	// The name of the feature.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The point where the feature is detected.
	Location *Point `protobuf:"bytes,2,opt,name=location" json:"location,omitempty"`
}

A feature names something at a given point.

If a feature could not be named, the name is empty.

func (*Feature) Descriptor 

func (*Feature) Descriptor() ([]byte, []int)

func (*Feature) GetLocation 

func (m *Feature) GetLocation() *Point

func (*Feature) GetName added in v1.6.0 

func (m *Feature) GetName() string

func (*Feature) ProtoMessage 

func (*Feature) ProtoMessage()

func (*Feature) Reset 

func (m *Feature) Reset()

func (*Feature) String 

func (m *Feature) String() string

type Point 

type Point struct {
	Latitude  int32 `protobuf:"varint,1,opt,name=latitude" json:"latitude,omitempty"`
	Longitude int32 `protobuf:"varint,2,opt,name=longitude" json:"longitude,omitempty"`
}

Points are represented as latitude-longitude pairs in the E7 representation (degrees multiplied by 10**7 and rounded to the nearest integer). Latitudes should be in the range +/- 90 degrees and longitude should be in the range +/- 180 degrees (inclusive).

func (*Point) Descriptor 

func (*Point) Descriptor() ([]byte, []int)

func (*Point) GetLatitude added in v1.6.0 

func (m *Point) GetLatitude() int32

func (*Point) GetLongitude added in v1.6.0 

func (m *Point) GetLongitude() int32

func (*Point) ProtoMessage 

func (*Point) ProtoMessage()

func (*Point) Reset 

func (m *Point) Reset()

func (*Point) String 

func (m *Point) String() string

type Rectangle 

type Rectangle struct {
	// One corner of the rectangle.
	Lo *Point `protobuf:"bytes,1,opt,name=lo" json:"lo,omitempty"`
	// The other corner of the rectangle.
	Hi *Point `protobuf:"bytes,2,opt,name=hi" json:"hi,omitempty"`
}

A latitude-longitude rectangle, represented as two diagonally opposite points "lo" and "hi".

func (*Rectangle) Descriptor 

func (*Rectangle) Descriptor() ([]byte, []int)

func (*Rectangle) GetHi 

func (m *Rectangle) GetHi() *Point

func (*Rectangle) GetLo 

func (m *Rectangle) GetLo() *Point

func (*Rectangle) ProtoMessage 

func (*Rectangle) ProtoMessage()

func (*Rectangle) Reset 

func (m *Rectangle) Reset()

func (*Rectangle) String 

func (m *Rectangle) String() string

type RouteGuideClient 

type RouteGuideClient interface {
	// A simple RPC.
	//
	// Obtains the feature at a given position.
	//
	// A feature with an empty name is returned if there's no feature at the given
	// position.
	GetFeature(ctx context.Context, in *Point, opts ...grpc.CallOption) (*Feature, error)
	// A server-to-client streaming RPC.
	//
	// Obtains the Features available within the given Rectangle.  Results are
	// streamed rather than returned at once (e.g. in a response message with a
	// repeated field), as the rectangle may cover a large area and contain a
	// huge number of features.
	ListFeatures(ctx context.Context, in *Rectangle, opts ...grpc.CallOption) (RouteGuide_ListFeaturesClient, error)
	// A client-to-server streaming RPC.
	//
	// Accepts a stream of Points on a route being traversed, returning a
	// RouteSummary when traversal is completed.
	RecordRoute(ctx context.Context, opts ...grpc.CallOption) (RouteGuide_RecordRouteClient, error)
	// A Bidirectional streaming RPC.
	//
	// Accepts a stream of RouteNotes sent while a route is being traversed,
	// while receiving other RouteNotes (e.g. from other users).
	RouteChat(ctx context.Context, opts ...grpc.CallOption) (RouteGuide_RouteChatClient, error)
}

func NewRouteGuideClient 

func NewRouteGuideClient(cc *grpc.ClientConn) RouteGuideClient

type RouteGuideServer 

type RouteGuideServer interface {
	// A simple RPC.
	//
	// Obtains the feature at a given position.
	//
	// A feature with an empty name is returned if there's no feature at the given
	// position.
	GetFeature(context.Context, *Point) (*Feature, error)
	// A server-to-client streaming RPC.
	//
	// Obtains the Features available within the given Rectangle.  Results are
	// streamed rather than returned at once (e.g. in a response message with a
	// repeated field), as the rectangle may cover a large area and contain a
	// huge number of features.
	ListFeatures(*Rectangle, RouteGuide_ListFeaturesServer) error
	// A client-to-server streaming RPC.
	//
	// Accepts a stream of Points on a route being traversed, returning a
	// RouteSummary when traversal is completed.
	RecordRoute(RouteGuide_RecordRouteServer) error
	// A Bidirectional streaming RPC.
	//
	// Accepts a stream of RouteNotes sent while a route is being traversed,
	// while receiving other RouteNotes (e.g. from other users).
	RouteChat(RouteGuide_RouteChatServer) error
}

type RouteGuide_ListFeaturesClient 

type RouteGuide_ListFeaturesClient interface {
	Recv() (*Feature, error)
	grpc.ClientStream
}

type RouteGuide_ListFeaturesServer 

type RouteGuide_ListFeaturesServer interface {
	Send(*Feature) error
	grpc.ServerStream
}

type RouteGuide_RecordRouteClient 

type RouteGuide_RecordRouteClient interface {
	Send(*Point) error
	CloseAndRecv() (*RouteSummary, error)
	grpc.ClientStream
}

type RouteGuide_RecordRouteServer 

type RouteGuide_RecordRouteServer interface {
	SendAndClose(*RouteSummary) error
	Recv() (*Point, error)
	grpc.ServerStream
}

type RouteGuide_RouteChatClient 

type RouteGuide_RouteChatClient interface {
	Send(*RouteNote) error
	Recv() (*RouteNote, error)
	grpc.ClientStream
}

type RouteGuide_RouteChatServer 

type RouteGuide_RouteChatServer interface {
	Send(*RouteNote) error
	Recv() (*RouteNote, error)
	grpc.ServerStream
}

type RouteNote 

type RouteNote struct {
	// The location from which the message is sent.
	Location *Point `protobuf:"bytes,1,opt,name=location" json:"location,omitempty"`
	// The message to be sent.
	Message string `protobuf:"bytes,2,opt,name=message" json:"message,omitempty"`
}

A RouteNote is a message sent while at a given point.

func (*RouteNote) Descriptor 

func (*RouteNote) Descriptor() ([]byte, []int)

func (*RouteNote) GetLocation 

func (m *RouteNote) GetLocation() *Point

func (*RouteNote) GetMessage added in v1.6.0 

func (m *RouteNote) GetMessage() string

func (*RouteNote) ProtoMessage 

func (*RouteNote) ProtoMessage()

func (*RouteNote) Reset 

func (m *RouteNote) Reset()

func (*RouteNote) String 

func (m *RouteNote) String() string

type RouteSummary 

type RouteSummary struct {
	// The number of points received.
	PointCount int32 `protobuf:"varint,1,opt,name=point_count,json=pointCount" json:"point_count,omitempty"`
	// The number of known features passed while traversing the route.
	FeatureCount int32 `protobuf:"varint,2,opt,name=feature_count,json=featureCount" json:"feature_count,omitempty"`
	// The distance covered in metres.
	Distance int32 `protobuf:"varint,3,opt,name=distance" json:"distance,omitempty"`
	// The duration of the traversal in seconds.
	ElapsedTime int32 `protobuf:"varint,4,opt,name=elapsed_time,json=elapsedTime" json:"elapsed_time,omitempty"`
}

A RouteSummary is received in response to a RecordRoute rpc.

It contains the number of individual points received, the number of detected features, and the total distance covered as the cumulative sum of the distance between each point.

func (*RouteSummary) Descriptor 

func (*RouteSummary) Descriptor() ([]byte, []int)

func (*RouteSummary) GetDistance added in v1.6.0 

func (m *RouteSummary) GetDistance() int32

func (*RouteSummary) GetElapsedTime added in v1.6.0 

func (m *RouteSummary) GetElapsedTime() int32

func (*RouteSummary) GetFeatureCount added in v1.6.0 

func (m *RouteSummary) GetFeatureCount() int32

func (*RouteSummary) GetPointCount added in v1.6.0 

func (m *RouteSummary) GetPointCount() int32

func (*RouteSummary) ProtoMessage 

func (*RouteSummary) ProtoMessage()

func (*RouteSummary) Reset 

func (m *RouteSummary) Reset()

func (*RouteSummary) String 

func (m *RouteSummary) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.