bus_api

package
v0.22.0 Latest Latest
Warning

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

 Go to latest Published: Jan 11, 2023 License: MIT Imports: 17 Imported by: 3

Documentation

Index

Constants

View Source 
const SRPCControllerBusServiceServiceID = "bus.api.ControllerBusService"

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 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 NewSRPCControllerBusServiceHandler added in v0.16.1 

func NewSRPCControllerBusServiceHandler(impl SRPCControllerBusServiceServer, serviceID string) srpc.Handler

NewSRPCControllerBusServiceHandler constructs a new RPC handler. serviceID: if empty, uses default: bus.api.ControllerBusService

func SRPCRegisterControllerBusService added in v0.11.0 

func SRPCRegisterControllerBusService(mux srpc.Mux, impl SRPCControllerBusServiceServer) error

SRPCRegisterControllerBusService registers the implementation with the mux. Uses the default serviceID: bus.api.ControllerBusService

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 SRPCControllerBusService_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) RegisterAsSRPCServer added in v0.12.0 

func (a *API) RegisterAsSRPCServer(mux srpc.Mux) error

RegisterAsSRPCServer registers the API to the SRPC 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) CloneGenericVT added in v0.12.3 

func (m *Config) CloneGenericVT() proto.Message

func (*Config) CloneVT added in v0.12.3 

func (m *Config) CloneVT() *Config

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 GetBusInfoRequest 

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

GetBusInfoRequest is the request type for GetBusInfo.

func (*GetBusInfoRequest) CloneGenericVT added in v0.12.3 

func (m *GetBusInfoRequest) CloneGenericVT() proto.Message

func (*GetBusInfoRequest) CloneVT added in v0.12.3 

func (m *GetBusInfoRequest) CloneVT() *GetBusInfoRequest

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) CloneGenericVT added in v0.12.3 

func (m *GetBusInfoResponse) CloneGenericVT() proto.Message

func (*GetBusInfoResponse) CloneVT added in v0.12.3 

func (m *GetBusInfoResponse) CloneVT() *GetBusInfoResponse

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 SRPCControllerBusServiceClient added in v0.11.0 

type SRPCControllerBusServiceClient interface {
	SRPCClient() srpc.Client

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

func NewSRPCControllerBusServiceClient added in v0.11.0 

func NewSRPCControllerBusServiceClient(cc srpc.Client) SRPCControllerBusServiceClient

func NewSRPCControllerBusServiceClientWithServiceID added in v0.16.1 

func NewSRPCControllerBusServiceClientWithServiceID(cc srpc.Client, serviceID string) SRPCControllerBusServiceClient

type SRPCControllerBusServiceHandler added in v0.11.0 

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

func (SRPCControllerBusServiceHandler) GetMethodIDs added in v0.11.0 

func (SRPCControllerBusServiceHandler) GetMethodIDs() []string

func (*SRPCControllerBusServiceHandler) GetServiceID added in v0.11.0 

func (d *SRPCControllerBusServiceHandler) GetServiceID() string

func (*SRPCControllerBusServiceHandler) InvokeMethod added in v0.11.0 

func (d *SRPCControllerBusServiceHandler) InvokeMethod(
	serviceID, methodID string,
	strm srpc.Stream,
) (bool, error)

func (SRPCControllerBusServiceHandler) InvokeMethod_ExecController added in v0.11.0 

func (SRPCControllerBusServiceHandler) InvokeMethod_ExecController(impl SRPCControllerBusServiceServer, strm srpc.Stream) error

func (SRPCControllerBusServiceHandler) InvokeMethod_GetBusInfo added in v0.11.0 

func (SRPCControllerBusServiceHandler) InvokeMethod_GetBusInfo(impl SRPCControllerBusServiceServer, strm srpc.Stream) error

type SRPCControllerBusServiceServer added in v0.11.0 

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

type SRPCControllerBusServiceUnimplementedServer added in v0.11.0 

type SRPCControllerBusServiceUnimplementedServer struct{}

func (*SRPCControllerBusServiceUnimplementedServer) ExecController added in v0.11.0 

func (s *SRPCControllerBusServiceUnimplementedServer) ExecController(*exec.ExecControllerRequest, SRPCControllerBusService_ExecControllerStream) error

func (*SRPCControllerBusServiceUnimplementedServer) GetBusInfo added in v0.11.0 

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

type SRPCControllerBusService_ExecControllerClient added in v0.11.0 

type SRPCControllerBusService_ExecControllerClient interface {
	srpc.Stream
	Recv() (*exec.ExecControllerResponse, error)
	RecvTo(*exec.ExecControllerResponse) error
}

type SRPCControllerBusService_ExecControllerStream added in v0.11.0 

type SRPCControllerBusService_ExecControllerStream interface {
	srpc.Stream
	Send(*exec.ExecControllerResponse) error
}

type SRPCControllerBusService_GetBusInfoStream added in v0.11.0 

type SRPCControllerBusService_GetBusInfoStream interface {
	srpc.Stream
	SendAndClose(*GetBusInfoResponse) error
}

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.