common

package
v0.12.1 Latest Latest
Warning

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

Go to latest
Published: Nov 9, 2023 License: MIT Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_provider_plugin_common_plugin_proto protoreflect.FileDescriptor
View Source
var Handshake = plugin.HandshakeConfig{
	ProtocolVersion:  2,
	MagicCookieKey:   "HERD",
	MagicCookieValue: "plugin",
}
View Source
var Logger_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "common.Logger",
	HandlerType: (*LoggerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "LoadingMessage",
			Handler:    _Logger_LoadingMessage_Handler,
		},
		{
			MethodName: "EmitLogMessage",
			Handler:    _Logger_EmitLogMessage_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "provider/plugin/common/plugin.proto",
}

Logger_ServiceDesc is the grpc.ServiceDesc for Logger 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 ProviderPlugin_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "common.ProviderPlugin",
	HandlerType: (*ProviderPluginServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SetLogger",
			Handler:    _ProviderPlugin_SetLogger_Handler,
		},
		{
			MethodName: "Configure",
			Handler:    _ProviderPlugin_Configure_Handler,
		},
		{
			MethodName: "SetDataDir",
			Handler:    _ProviderPlugin_SetDataDir_Handler,
		},
		{
			MethodName: "SetCacheDir",
			Handler:    _ProviderPlugin_SetCacheDir_Handler,
		},
		{
			MethodName: "Invalidate",
			Handler:    _ProviderPlugin_Invalidate_Handler,
		},
		{
			MethodName: "Keep",
			Handler:    _ProviderPlugin_Keep_Handler,
		},
		{
			MethodName: "Load",
			Handler:    _ProviderPlugin_Load_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "provider/plugin/common/plugin.proto",
}

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

Functions

func NewLogrusLogger

func NewLogrusLogger(l *logrus.Logger, name string) *logrusLogger

func RegisterLoggerServer

func RegisterLoggerServer(s grpc.ServiceRegistrar, srv LoggerServer)

func RegisterProviderPluginServer added in v0.11.0

func RegisterProviderPluginServer(s grpc.ServiceRegistrar, srv ProviderPluginServer)

Types

type ConfigureRequest

type ConfigureRequest struct {
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigureRequest) Descriptor deprecated

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

Deprecated: Use ConfigureRequest.ProtoReflect.Descriptor instead.

func (*ConfigureRequest) GetData

func (x *ConfigureRequest) GetData() []byte

func (*ConfigureRequest) ProtoMessage

func (*ConfigureRequest) ProtoMessage()

func (*ConfigureRequest) ProtoReflect

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

func (*ConfigureRequest) Reset

func (x *ConfigureRequest) Reset()

func (*ConfigureRequest) String

func (x *ConfigureRequest) String() string

type ConfigureResponse

