gaffer

package
v2.0.2 Latest Latest
Warning

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

 Go to latest Published: Apr 26, 2020 License: BSD-2-Clause Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	KernelProcess_State_name = map[int32]string{
		0: "NONE",
		1: "NEW",
		2: "RUNNING",
		3: "STOPPING",
		4: "STOPPED",
	}
	KernelProcess_State_value = map[string]int32{
		"NONE":     0,
		"NEW":      1,
		"RUNNING":  2,
		"STOPPING": 3,
		"STOPPED":  4,
	}
)

Enum value maps for KernelProcess_State.

View Source 
var (
	KernelProcessEvent_State_name = map[int32]string{
		0: "NONE",
		1: "NEW",
		2: "RUNNING",
		3: "STOPPING",
		4: "STOPPED",
		5: "STDOUT",
		6: "STDERR",
	}
	KernelProcessEvent_State_value = map[string]int32{
		"NONE":     0,
		"NEW":      1,
		"RUNNING":  2,
		"STOPPING": 3,
		"STOPPED":  4,
		"STDOUT":   5,
		"STDERR":   6,
	}
)

Enum value maps for KernelProcessEvent_State.

View Source 
var File_gaffer_gaffer_proto protoreflect.FileDescriptor
View Source 
var File_gaffer_kernel_proto protoreflect.FileDescriptor
View Source 
var File_gaffer_service_proto protoreflect.FileDescriptor

Functions

func RegisterGafferServer 

func RegisterGafferServer(s *grpc.Server, srv GafferServer)

func RegisterKernelServer 

func RegisterKernelServer(s *grpc.Server, srv KernelServer)

Types

type GafferClient 

type GafferClient interface {
	// Simple ping method to show server is "up"
	Ping(ctx context.Context, in *empty.Empty, opts ...grpc.CallOption) (*empty.Empty, error)
	// Return services
	Services(ctx context.Context, in *empty.Empty, opts ...grpc.CallOption) (*ServiceList, error)
	// Update a service
	Update(ctx context.Context, in *ServiceUpdateRequest, opts ...grpc.CallOption) (*ServiceList, error)
	// Start a service
	Start(ctx context.Context, in *ServiceId, opts ...grpc.CallOption) (*ServiceList, error)
}

GafferClient is the client API for Gaffer service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewGafferClient 

func NewGafferClient(cc grpc.ClientConnInterface) GafferClient

type GafferServer 

type GafferServer interface {
	// Simple ping method to show server is "up"
	Ping(context.Context, *empty.Empty) (*empty.Empty, error)
	// Return services
	Services(context.Context, *empty.Empty) (*ServiceList, error)
	// Update a service
	Update(context.Context, *ServiceUpdateRequest) (*ServiceList, error)
	// Start a service
	Start(context.Context, *ServiceId) (*ServiceList, error)
}

GafferServer is the server API for Gaffer service.

type KernelClient 

type KernelClient interface {
	// Simple ping method to show server is "up"
	Ping(ctx context.Context, in *empty.Empty, opts ...grpc.CallOption) (*empty.Empty, error)
	// Create a new process
	CreateProcess(ctx context.Context, in *Service, opts ...grpc.CallOption) (*ProcessId, error)
	// Run a process
	RunProcess(ctx context.Context, in *ProcessId, opts ...grpc.CallOption) (*empty.Empty, error)
	// Stop a process
	StopProcess(ctx context.Context, in *ProcessId, opts ...grpc.CallOption) (*empty.Empty, error)
	// Return filtered list of processes
	Processes(ctx context.Context, in *ProcessId, opts ...grpc.CallOption) (*KernelProcessList, error)
	// Return list of service executables
	Executables(ctx context.Context, in *empty.Empty, opts ...grpc.CallOption) (*KernelExecutableList, error)
	// Stream filtered list of events
	StreamEvents(ctx context.Context, in *ProcessId, opts ...grpc.CallOption) (Kernel_StreamEventsClient, error)
}

KernelClient is the client API for Kernel service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewKernelClient 

func NewKernelClient(cc grpc.ClientConnInterface) KernelClient

type KernelExecutableList 

type KernelExecutableList struct {
	Executable []string `protobuf:"bytes,1,rep,name=executable,proto3" json:"executable,omitempty"`
	// contains filtered or unexported fields
}

Return a list of executables

func (*KernelExecutableList) Descriptor deprecated 

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

Deprecated: Use KernelExecutableList.ProtoReflect.Descriptor instead.

func (*KernelExecutableList) GetExecutable 

func (x *KernelExecutableList) GetExecutable() []string

func (*KernelExecutableList) ProtoMessage 

func (*KernelExecutableList) ProtoMessage()

func (*KernelExecutableList) ProtoReflect 

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

func (*KernelExecutableList) Reset 

