bus_api

package
v0.10.1 Latest Latest
Warning

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

 Go to latest Published: Jun 3, 2022 License: Apache-2.0 Imports: 22 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLength        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflow          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var ControllerBusService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "bus.api.ControllerBusService",
	HandlerType: (*ControllerBusServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetBusInfo",
			Handler:    _ControllerBusService_GetBusInfo_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ExecController",
			Handler:       _ControllerBusService_ExecController_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "github.com/aperturerobotics/controllerbus/bus/api/api.proto",
}

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

View Source 
var ErrExecControllerDisabled = errors.New("exec controller is disabled on this api")

ErrExecControllerDisabled is returned if exec controller isn't enabled.

View Source 
var File_github_com_aperturerobotics_controllerbus_bus_api_api_proto protoreflect.FileDescriptor

Functions

func DRPCRegisterControllerBusService added in v0.9.0 

func DRPCRegisterControllerBusService(mux drpc.Mux, impl DRPCControllerBusServiceServer) error

func RegisterControllerBusServiceServer 

func RegisterControllerBusServiceServer(s grpc.ServiceRegistrar, srv ControllerBusServiceServer)

Types

type API 

type API struct {
	// contains filtered or unexported fields
}

API implements the rpc API.

func NewAPI 

func NewAPI(bus bus.Bus, conf *Config) *API

NewAPI constructs a new instance of the API.

func (*API) ExecController 

func (a *API) ExecController(
	req *ce.ExecControllerRequest,
	server DRPCControllerBusService_ExecControllerStream,
) error

ExecController executes a controller configuration on the bus.

func (*API) GetBusInfo 

func (a *API) GetBusInfo(
	ctx context.Context,
	req *GetBusInfoRequest,
) (*GetBusInfoResponse, error)

GetBusInfo requests information about the controller bus.

func (*API) RegisterAsDRPCServer added in v0.9.0 

func (a *API) RegisterAsDRPCServer(mux drpc.Mux) error

RegisterAsDRPCServer registers the API to the DRPC mux.

type Config 

type Config struct {

	// EnableExecController enables the exec controller API.
	EnableExecController bool `protobuf:"varint,1,opt,name=enable_exec_controller,json=enableExecController,proto3" json:"enable_exec_controller,omitempty"`
	// contains filtered or unexported fields
}

Config are configuration arguments.

func (*Config) Descriptor deprecated 

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

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) EqualVT added in v0.10.0 

func (this *Config) EqualVT(that *Config) bool

func (*Config) GetEnableExecController 

func (x *Config) GetEnableExecController() bool

func (*Config) MarshalToSizedBufferVT added in v0.10.0 

func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Config) MarshalToVT added in v0.10.0 

func (m *Config) MarshalToVT(dAtA []byte) (int, error)

func (*Config) MarshalVT added in v0.10.0 

func (m *Config) MarshalVT() (dAtA []byte, err error)

func (*Config) ProtoMessage 

func (*Config) ProtoMessage()

func (*Config) ProtoReflect added in v0.10.1 

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset 

func (x *Config) Reset()

func (*Config) SizeVT added in v0.10.0 

func (m *Config) SizeVT() (n int)

func (*Config) String 

func (x *Config) String() string

func (*Config) UnmarshalVT added in v0.10.0 

func (m *Config) UnmarshalVT(dAtA []byte) error

type ControllerBusServiceClient 

type ControllerBusServiceClient interface {
	// GetBusInfo requests information about the controller bus.
	GetBusInfo(ctx context.Context, in *GetBusInfoRequest, opts ...grpc.CallOption) (*GetBusInfoResponse, error)
	// ExecController executes a controller configuration on the bus.
	ExecController(ctx context.Context, in *exec.ExecControllerRequest, opts ...grpc.CallOption) (ControllerBusService_ExecControllerClient, error)
}

ControllerBusServiceClient is the client API for ControllerBusService 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 NewControllerBusServiceClient 

func NewControllerBusServiceClient(cc grpc.ClientConnInterface) ControllerBusServiceClient

type ControllerBusServiceServer 