type ConfigureResponse struct {
	Err string `protobuf:"bytes,1,opt,name=err,proto3" json:"err,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigureResponse) Descriptor deprecated

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

Deprecated: Use ConfigureResponse.ProtoReflect.Descriptor instead.

func (*ConfigureResponse) GetErr

func (x *ConfigureResponse) GetErr() string

func (*ConfigureResponse) ProtoMessage

func (*ConfigureResponse) ProtoMessage()

func (*ConfigureResponse) ProtoReflect

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

func (*ConfigureResponse) Reset

func (x *ConfigureResponse) Reset()

func (*ConfigureResponse) String

func (x *ConfigureResponse) String() string

type EmitLogMessageRequest

type EmitLogMessageRequest struct {
	Level   uint32 `protobuf:"varint,1,opt,name=level,proto3" json:"level,omitempty"`
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*EmitLogMessageRequest) Descriptor deprecated

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

Deprecated: Use EmitLogMessageRequest.ProtoReflect.Descriptor instead.

func (*EmitLogMessageRequest) GetLevel

func (x *EmitLogMessageRequest) GetLevel() uint32

func (*EmitLogMessageRequest) GetMessage

func (x *EmitLogMessageRequest) GetMessage() string

func (*EmitLogMessageRequest) ProtoMessage

func (*EmitLogMessageRequest) ProtoMessage()

func (*EmitLogMessageRequest) ProtoReflect

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

func (*EmitLogMessageRequest) Reset

func (x *EmitLogMessageRequest) Reset()

func (*EmitLogMessageRequest) String

func (x *EmitLogMessageRequest) String() string

type Empty

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

func (*Empty) Descriptor deprecated

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

Deprecated: Use Empty.ProtoReflect.Descriptor instead.

func (*Empty) ProtoMessage

func (*Empty) ProtoMessage()

func (*Empty) ProtoReflect

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

func (*Empty) Reset

func (x *Empty) Reset()

func (*Empty) String

func (x *Empty) String() string

type GRPCClient

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

func (*GRPCClient) Configure

func (c *GRPCClient) Configure(settings map[string]interface{}) error

func (*GRPCClient) Invalidate added in v0.11.0

func (c *GRPCClient) Invalidate()

func (*GRPCClient) Keep added in v0.11.0

func (c *GRPCClient) Keep()

func (*GRPCClient) Load

func (c *GRPCClient) Load(ctx context.Context) (*herd.HostSet, error)

func (*GRPCClient) SetCacheDir added in v0.11.0

func (c *GRPCClient) SetCacheDir(dir string)

func (*GRPCClient) SetDataDir added in v0.11.0

func (c *GRPCClient) SetDataDir(dir string) error

func (*GRPCClient) SetLogger added in v0.11.0

func (c *GRPCClient) SetLogger(logger Logger) error

type GRPCLoggerClient

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

func (*GRPCLoggerClient) EmitLogMessage

func (c *GRPCLoggerClient) EmitLogMessage(level logrus.Level, message string)

func (*GRPCLoggerClient) Fire added in v0.11.0

func (c *GRPCLoggerClient) Fire(entry *logrus.Entry) error

func (*GRPCLoggerClient) Levels added in v0.11.0

func (c *GRPCLoggerClient) Levels() []logrus.Level

func (*GRPCLoggerClient) LoadingMessage

func (c *GRPCLoggerClient) LoadingMessage(name string, done bool, err error)

type GRPCLoggerServer

type GRPCLoggerServer struct {
	UnimplementedLoggerServer
	Impl Logger
}

func (*GRPCLoggerServer) EmitLogMessage

func (s *GRPCLoggerServer) EmitLogMessage(ctx context.Context, req *EmitLogMessageRequest) (*Empty, error)

func (*GRPCLoggerServer) LoadingMessage

func (s *GRPCLoggerServer) LoadingMessage(ctx context.Context, req *LoadingMessageRequest) (*Empty, error)

type GRPCServer

type GRPCServer struct {
	UnimplementedProviderPluginServer
	Impl ProviderPluginImpl
	// contains filtered or unexported fields
}

func (*GRPCServer) Configure

func (s *GRPCServer) Configure(ctx context.Context, req *ConfigureRequest) (*ConfigureResponse, error)

func (*GRPCServer) Invalidate added in v0.11.0

func (s *GRPCServer) Invalidate(ctx context.Context, req *Empty) (*Empty, error)

func (*GRPCServer) Keep added in v0.11.0

func (s *GRPCServer) Keep(ctx context.Context, req *Empty) (*Empty, error)

func (*GRPCServer) Load

func (s *GRPCServer) Load(ctx context.Context, req *LoadRequest) (*LoadResponse, error)

func (*GRPCServer) SetCacheDir added in v0.11.0

func (s *GRPCServer) SetCacheDir(ctx context.Context, req *SetCacheDirRequest) (*Empty, error)

func (*GRPCServer) SetDataDir added in v0.11.0

func (s *GRPCServer) SetDataDir(ctx context.Context, req *SetDataDirRequest) (*SetDataDirResponse, error)

func (*GRPCServer) SetLogger added in v0.11.0

func (s *GRPCServer) SetLogger(ctx context.Context, req *SetLoggerRequest) (*SetLoggerResponse, error)

type LoadRequest

type LoadRequest struct {
	Deadline *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=deadline,proto3" json:"deadline,omitempty"`
	// contains filtered or unexported fields
}

