inputcontrollerv1grpc

package
v1.6.0-20251218205402-... Latest Latest
Warning

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

Go to latest
Published: unknown License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	InputControllerService_GetControls_FullMethodName   = "/viam.component.inputcontroller.v1.InputControllerService/GetControls"
	InputControllerService_GetEvents_FullMethodName     = "/viam.component.inputcontroller.v1.InputControllerService/GetEvents"
	InputControllerService_StreamEvents_FullMethodName  = "/viam.component.inputcontroller.v1.InputControllerService/StreamEvents"
	InputControllerService_TriggerEvent_FullMethodName  = "/viam.component.inputcontroller.v1.InputControllerService/TriggerEvent"
	InputControllerService_DoCommand_FullMethodName     = "/viam.component.inputcontroller.v1.InputControllerService/DoCommand"
	InputControllerService_GetGeometries_FullMethodName = "/viam.component.inputcontroller.v1.InputControllerService/GetGeometries"
)

Variables

View Source
var InputControllerService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "viam.component.inputcontroller.v1.InputControllerService",
	HandlerType: (*InputControllerServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetControls",
			Handler:    _InputControllerService_GetControls_Handler,
		},
		{
			MethodName: "GetEvents",
			Handler:    _InputControllerService_GetEvents_Handler,
		},
		{
			MethodName: "TriggerEvent",
			Handler:    _InputControllerService_TriggerEvent_Handler,
		},
		{
			MethodName: "DoCommand",
			Handler:    _InputControllerService_DoCommand_Handler,
		},
		{
			MethodName: "GetGeometries",
			Handler:    _InputControllerService_GetGeometries_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamEvents",
			Handler:       _InputControllerService_StreamEvents_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "component/inputcontroller/v1/input_controller.proto",
}

InputControllerService_ServiceDesc is the grpc.ServiceDesc for InputControllerService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterInputControllerServiceServer

func RegisterInputControllerServiceServer(s grpc.ServiceRegistrar, srv InputControllerServiceServer)

Types

type InputControllerServiceClient

type InputControllerServiceClient interface {
	// GetControls returns a list of GetControls provided by the Controller
	GetControls(ctx context.Context, in *v1.GetControlsRequest, opts ...grpc.CallOption) (*v1.GetControlsResponse, error)
	// GetEvents returns a list of events representing the last event on each control of a give Input Controller
	GetEvents(ctx context.Context, in *v1.GetEventsRequest, opts ...grpc.CallOption) (*v1.GetEventsResponse, error)
	// StreamEvents starts a stream of InputControllerEvents for the given controls (buttons/axes) on a robot's input controller
	StreamEvents(ctx context.Context, in *v1.StreamEventsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[v1.StreamEventsResponse], error)
	// TriggerEvent, where supported, injects an InputControllerEvent into an input controller to (virtually) generate events
	// like button presses or axis movements
	TriggerEvent(ctx context.Context, in *v1.TriggerEventRequest, opts ...grpc.CallOption) (*v1.TriggerEventResponse, error)
	// DoCommand sends/receives arbitrary commands
	DoCommand(ctx context.Context, in *v11.DoCommandRequest, opts ...grpc.CallOption) (*v11.DoCommandResponse, error)
	// GetGeometries returns the geometries of the component in their current configuration
	GetGeometries(ctx context.Context, in *v11.GetGeometriesRequest, opts ...grpc.CallOption) (*v11.GetGeometriesResponse, error)
}

InputControllerServiceClient is the client API for InputControllerService 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.

InputControllerService servicestains all input controller associated with a robot

func NewInputControllerServiceClient

func NewInputControllerServiceClient(cc grpc.ClientConnInterface) InputControllerServiceClient

type InputControllerServiceServer

type InputControllerServiceServer interface {
	// GetControls returns a list of GetControls provided by the Controller
	GetControls(context.Context, *v1.GetControlsRequest) (*v1.GetControlsResponse, error)
	// GetEvents returns a list of events representing the last event on each control of a give Input Controller
	GetEvents(context.Context, *v1.GetEventsRequest) (*v1.GetEventsResponse, error)
	// StreamEvents starts a stream of InputControllerEvents for the given controls (buttons/axes) on a robot's input controller
	StreamEvents(*v1.StreamEventsRequest, grpc.ServerStreamingServer[v1.StreamEventsResponse]) error
	// TriggerEvent, where supported, injects an InputControllerEvent into an input controller to (virtually) generate events
	// like button presses or axis movements
	TriggerEvent(context.Context, *v1.TriggerEventRequest) (*v1.TriggerEventResponse, error)
	// DoCommand sends/receives arbitrary commands
	DoCommand(context.Context, *v11.DoCommandRequest) (*v11.DoCommandResponse, error)
	// GetGeometries returns the geometries of the component in their current configuration
	GetGeometries(context.Context, *v11.GetGeometriesRequest) (*v11.GetGeometriesResponse, error)
}

InputControllerServiceServer is the server API for InputControllerService service. All implementations should embed UnimplementedInputControllerServiceServer for forward compatibility.

InputControllerService servicestains all input controller associated with a robot

type InputControllerService_StreamEventsClient

type InputControllerService_StreamEventsClient = grpc.ServerStreamingClient[v1.StreamEventsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type InputControllerService_StreamEventsServer

type InputControllerService_StreamEventsServer = grpc.ServerStreamingServer[v1.StreamEventsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type UnimplementedInputControllerServiceServer

type UnimplementedInputControllerServiceServer struct{}

UnimplementedInputControllerServiceServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedInputControllerServiceServer) DoCommand

func (UnimplementedInputControllerServiceServer) GetControls

func (UnimplementedInputControllerServiceServer) GetEvents

func (UnimplementedInputControllerServiceServer) GetGeometries

func (UnimplementedInputControllerServiceServer) StreamEvents

func (UnimplementedInputControllerServiceServer) TriggerEvent

type UnsafeInputControllerServiceServer

type UnsafeInputControllerServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeInputControllerServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to InputControllerServiceServer will result in compilation errors.

Source Files

  • input_controller_grpc.pb.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL