bus_api

package
v0.8.2 Latest Latest
Warning

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

 Go to latest Published: Jun 4, 2021 License: Apache-2.0 Imports: 14 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

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

ErrExecControllerDisabled is returned if exec controller isn't enabled.

Functions

func RegisterControllerBusServiceServer 

func RegisterControllerBusServiceServer(s *grpc.Server, srv ControllerBusServiceServer)

Types

type API 

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

API implements the GRPC API.

func NewAPI 

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

NewAPI constructs a new instance of the API.

func (*API) ExecController 

func (a *API) ExecController(
	req *ce.ExecControllerRequest,
	server ControllerBusService_ExecControllerServer,
) 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) RegisterAsGRPCServer 

func (a *API) RegisterAsGRPCServer(grpcServer *grpc.Server)

RegisterAsGRPCServer registers the API to the GRPC instance.

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Config are configuration arguments.

func (*Config) Descriptor 

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

func (*Config) GetEnableExecController 

func (m *Config) GetEnableExecController() bool

func (*Config) ProtoMessage 

func (*Config) ProtoMessage()

func (*Config) Reset 

func (m *Config) Reset()

func (*Config) String 

func (m *Config) String() string

func (*Config) XXX_DiscardUnknown 

func (m *Config) XXX_DiscardUnknown()

func (*Config) XXX_Marshal 

func (m *Config) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Config) XXX_Merge 

func (m *Config) XXX_Merge(src proto.Message)

func (*Config) XXX_Size 

func (m *Config) XXX_Size() int

func (*Config) XXX_Unmarshal 

func (m *Config) XXX_Unmarshal(b []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://godoc.org/google.golang.org/grpc#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
}

ControllerBusServiceServer is the server API for ControllerBusService service.

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 GetBusInfoRequest 

type GetBusInfoRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

GetBusInfoRequest is the request type for GetBusInfo.

func (*GetBusInfoRequest) Descriptor 

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

func (*GetBusInfoRequest) ProtoMessage 

func (*GetBusInfoRequest) ProtoMessage()

func (*GetBusInfoRequest) Reset 

func (m *GetBusInfoRequest) Reset()

func (*GetBusInfoRequest) String 

func (m *GetBusInfoRequest) String() string

func (*GetBusInfoRequest) XXX_DiscardUnknown 

func (m *GetBusInfoRequest) XXX_DiscardUnknown()

func (*GetBusInfoRequest) XXX_Marshal 

func (m *GetBusInfoRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetBusInfoRequest) XXX_Merge 

func (m *GetBusInfoRequest) XXX_Merge(src proto.Message)

func (*GetBusInfoRequest) XXX_Size 

func (m *GetBusInfoRequest) XXX_Size() int

func (*GetBusInfoRequest) XXX_Unmarshal 

func (m *GetBusInfoRequest) XXX_Unmarshal(b []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"`
	XXX_NoUnkeyedLiteral struct{}                    `json:"-"`
	XXX_unrecognized     []byte                      `json:"-"`
	XXX_sizecache        int32                       `json:"-"`
}

GetBusInfoResponse is the response type for GetBusInfo.

func (*GetBusInfoResponse) Descriptor 

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

func (*GetBusInfoResponse) GetRunningControllers 

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

func (*GetBusInfoResponse) GetRunningDirectives 

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

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) Reset 

func (m *GetBusInfoResponse) Reset()

func (*GetBusInfoResponse) String 

func (m *GetBusInfoResponse) String() string

func (*GetBusInfoResponse) XXX_DiscardUnknown 

func (m *GetBusInfoResponse) XXX_DiscardUnknown()

func (*GetBusInfoResponse) XXX_Marshal 

func (m *GetBusInfoResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetBusInfoResponse) XXX_Merge 

func (m *GetBusInfoResponse) XXX_Merge(src proto.Message)

func (*GetBusInfoResponse) XXX_Size 

func (m *GetBusInfoResponse) XXX_Size() int

func (*GetBusInfoResponse) XXX_Unmarshal 

func (m *GetBusInfoResponse) XXX_Unmarshal(b []byte) error

type UnimplementedControllerBusServiceServer 

type UnimplementedControllerBusServiceServer struct {
}

UnimplementedControllerBusServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedControllerBusServiceServer) ExecController 

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

func (*UnimplementedControllerBusServiceServer) GetBusInfo 

func (*UnimplementedControllerBusServiceServer) GetBusInfo(ctx context.Context, req *GetBusInfoRequest) (*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.