func (*LoadRequest) Descriptor deprecated

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

Deprecated: Use LoadRequest.ProtoReflect.Descriptor instead.

func (*LoadRequest) GetDeadline

func (x *LoadRequest) GetDeadline() *timestamppb.Timestamp

func (*LoadRequest) ProtoMessage

func (*LoadRequest) ProtoMessage()

func (*LoadRequest) ProtoReflect

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

func (*LoadRequest) Reset

func (x *LoadRequest) Reset()

func (*LoadRequest) String

func (x *LoadRequest) String() string

type LoadResponse

type LoadResponse struct {
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	Err  string `protobuf:"bytes,2,opt,name=err,proto3" json:"err,omitempty"`
	// contains filtered or unexported fields
}

func (*LoadResponse) Descriptor deprecated

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

Deprecated: Use LoadResponse.ProtoReflect.Descriptor instead.

func (*LoadResponse) GetData

func (x *LoadResponse) GetData() []byte

func (*LoadResponse) GetErr

func (x *LoadResponse) GetErr() string

func (*LoadResponse) ProtoMessage

func (*LoadResponse) ProtoMessage()

func (*LoadResponse) ProtoReflect

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

func (*LoadResponse) Reset

func (x *LoadResponse) Reset()

func (*LoadResponse) String

func (x *LoadResponse) String() string

type LoadingMessageRequest

type LoadingMessageRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Done bool   `protobuf:"varint,2,opt,name=done,proto3" json:"done,omitempty"`
	Err  string `protobuf:"bytes,3,opt,name=err,proto3" json:"err,omitempty"`
	// contains filtered or unexported fields
}

func (*LoadingMessageRequest) Descriptor deprecated

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

Deprecated: Use LoadingMessageRequest.ProtoReflect.Descriptor instead.

func (*LoadingMessageRequest) GetDone

func (x *LoadingMessageRequest) GetDone() bool

func (*LoadingMessageRequest) GetErr

func (x *LoadingMessageRequest) GetErr() string

func (*LoadingMessageRequest) GetName

func (x *LoadingMessageRequest) GetName() string

func (*LoadingMessageRequest) ProtoMessage

func (*LoadingMessageRequest) ProtoMessage()

func (*LoadingMessageRequest) ProtoReflect

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

func (*LoadingMessageRequest) Reset

func (x *LoadingMessageRequest) Reset()

func (*LoadingMessageRequest) String

func (x *LoadingMessageRequest) String() string

type Logger

type Logger interface {
	LoadingMessage(name string, done bool, err error)
	EmitLogMessage(level logrus.Level, message string)
}

type LoggerClient

type LoggerClient interface {
	LoadingMessage(ctx context.Context, in *LoadingMessageRequest, opts ...grpc.CallOption) (*Empty, error)
	EmitLogMessage(ctx context.Context, in *EmitLogMessageRequest, opts ...grpc.CallOption) (*Empty, error)
}

LoggerClient is the client API for Logger 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 NewLoggerClient

func NewLoggerClient(cc grpc.ClientConnInterface) LoggerClient

type LoggerServer

type LoggerServer interface {
	LoadingMessage(context.Context, *LoadingMessageRequest) (*Empty, error)
	EmitLogMessage(context.Context, *EmitLogMessageRequest) (*Empty, error)
	// contains filtered or unexported methods
}

LoggerServer is the server API for Logger service. All implementations must embed UnimplementedLoggerServer for forward compatibility

type ProviderPlugin

type ProviderPlugin struct {
	plugin.NetRPCUnsupportedPlugin
	Impl ProviderPluginImpl
}

func (*ProviderPlugin) GRPCClient

