Documentation ¶
Overview ¶
Package v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterSLAMServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterSLAMServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SLAMServiceClient) error
- func RegisterSLAMServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterSLAMServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SLAMServiceServer) error
- func RegisterSLAMServiceServer(s grpc.ServiceRegistrar, srv SLAMServiceServer)
- type GetMapRequest
- func (*GetMapRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetMapRequest) GetCameraPosition() *v1.Pose
- func (x *GetMapRequest) GetIncludeRobotMarker() bool
- func (x *GetMapRequest) GetMimeType() string
- func (x *GetMapRequest) GetName() string
- func (*GetMapRequest) ProtoMessage()
- func (x *GetMapRequest) ProtoReflect() protoreflect.Message
- func (x *GetMapRequest) Reset()
- func (x *GetMapRequest) String() string
- type GetMapResponse
- func (*GetMapResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetMapResponse) GetImage() []byte
- func (m *GetMapResponse) GetMap() isGetMapResponse_Map
- func (x *GetMapResponse) GetMimeType() string
- func (x *GetMapResponse) GetPointCloud() *v1.PointCloudObject
- func (*GetMapResponse) ProtoMessage()
- func (x *GetMapResponse) ProtoReflect() protoreflect.Message
- func (x *GetMapResponse) Reset()
- func (x *GetMapResponse) String() string
- type GetMapResponse_Image
- type GetMapResponse_PointCloud
- type GetPositionRequest
- func (*GetPositionRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetPositionRequest) GetName() string
- func (*GetPositionRequest) ProtoMessage()
- func (x *GetPositionRequest) ProtoReflect() protoreflect.Message
- func (x *GetPositionRequest) Reset()
- func (x *GetPositionRequest) String() string
- type GetPositionResponse
- func (*GetPositionResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetPositionResponse) GetPose() *v1.PoseInFrame
- func (*GetPositionResponse) ProtoMessage()
- func (x *GetPositionResponse) ProtoReflect() protoreflect.Message
- func (x *GetPositionResponse) Reset()
- func (x *GetPositionResponse) String() string
- type SLAMServiceClient
- type SLAMServiceServer
- type UnimplementedSLAMServiceServer
- type UnsafeSLAMServiceServer
Constants ¶
This section is empty.
Variables ¶
var File_proto_api_service_slam_v1_slam_proto protoreflect.FileDescriptor
var SLAMService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "proto.api.service.slam.v1.SLAMService", HandlerType: (*SLAMServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetPosition", Handler: _SLAMService_GetPosition_Handler, }, { MethodName: "GetMap", Handler: _SLAMService_GetMap_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "proto/api/service/slam/v1/slam.proto", }
SLAMService_ServiceDesc is the grpc.ServiceDesc for SLAMService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSLAMServiceHandler ¶
func RegisterSLAMServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterSLAMServiceHandler registers the http handlers for service SLAMService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterSLAMServiceHandlerClient ¶
func RegisterSLAMServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SLAMServiceClient) error
RegisterSLAMServiceHandlerClient registers the http handlers for service SLAMService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "SLAMServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "SLAMServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "SLAMServiceClient" to call the correct interceptors.
func RegisterSLAMServiceHandlerFromEndpoint ¶
func RegisterSLAMServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterSLAMServiceHandlerFromEndpoint is same as RegisterSLAMServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterSLAMServiceHandlerServer ¶
func RegisterSLAMServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SLAMServiceServer) error
RegisterSLAMServiceHandlerServer registers the http handlers for service SLAMService to "mux". UnaryRPC :call SLAMServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterSLAMServiceHandlerFromEndpoint instead.
func RegisterSLAMServiceServer ¶
func RegisterSLAMServiceServer(s grpc.ServiceRegistrar, srv SLAMServiceServer)
Types ¶
type GetMapRequest ¶
type GetMapRequest struct { // Name of slam service Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Requested MIME type of response (image/jpeg or image/pcd) MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"` // Optional parameter for image/jpeg mime_type, used to project point // cloud into a 2D image. CameraPosition *v1.Pose `protobuf:"bytes,3,opt,name=camera_position,json=cameraPosition,proto3,oneof" json:"camera_position,omitempty"` // Optional parameter for image/jpeg mime_type, defaults to false. // Tells us whether to include the robot position on the 2D image. IncludeRobotMarker bool `protobuf:"varint,4,opt,name=include_robot_marker,json=includeRobotMarker,proto3" json:"include_robot_marker,omitempty"` // contains filtered or unexported fields }
func (*GetMapRequest) Descriptor
deprecated
func (*GetMapRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetMapRequest.ProtoReflect.Descriptor instead.
func (*GetMapRequest) GetCameraPosition ¶
func (x *GetMapRequest) GetCameraPosition() *v1.Pose
func (*GetMapRequest) GetIncludeRobotMarker ¶
func (x *GetMapRequest) GetIncludeRobotMarker() bool
func (*GetMapRequest) GetMimeType ¶
func (x *GetMapRequest) GetMimeType() string
func (*GetMapRequest) GetName ¶
func (x *GetMapRequest) GetName() string
func (*GetMapRequest) ProtoMessage ¶
func (*GetMapRequest) ProtoMessage()
func (*GetMapRequest) ProtoReflect ¶
func (x *GetMapRequest) ProtoReflect() protoreflect.Message
func (*GetMapRequest) Reset ¶
func (x *GetMapRequest) Reset()
func (*GetMapRequest) String ¶
func (x *GetMapRequest) String() string
type GetMapResponse ¶
type GetMapResponse struct { // Image or point cloud of mime_type. // // Types that are assignable to Map: // *GetMapResponse_PointCloud // *GetMapResponse_Image Map isGetMapResponse_Map `protobuf_oneof:"map"` // Actual MIME type of response (image/jpeg or image/pcd) MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"` // contains filtered or unexported fields }
func (*GetMapResponse) Descriptor
deprecated
func (*GetMapResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetMapResponse.ProtoReflect.Descriptor instead.
func (*GetMapResponse) GetImage ¶
func (x *GetMapResponse) GetImage() []byte
func (*GetMapResponse) GetMap ¶
func (m *GetMapResponse) GetMap() isGetMapResponse_Map
func (*GetMapResponse) GetMimeType ¶
func (x *GetMapResponse) GetMimeType() string
func (*GetMapResponse) GetPointCloud ¶
func (x *GetMapResponse) GetPointCloud() *v1.PointCloudObject
func (*GetMapResponse) ProtoMessage ¶
func (*GetMapResponse) ProtoMessage()
func (*GetMapResponse) ProtoReflect ¶
func (x *GetMapResponse) ProtoReflect() protoreflect.Message
func (*GetMapResponse) Reset ¶
func (x *GetMapResponse) Reset()
func (*GetMapResponse) String ¶
func (x *GetMapResponse) String() string
type GetMapResponse_Image ¶
type GetMapResponse_Image struct {
Image []byte `protobuf:"bytes,2,opt,name=image,proto3,oneof"`
}
type GetMapResponse_PointCloud ¶
type GetMapResponse_PointCloud struct {
PointCloud *v1.PointCloudObject `protobuf:"bytes,1,opt,name=point_cloud,json=pointCloud,proto3,oneof"`
}
type GetPositionRequest ¶
type GetPositionRequest struct { // Name of slam service Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*GetPositionRequest) Descriptor
deprecated
func (*GetPositionRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetPositionRequest.ProtoReflect.Descriptor instead.
func (*GetPositionRequest) GetName ¶
func (x *GetPositionRequest) GetName() string
func (*GetPositionRequest) ProtoMessage ¶
func (*GetPositionRequest) ProtoMessage()
func (*GetPositionRequest) ProtoReflect ¶
func (x *GetPositionRequest) ProtoReflect() protoreflect.Message
func (*GetPositionRequest) Reset ¶
func (x *GetPositionRequest) Reset()
func (*GetPositionRequest) String ¶
func (x *GetPositionRequest) String() string
type GetPositionResponse ¶
type GetPositionResponse struct { // Current position of the robot within the World frame. Pose *v1.PoseInFrame `protobuf:"bytes,1,opt,name=pose,proto3" json:"pose,omitempty"` // contains filtered or unexported fields }
func (*GetPositionResponse) Descriptor
deprecated
func (*GetPositionResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetPositionResponse.ProtoReflect.Descriptor instead.
func (*GetPositionResponse) GetPose ¶
func (x *GetPositionResponse) GetPose() *v1.PoseInFrame
func (*GetPositionResponse) ProtoMessage ¶
func (*GetPositionResponse) ProtoMessage()
func (*GetPositionResponse) ProtoReflect ¶
func (x *GetPositionResponse) ProtoReflect() protoreflect.Message
func (*GetPositionResponse) Reset ¶
func (x *GetPositionResponse) Reset()
func (*GetPositionResponse) String ¶
func (x *GetPositionResponse) String() string
type SLAMServiceClient ¶
type SLAMServiceClient interface { // GetPosition returns the current estimated position of the robot with // respect to the "origin" of the map. GetPosition(ctx context.Context, in *GetPositionRequest, opts ...grpc.CallOption) (*GetPositionResponse, error) // GetMap returns the latest map image or point cloud generated by the // SLAM library GetMap(ctx context.Context, in *GetMapRequest, opts ...grpc.CallOption) (*GetMapResponse, error) }
SLAMServiceClient is the client API for SLAMService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewSLAMServiceClient ¶
func NewSLAMServiceClient(cc grpc.ClientConnInterface) SLAMServiceClient
type SLAMServiceServer ¶
type SLAMServiceServer interface { // GetPosition returns the current estimated position of the robot with // respect to the "origin" of the map. GetPosition(context.Context, *GetPositionRequest) (*GetPositionResponse, error) // GetMap returns the latest map image or point cloud generated by the // SLAM library GetMap(context.Context, *GetMapRequest) (*GetMapResponse, error) // contains filtered or unexported methods }
SLAMServiceServer is the server API for SLAMService service. All implementations must embed UnimplementedSLAMServiceServer for forward compatibility
type UnimplementedSLAMServiceServer ¶
type UnimplementedSLAMServiceServer struct { }
UnimplementedSLAMServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedSLAMServiceServer) GetMap ¶
func (UnimplementedSLAMServiceServer) GetMap(context.Context, *GetMapRequest) (*GetMapResponse, error)
func (UnimplementedSLAMServiceServer) GetPosition ¶
func (UnimplementedSLAMServiceServer) GetPosition(context.Context, *GetPositionRequest) (*GetPositionResponse, error)
type UnsafeSLAMServiceServer ¶
type UnsafeSLAMServiceServer interface {
// contains filtered or unexported methods
}
UnsafeSLAMServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SLAMServiceServer will result in compilation errors.