type ControllerBusServiceServer interface {
	// GetBusInfo requests information about the controller bus.
	GetBusInfo(context.Context, *GetBusInfoRequest) (*GetBusInfoResponse, error)
	// ExecController executes a controller configuration on the bus.
	ExecController(*exec.ExecControllerRequest, ControllerBusService_ExecControllerServer) error
	// contains filtered or unexported methods
}

ControllerBusServiceServer is the server API for ControllerBusService service. All implementations must embed UnimplementedControllerBusServiceServer for forward compatibility

type ControllerBusService_ExecControllerClient 

type ControllerBusService_ExecControllerClient interface {
	Recv() (*exec.ExecControllerResponse, error)
	grpc.ClientStream
}

type ControllerBusService_ExecControllerServer 

type ControllerBusService_ExecControllerServer interface {
	Send(*exec.ExecControllerResponse) error
	grpc.ServerStream
}

type DRPCControllerBusServiceClient added in v0.9.0 

type DRPCControllerBusServiceClient interface {
	DRPCConn() drpc.Conn

	GetBusInfo(ctx context.Context, in *GetBusInfoRequest) (*GetBusInfoResponse, error)
	ExecController(ctx context.Context, in *exec.ExecControllerRequest) (DRPCControllerBusService_ExecControllerClient, error)
}

func NewDRPCControllerBusServiceClient added in v0.9.0 

func NewDRPCControllerBusServiceClient(cc drpc.Conn) DRPCControllerBusServiceClient

type DRPCControllerBusServiceDescription added in v0.9.0 

type DRPCControllerBusServiceDescription struct{}

func (DRPCControllerBusServiceDescription) Method added in v0.9.0 

func (DRPCControllerBusServiceDescription) Method(n int) (string, drpc.Encoding, drpc.Receiver, interface{}, bool)

func (DRPCControllerBusServiceDescription) NumMethods added in v0.9.0 

func (DRPCControllerBusServiceDescription) NumMethods() int

type DRPCControllerBusServiceServer added in v0.9.0 

type DRPCControllerBusServiceServer interface {
	GetBusInfo(context.Context, *GetBusInfoRequest) (*GetBusInfoResponse, error)
	ExecController(*exec.ExecControllerRequest, DRPCControllerBusService_ExecControllerStream) error
}

type DRPCControllerBusServiceUnimplementedServer added in v0.9.0 

type DRPCControllerBusServiceUnimplementedServer struct{}

func (*DRPCControllerBusServiceUnimplementedServer) ExecController added in v0.9.0 

func (s *DRPCControllerBusServiceUnimplementedServer) ExecController(*exec.ExecControllerRequest, DRPCControllerBusService_ExecControllerStream) error

func (*DRPCControllerBusServiceUnimplementedServer) GetBusInfo added in v0.9.0 

func (s *DRPCControllerBusServiceUnimplementedServer) GetBusInfo(context.Context, *GetBusInfoRequest) (*GetBusInfoResponse, error)

type DRPCControllerBusService_ExecControllerClient added in v0.9.0 

type DRPCControllerBusService_ExecControllerClient interface {
	drpc.Stream
	Recv() (*exec.ExecControllerResponse, error)
}

type DRPCControllerBusService_ExecControllerStream added in v0.9.0 

type DRPCControllerBusService_ExecControllerStream interface {
	drpc.Stream
	Send(*exec.ExecControllerResponse) error
}

type DRPCControllerBusService_GetBusInfoStream added in v0.9.0 

type DRPCControllerBusService_GetBusInfoStream interface {
	drpc.Stream
	SendAndClose(*GetBusInfoResponse) error
}

type GetBusInfoRequest 

type GetBusInfoRequest struct {
	// contains filtered or unexported fields
}

GetBusInfoRequest is the request type for GetBusInfo.

func (*GetBusInfoRequest) Descriptor deprecated 

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

Deprecated: Use GetBusInfoRequest.ProtoReflect.Descriptor instead.

func (*GetBusInfoRequest) EqualVT added in v0.10.0 

func (this *GetBusInfoRequest) EqualVT(that *GetBusInfoRequest) bool

func (*GetBusInfoRequest) MarshalToSizedBufferVT added in v0.10.0 

func (m *GetBusInfoRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*GetBusInfoRequest) MarshalToVT added in v0.10.0 

func (m *GetBusInfoRequest) MarshalToVT(dAtA []byte) (int, error)