func (p *ProviderPlugin) GRPCClient(ctx context.Context, b *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

func (*ProviderPlugin) GRPCServer

func (p *ProviderPlugin) GRPCServer(b *plugin.GRPCBroker, s *grpc.Server) error

type ProviderPluginClient added in v0.11.0

type ProviderPluginClient interface {
	SetLogger(ctx context.Context, in *SetLoggerRequest, opts ...grpc.CallOption) (*SetLoggerResponse, error)
	Configure(ctx context.Context, in *ConfigureRequest, opts ...grpc.CallOption) (*ConfigureResponse, error)
	SetDataDir(ctx context.Context, in *SetDataDirRequest, opts ...grpc.CallOption) (*SetDataDirResponse, error)
	SetCacheDir(ctx context.Context, in *SetCacheDirRequest, opts ...grpc.CallOption) (*Empty, error)
	Invalidate(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*Empty, error)
	Keep(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*Empty, error)
	Load(ctx context.Context, in *LoadRequest, opts ...grpc.CallOption) (*LoadResponse, error)
}

ProviderPluginClient is the client API for ProviderPlugin 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 NewProviderPluginClient added in v0.11.0

func NewProviderPluginClient(cc grpc.ClientConnInterface) ProviderPluginClient

type ProviderPluginImpl added in v0.11.0

type ProviderPluginImpl interface {
	SetLogger(Logger) error
	Configure(map[string]interface{}) error
	Load(ctx context.Context) (*herd.HostSet, error)
	SetDataDir(string) error
	SetCacheDir(string)
	Invalidate()
	Keep()
}

type ProviderPluginServer added in v0.11.0

type ProviderPluginServer interface {
	SetLogger(context.Context, *SetLoggerRequest) (*SetLoggerResponse, error)
	Configure(context.Context, *ConfigureRequest) (*ConfigureResponse, error)
	SetDataDir(context.Context, *SetDataDirRequest) (*SetDataDirResponse, error)
	SetCacheDir(context.Context, *SetCacheDirRequest) (*Empty, error)
	Invalidate(context.Context, *Empty) (*Empty, error)
	Keep(context.Context, *Empty) (*Empty, error)
	Load(context.Context, *LoadRequest) (*LoadResponse, error)
	// contains filtered or unexported methods
}

ProviderPluginServer is the server API for ProviderPlugin service. All implementations must embed UnimplementedProviderPluginServer for forward compatibility

type SetCacheDirRequest added in v0.11.0

type SetCacheDirRequest struct {
	Dir string `protobuf:"bytes,1,opt,name=dir,proto3" json:"dir,omitempty"`
	// contains filtered or unexported fields
}

func (*SetCacheDirRequest) Descriptor deprecated added in v0.11.0

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

Deprecated: Use SetCacheDirRequest.ProtoReflect.Descriptor instead.

func (*SetCacheDirRequest) GetDir added in v0.11.0

func (x *SetCacheDirRequest) GetDir() string

func (*SetCacheDirRequest) ProtoMessage added in v0.11.0

func (*SetCacheDirRequest) ProtoMessage()

func (*SetCacheDirRequest) ProtoReflect added in v0.11.0

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

func (*SetCacheDirRequest) Reset added in v0.11.0

func (x *SetCacheDirRequest) Reset()

func (*SetCacheDirRequest) String added in v0.11.0

func (x *SetCacheDirRequest) String() string

type SetDataDirRequest added in v0.11.0

type SetDataDirRequest struct {
	Dir string `protobuf:"bytes,1,opt,name=dir,proto3" json:"dir,omitempty"`
	// contains filtered or unexported fields
}

func (*SetDataDirRequest) Descriptor deprecated added in v0.11.0

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

Deprecated: Use SetDataDirRequest.ProtoReflect.Descriptor instead.

func (*SetDataDirRequest) GetDir added in v0.11.0

func (x *SetDataDirRequest) GetDir() string

func (*SetDataDirRequest) ProtoMessage added in v0.11.0

func (*SetDataDirRequest) ProtoMessage()

func (*SetDataDirRequest) ProtoReflect added in v0.11.0

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

func (*SetDataDirRequest) Reset added in v0.11.0

func (x *SetDataDirRequest) Reset()

func (*SetDataDirRequest) String added in v0.11.0

func (x *SetDataDirRequest) String() string

type SetDataDirResponse added in v0.11.0

type SetDataDirResponse struct {
	Err string `protobuf:"bytes,1,opt,name=err,proto3" json:"err,omitempty"`
	// contains filtered or unexported fields
}

func (*SetDataDirResponse) Descriptor deprecated added in v0.11.0

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

Deprecated: Use SetDataDirResponse.ProtoReflect.Descriptor instead.

func (*SetDataDirResponse) GetErr added in v0.11.0

func (x *SetDataDirResponse) GetErr() string

func (*SetDataDirResponse) ProtoMessage added in v0.11.0

func (*SetDataDirResponse) ProtoMessage()

func (*SetDataDirResponse) ProtoReflect added in v0.11.0

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

func (*SetDataDirResponse) Reset added in v0.11.0

func (x *SetDataDirResponse) Reset()

func (*SetDataDirResponse) String added in v0.11.0

func (x *SetDataDirResponse) String() string

type SetLoggerRequest added in v0.11.0

type SetLoggerRequest struct {
	Logger uint32 `protobuf:"varint,1,opt,name=logger,proto3" json:"logger,omitempty"`
	// contains filtered or unexported fields
}

func (*SetLoggerRequest) Descriptor deprecated added in v0.11.0

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

Deprecated: Use SetLoggerRequest.ProtoReflect.Descriptor instead.

func (*SetLoggerRequest) GetLogger added in v0.11.0

func (x *SetLoggerRequest) GetLogger() uint32

func (*SetLoggerRequest) ProtoMessage added in v0.11.0

func (*SetLoggerRequest) ProtoMessage()

func (*SetLoggerRequest) ProtoReflect added in v0.11.0

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

func (*SetLoggerRequest) Reset added in v0.11.0

func (x *SetLoggerRequest) Reset()

func (*SetLoggerRequest) String added in v0.11.0

func (x *SetLoggerRequest) String() string

type SetLoggerResponse added in v0.11.0

type SetLoggerResponse struct {
	Err string `protobuf:"bytes,1,opt,name=err,proto3" json:"err,omitempty"`
	// contains filtered or unexported fields
}

func (*SetLoggerResponse) Descriptor deprecated added in v0.11.0

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

Deprecated: Use SetLoggerResponse.ProtoReflect.Descriptor instead.

func (*SetLoggerResponse) GetErr added in v0.11.0

func (x *SetLoggerResponse) GetErr() string

func (*SetLoggerResponse) ProtoMessage added in v0.11.0

func (*SetLoggerResponse) ProtoMessage()

func (*SetLoggerResponse) ProtoReflect added in v0.11.0

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

func (*SetLoggerResponse) Reset added in v0.11.0

func (x *SetLoggerResponse) Reset()

func (*SetLoggerResponse) String added in v0.11.0

func (x *SetLoggerResponse) String() string

type UnimplementedLoggerServer

type UnimplementedLoggerServer struct {
}

UnimplementedLoggerServer must be embedded to have forward compatible implementations.

func (UnimplementedLoggerServer) EmitLogMessage

func (UnimplementedLoggerServer) LoadingMessage

type UnimplementedProviderPluginServer added in v0.11.0

type UnimplementedProviderPluginServer struct {
}

UnimplementedProviderPluginServer must be embedded to have forward compatible implementations.

func (UnimplementedProviderPluginServer) Configure added in v0.11.0

func (UnimplementedProviderPluginServer) Invalidate added in v0.11.0

func (UnimplementedProviderPluginServer) Keep added in v0.11.0

func (UnimplementedProviderPluginServer) Load added in v0.11.0

func (UnimplementedProviderPluginServer) SetCacheDir added in v0.11.0

func (UnimplementedProviderPluginServer) SetDataDir added in v0.11.0

func (UnimplementedProviderPluginServer) SetLogger added in v0.11.0

type UnsafeLoggerServer

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

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

type UnsafeProviderPluginServer added in v0.11.0

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

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

Jump to

Keyboard shortcuts

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