func (x *KernelExecutableList) Reset()

func (*KernelExecutableList) String 

func (x *KernelExecutableList) String() string

type KernelProcess 

type KernelProcess struct {
	Id      *ProcessId          `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	State   KernelProcess_State `protobuf:"varint,2,opt,name=state,proto3,enum=gaffer.KernelProcess_State" json:"state,omitempty"`
	Service *Service            `protobuf:"bytes,3,opt,name=service,proto3" json:"service,omitempty"`
	// contains filtered or unexported fields
}

Return information about a process

func (*KernelProcess) Descriptor deprecated 

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

Deprecated: Use KernelProcess.ProtoReflect.Descriptor instead.

func (*KernelProcess) GetId 

func (x *KernelProcess) GetId() *ProcessId

func (*KernelProcess) GetService 

func (x *KernelProcess) GetService() *Service

func (*KernelProcess) GetState 

func (x *KernelProcess) GetState() KernelProcess_State

func (*KernelProcess) ProtoMessage 

func (*KernelProcess) ProtoMessage()

func (*KernelProcess) ProtoReflect 

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

func (*KernelProcess) Reset 

func (x *KernelProcess) Reset()

func (*KernelProcess) String 

func (x *KernelProcess) String() string

type KernelProcessEvent 

type KernelProcessEvent struct {
	State   KernelProcessEvent_State `protobuf:"varint,1,opt,name=state,proto3,enum=gaffer.KernelProcessEvent_State" json:"state,omitempty"`
	Process *KernelProcess           `protobuf:"bytes,2,opt,name=process,proto3" json:"process,omitempty"`
	Buf     []byte                   `protobuf:"bytes,3,opt,name=buf,proto3" json:"buf,omitempty"`
	Error   string                   `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

Monitor discovery changes

func (*KernelProcessEvent) Descriptor deprecated 

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

Deprecated: Use KernelProcessEvent.ProtoReflect.Descriptor instead.

func (*KernelProcessEvent) GetBuf 

func (x *KernelProcessEvent) GetBuf() []byte

func (*KernelProcessEvent) GetError 

func (x *KernelProcessEvent) GetError() string

func (*KernelProcessEvent) GetProcess 

func (x *KernelProcessEvent) GetProcess() *KernelProcess

func (*KernelProcessEvent) GetState 

func (x *KernelProcessEvent) GetState() KernelProcessEvent_State

func (*KernelProcessEvent) ProtoMessage 

func (*KernelProcessEvent) ProtoMessage()

func (*KernelProcessEvent) ProtoReflect 

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

func (*KernelProcessEvent) Reset 

func (x *KernelProcessEvent) Reset()

func (*KernelProcessEvent) String 

func (x *KernelProcessEvent) String() string

type KernelProcessEvent_State 

type KernelProcessEvent_State int32
const (
	KernelProcessEvent_NONE     KernelProcessEvent_State = 0
	KernelProcessEvent_NEW      KernelProcessEvent_State = 1
	KernelProcessEvent_RUNNING  KernelProcessEvent_State = 2
	KernelProcessEvent_STOPPING KernelProcessEvent_State = 3
	KernelProcessEvent_STOPPED  KernelProcessEvent_State = 4
	KernelProcessEvent_STDOUT   KernelProcessEvent_State = 5
	KernelProcessEvent_STDERR   KernelProcessEvent_State = 6
)

func (KernelProcessEvent_State) Descriptor 

func (KernelProcessEvent_State) Descriptor() protoreflect.EnumDescriptor

func (KernelProcessEvent_State) Enum 

func (x KernelProcessEvent_State) Enum() *KernelProcessEvent_State

func (KernelProcessEvent_State) EnumDescriptor deprecated 

func (KernelProcessEvent_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use KernelProcessEvent_State.Descriptor instead.

func (KernelProcessEvent_State) Number 

func (x KernelProcessEvent_State) Number() protoreflect.EnumNumber

func (KernelProcessEvent_State) String 

func (x KernelProcessEvent_State) String() string

func (KernelProcessEvent_State) Type 

func (KernelProcessEvent_State) Type() protoreflect.EnumType

type KernelProcessList 

type KernelProcessList struct {
	Process []*KernelProcess `protobuf:"bytes,1,rep,name=process,proto3" json:"process,omitempty"`
	// contains filtered or unexported fields
}

Return a list of processes

func (*KernelProcessList) Descriptor deprecated 

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

Deprecated: Use KernelProcessList.ProtoReflect.Descriptor instead.

func (*KernelProcessList) GetProcess 

func (x *KernelProcessList) GetProcess() []*KernelProcess

func (*KernelProcessList) ProtoMessage 

func (*KernelProcessList) ProtoMessage()

func (*KernelProcessList) ProtoReflect 

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

func (*KernelProcessList) Reset 

func (x *KernelProcessList) Reset()

func (*KernelProcessList) String 

func (x *KernelProcessList) String() string

type KernelProcess_State 

type KernelProcess_State int32
const (
	KernelProcess_NONE     KernelProcess_State = 0
	KernelProcess_NEW      KernelProcess_State = 1
	KernelProcess_RUNNING  KernelProcess_State = 2
	KernelProcess_STOPPING KernelProcess_State = 3
	KernelProcess_STOPPED  KernelProcess_State = 4
)

func (KernelProcess_State) Descriptor 

func (KernelProcess_State) Descriptor() protoreflect.EnumDescriptor

func (KernelProcess_State) Enum 

func (x KernelProcess_State) Enum() *KernelProcess_State

func (KernelProcess_State) EnumDescriptor deprecated 

func (KernelProcess_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use KernelProcess_State.Descriptor instead.

func (KernelProcess_State) Number 

func (x KernelProcess_State) Number() protoreflect.EnumNumber

func (KernelProcess_State) String 

func (x KernelProcess_State) String() string

func (KernelProcess_State) Type 

func (KernelProcess_State) Type() protoreflect.EnumType

type KernelServer 

type KernelServer interface {
	// Simple ping method to show server is "up"
	Ping(context.Context, *empty.Empty) (*empty.Empty, error)
	// Create a new process
	CreateProcess(context.Context, *Service) (*ProcessId, error)
	// Run a process
	RunProcess(context.Context, *ProcessId) (*empty.Empty, error)
	// Stop a process
	StopProcess(context.Context, *ProcessId) (*empty.Empty, error)
	// Return filtered list of processes
	Processes(context.Context, *ProcessId) (*KernelProcessList, error)
	// Return list of service executables
	Executables(context.Context, *empty.Empty) (*KernelExecutableList, error)
	// Stream filtered list of events
	StreamEvents(*ProcessId, Kernel_StreamEventsServer) error
}

KernelServer is the server API for Kernel service.

type Kernel_StreamEventsClient 

type Kernel_StreamEventsClient interface {
	Recv() (*KernelProcessEvent, error)
	grpc.ClientStream
}

type Kernel_StreamEventsServer 

type Kernel_StreamEventsServer interface {
	Send(*KernelProcessEvent) error
	grpc.ServerStream
}

type ProcessId 

type ProcessId struct {
	Id uint32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"` // Process ID of a running process
	// contains filtered or unexported fields
}

A returned process identifier

func (*ProcessId) Descriptor deprecated 

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

Deprecated: Use ProcessId.ProtoReflect.Descriptor instead.

func (*ProcessId) GetId 

func (x *ProcessId) GetId() uint32

func (*ProcessId) ProtoMessage 

func (*ProcessId) ProtoMessage()

func (*ProcessId) ProtoReflect 

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

func (*ProcessId) Reset 

func (x *ProcessId) Reset()

func (*ProcessId) String 

func (x *ProcessId) String() string

type Service 

type Service struct {
	Sid     uint32   `protobuf:"varint,1,opt,name=sid,proto3" json:"sid,omitempty"`         // Service ID
	Name    string   `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`        // Name for the service
	Path    string   `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`        // Path to the executable
	Cwd     string   `protobuf:"bytes,4,opt,name=cwd,proto3" json:"cwd,omitempty"`          // Working directory
	Args    []string `protobuf:"bytes,5,rep,name=args,proto3" json:"args,omitempty"`        // Executable arguments
	User    string   `protobuf:"bytes,6,opt,name=user,proto3" json:"user,omitempty"`        // User identifier
	Group   string   `protobuf:"bytes,7,opt,name=group,proto3" json:"group,omitempty"`      // Group identifier
	Enabled bool     `protobuf:"varint,8,opt,name=enabled,proto3" json:"enabled,omitempty"` // Service enablement
	// contains filtered or unexported fields
}

A service definition is used to start one or more processes

func (*Service) Descriptor deprecated 

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

Deprecated: Use Service.ProtoReflect.Descriptor instead.

func (*Service) GetArgs 

func (x *Service) GetArgs() []string

func (*Service) GetCwd 

func (x *Service) GetCwd() string

func (*Service) GetEnabled 

func (x *Service) GetEnabled() bool

func (*Service) GetGroup 

func (x *Service) GetGroup() string

func (*Service) GetName 

func (x *Service) GetName() string

func (*Service) GetPath 

func (x *Service) GetPath() string

func (*Service) GetSid 

func (x *Service) GetSid() uint32

func (*Service) GetUser 

func (x *Service) GetUser() string

func (*Service) ProtoMessage 

func (*Service) ProtoMessage()

func (*Service) ProtoReflect 

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

func (*Service) Reset 

func (x *Service) Reset()

func (*Service) String 

func (x *Service) String() string

type ServiceId 

type ServiceId struct {
	Sid uint32 `protobuf:"varint,1,opt,name=sid,proto3" json:"sid,omitempty"` // ID of a service
	// contains filtered or unexported fields
}

A service identifier

func (*ServiceId) Descriptor deprecated 

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

Deprecated: Use ServiceId.ProtoReflect.Descriptor instead.

func (*ServiceId) GetSid 

func (x *ServiceId) GetSid() uint32

func (*ServiceId) ProtoMessage 

func (*ServiceId) ProtoMessage()

func (*ServiceId) ProtoReflect 

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

func (*ServiceId) Reset 

func (x *ServiceId) Reset()

func (*ServiceId) String 

func (x *ServiceId) String() string

type ServiceList 

type ServiceList struct {
	Service []*Service `protobuf:"bytes,1,rep,name=service,proto3" json:"service,omitempty"`
	// contains filtered or unexported fields
}

Return a list of services

func (*ServiceList) Descriptor deprecated 

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

Deprecated: Use ServiceList.ProtoReflect.Descriptor instead.

func (*ServiceList) GetService 

func (x *ServiceList) GetService() []*Service

func (*ServiceList) ProtoMessage 

func (*ServiceList) ProtoMessage()

func (*ServiceList) ProtoReflect 

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

func (*ServiceList) Reset 

func (x *ServiceList) Reset()

func (*ServiceList) String 

func (x *ServiceList) String() string

type ServiceUpdateRequest 

type ServiceUpdateRequest struct {
	Service *Service              `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"` // The service and fields to update
	Fields  *field_mask.FieldMask `protobuf:"bytes,2,opt,name=fields,proto3" json:"fields,omitempty"`   // The fields to update. Valid fields to
	// contains filtered or unexported fields
}

Update a service

func (*ServiceUpdateRequest) Descriptor deprecated 

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

Deprecated: Use ServiceUpdateRequest.ProtoReflect.Descriptor instead.

func (*ServiceUpdateRequest) GetFields 

func (x *ServiceUpdateRequest) GetFields() *field_mask.FieldMask

func (*ServiceUpdateRequest) GetService 

func (x *ServiceUpdateRequest) GetService() *Service

func (*ServiceUpdateRequest) ProtoMessage 

func (*ServiceUpdateRequest) ProtoMessage()

func (*ServiceUpdateRequest) ProtoReflect 

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

func (*ServiceUpdateRequest) Reset 

func (x *ServiceUpdateRequest) Reset()

func (*ServiceUpdateRequest) String 

func (x *ServiceUpdateRequest) String() string

type UnimplementedGafferServer 

type UnimplementedGafferServer struct {
}

UnimplementedGafferServer can be embedded to have forward compatible implementations.

func (*UnimplementedGafferServer) Ping 

func (*UnimplementedGafferServer) Ping(context.Context, *empty.Empty) (*empty.Empty, error)

func (*UnimplementedGafferServer) Services 

func (*UnimplementedGafferServer) Services(context.Context, *empty.Empty) (*ServiceList, error)

func (*UnimplementedGafferServer) Start 

func (*UnimplementedGafferServer) Start(context.Context, *ServiceId) (*ServiceList, error)

func (*UnimplementedGafferServer) Update 

func (*UnimplementedGafferServer) Update(context.Context, *ServiceUpdateRequest) (*ServiceList, error)

type UnimplementedKernelServer 

type UnimplementedKernelServer struct {
}

UnimplementedKernelServer can be embedded to have forward compatible implementations.

func (*UnimplementedKernelServer) CreateProcess 

func (*UnimplementedKernelServer) CreateProcess(context.Context, *Service) (*ProcessId, error)

func (*UnimplementedKernelServer) Executables 

func (*UnimplementedKernelServer) Executables(context.Context, *empty.Empty) (*KernelExecutableList, error)

func (*UnimplementedKernelServer) Ping 

func (*UnimplementedKernelServer) Ping(context.Context, *empty.Empty) (*empty.Empty, error)

func (*UnimplementedKernelServer) Processes 

func (*UnimplementedKernelServer) Processes(context.Context, *ProcessId) (*KernelProcessList, error)

func (*UnimplementedKernelServer) RunProcess 

func (*UnimplementedKernelServer) RunProcess(context.Context, *ProcessId) (*empty.Empty, error)

func (*UnimplementedKernelServer) StopProcess 

func (*UnimplementedKernelServer) StopProcess(context.Context, *ProcessId) (*empty.Empty, error)

func (*UnimplementedKernelServer) StreamEvents 

func (*UnimplementedKernelServer) StreamEvents(*ProcessId, Kernel_StreamEventsServer) error

Source Files

View all Source files

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.