func (*GetBusInfoRequest) MarshalVT added in v0.10.0 

func (m *GetBusInfoRequest) MarshalVT() (dAtA []byte, err error)

func (*GetBusInfoRequest) ProtoMessage 

func (*GetBusInfoRequest) ProtoMessage()

func (*GetBusInfoRequest) ProtoReflect added in v0.10.1 

func (x *GetBusInfoRequest) ProtoReflect() protoreflect.Message

func (*GetBusInfoRequest) Reset 

func (x *GetBusInfoRequest) Reset()

func (*GetBusInfoRequest) SizeVT added in v0.10.0 

func (m *GetBusInfoRequest) SizeVT() (n int)

func (*GetBusInfoRequest) String 

func (x *GetBusInfoRequest) String() string

func (*GetBusInfoRequest) UnmarshalVT added in v0.10.0 

func (m *GetBusInfoRequest) UnmarshalVT(dAtA []byte) error

type GetBusInfoResponse 

type GetBusInfoResponse struct {

	// RunningControllers is the list of running controllers.
	RunningControllers []*controller.Info `protobuf:"bytes,1,rep,name=running_controllers,json=runningControllers,proto3" json:"running_controllers,omitempty"`
	// RunningDirectives is the list of running directives.
	RunningDirectives []*directive.DirectiveState `protobuf:"bytes,2,rep,name=running_directives,json=runningDirectives,proto3" json:"running_directives,omitempty"`
	// contains filtered or unexported fields
}

GetBusInfoResponse is the response type for GetBusInfo.

func (*GetBusInfoResponse) Descriptor deprecated 

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

Deprecated: Use GetBusInfoResponse.ProtoReflect.Descriptor instead.

func (*GetBusInfoResponse) EqualVT added in v0.10.0 

func (this *GetBusInfoResponse) EqualVT(that *GetBusInfoResponse) bool

func (*GetBusInfoResponse) GetRunningControllers 

func (x *GetBusInfoResponse) GetRunningControllers() []*controller.Info

func (*GetBusInfoResponse) GetRunningDirectives 

func (x *GetBusInfoResponse) GetRunningDirectives() []*directive.DirectiveState

func (*GetBusInfoResponse) MarshalToSizedBufferVT added in v0.10.0 

func (m *GetBusInfoResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*GetBusInfoResponse) MarshalToVT added in v0.10.0 

func (m *GetBusInfoResponse) MarshalToVT(dAtA []byte) (int, error)

func (*GetBusInfoResponse) MarshalVT added in v0.10.0 

func (m *GetBusInfoResponse) MarshalVT() (dAtA []byte, err error)

func (*GetBusInfoResponse) PrintPrettyStatus 

func (b *GetBusInfoResponse) PrintPrettyStatus() []byte

PrintPrettyStatus prints bus info as a pretty status output.

func (*GetBusInfoResponse) ProtoMessage 

func (*GetBusInfoResponse) ProtoMessage()

func (*GetBusInfoResponse) ProtoReflect added in v0.10.1 

func (x *GetBusInfoResponse) ProtoReflect() protoreflect.Message

func (*GetBusInfoResponse) Reset 

func (x *GetBusInfoResponse) Reset()

func (*GetBusInfoResponse) SizeVT added in v0.10.0 

func (m *GetBusInfoResponse) SizeVT() (n int)

func (*GetBusInfoResponse) String 

func (x *GetBusInfoResponse) String() string

func (*GetBusInfoResponse) UnmarshalVT added in v0.10.0 

func (m *GetBusInfoResponse) UnmarshalVT(dAtA []byte) error

type UnimplementedControllerBusServiceServer 

type UnimplementedControllerBusServiceServer struct {
}

UnimplementedControllerBusServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedControllerBusServiceServer) ExecController 

func (UnimplementedControllerBusServiceServer) ExecController(*exec.ExecControllerRequest, ControllerBusService_ExecControllerServer) error

func (UnimplementedControllerBusServiceServer) GetBusInfo 

func (UnimplementedControllerBusServiceServer) GetBusInfo(context.Context, *GetBusInfoRequest) (*GetBusInfoResponse, error)

type UnsafeControllerBusServiceServer added in v0.10.0 

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

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

Source Files

View all Source files

Directories

Path Synopsis

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.