serverpb

package
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Oct 6, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_api_v1_serverpb_server_proto protoreflect.FileDescriptor
View Source 
var ServerService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.v1.serverpb.ServerService",
	HandlerType: (*ServerServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetServerInfo",
			Handler:    _ServerService_GetServerInfo_Handler,
		},
		{
			MethodName: "GetLogs",
			Handler:    _ServerService_GetLogs_Handler,
		},
		{
			MethodName: "ReloadConfig",
			Handler:    _ServerService_ReloadConfig_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/v1/serverpb/server.proto",
}

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

Functions

func RegisterServerServiceServer 

func RegisterServerServiceServer(s grpc.ServiceRegistrar, srv ServerServiceServer)

Types

type ClientInfo 

type ClientInfo struct {

	// Number of active client connections.
	ClientConnections uint32 `protobuf:"varint,1,opt,name=client_connections,json=clientConnections,proto3" json:"client_connections,omitempty"`
	// Maximum number of client connections allowed.
	MaxClientConnections uint32 `protobuf:"varint,2,opt,name=max_client_connections,json=maxClientConnections,proto3" json:"max_client_connections,omitempty"`
	// contains filtered or unexported fields
}

ClientInfo represents information about client connections.

func (*ClientInfo) Descriptor deprecated 

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

Deprecated: Use ClientInfo.ProtoReflect.Descriptor instead.

func (*ClientInfo) GetClientConnections 

func (x *ClientInfo) GetClientConnections() uint32

func (*ClientInfo) GetMaxClientConnections 

func (x *ClientInfo) GetMaxClientConnections() uint32

func (*ClientInfo) ProtoMessage 

func (*ClientInfo) ProtoMessage()

func (*ClientInfo) ProtoReflect 

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

func (*ClientInfo) Reset 

func (x *ClientInfo) Reset()

func (*ClientInfo) String 

func (x *ClientInfo) String() string

type DatabaseInfo 

type DatabaseInfo struct {

	// Number of databases.
	DbCount uint32 `protobuf:"varint,1,opt,name=db_count,json=dbCount,proto3" json:"db_count,omitempty"`
	// Default database that the server uses.
	DefaultDb string `protobuf:"bytes,2,opt,name=default_db,json=defaultDb,proto3" json:"default_db,omitempty"`
	// contains filtered or unexported fields
}

DatabaseInfo represents information about databases.

func (*DatabaseInfo) Descriptor deprecated 

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

Deprecated: Use DatabaseInfo.ProtoReflect.Descriptor instead.

func (*DatabaseInfo) GetDbCount 

func (x *DatabaseInfo) GetDbCount() uint32

func (*DatabaseInfo) GetDefaultDb 

func (x *DatabaseInfo) GetDefaultDb() string

func (*DatabaseInfo) ProtoMessage 

func (*DatabaseInfo) ProtoMessage()

func (*DatabaseInfo) ProtoReflect 

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

func (*DatabaseInfo) Reset 

func (x *DatabaseInfo) Reset()

func (*DatabaseInfo) String 

func (x *DatabaseInfo) String() string

type GeneralInfo 

type GeneralInfo struct {

	// Version of the server.
	ServerVersion string `protobuf:"bytes,1,opt,name=server_version,json=serverVersion,proto3" json:"server_version,omitempty"`
	// Version of Go used to compile the server.
	GoVersion string `protobuf:"bytes,2,opt,name=go_version,json=goVersion,proto3" json:"go_version,omitempty"`
	// Server operating system.
	Os string `protobuf:"bytes,3,opt,name=os,proto3" json:"os,omitempty"`
	// Architecture which can be 32 or 64 bits.
	Arch string `protobuf:"bytes,4,opt,name=arch,proto3" json:"arch,omitempty"`
	// PID of the server process.
	ProcessId uint32 `protobuf:"varint,5,opt,name=process_id,json=processId,proto3" json:"process_id,omitempty"`
	// Server process uptime in seconds.
	UptimeSeconds uint64 `protobuf:"varint,6,opt,name=uptime_seconds,json=uptimeSeconds,proto3" json:"uptime_seconds,omitempty"`
	// Server TCP/IP port.
	TcpPort uint32 `protobuf:"varint,7,opt,name=tcp_port,json=tcpPort,proto3" json:"tcp_port,omitempty"`
	// True if TLS is enabled.
	TlsEnabled bool `protobuf:"varint,8,opt,name=tls_enabled,json=tlsEnabled,proto3" json:"tls_enabled,omitempty"`
	// True if authentication is enabled.
	AuthEnabled bool `protobuf:"varint,9,opt,name=auth_enabled,json=authEnabled,proto3" json:"auth_enabled,omitempty"`
	// True if the log file is enabled.
	LogfileEnabled bool `protobuf:"varint,10,opt,name=logfile_enabled,json=logfileEnabled,proto3" json:"logfile_enabled,omitempty"`
	// True if debug mode is enabled.
	DebugEnabled bool `protobuf:"varint,11,opt,name=debug_enabled,json=debugEnabled,proto3" json:"debug_enabled,omitempty"`
	// Version of the API.
	ApiVersion string `protobuf:"bytes,12,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// True if TLS client certificate authentication is enabled.
	TlsClientCertAuthEnabled bool `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

GeneralInfo represents general information about the server.

func (*GeneralInfo) Descriptor deprecated 

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

Deprecated: Use GeneralInfo.ProtoReflect.Descriptor instead.

func (*GeneralInfo) GetApiVersion 

func (x *GeneralInfo) GetApiVersion() string

func (*GeneralInfo) GetArch 

func (x *GeneralInfo) GetArch() string

func (*GeneralInfo) GetAuthEnabled 

func (x *GeneralInfo) GetAuthEnabled() bool

func (*GeneralInfo) GetDebugEnabled 

func (x *GeneralInfo) GetDebugEnabled() bool

func (*GeneralInfo) GetGoVersion 

func (x *GeneralInfo) GetGoVersion() string

func (*GeneralInfo) GetLogfileEnabled 

func (x *GeneralInfo) GetLogfileEnabled() bool

func (*GeneralInfo) GetOs 

func (x *GeneralInfo) GetOs() string

func (*GeneralInfo) GetProcessId 

func (x *GeneralInfo) GetProcessId() uint32

func (*GeneralInfo) GetServerVersion 

func (x *GeneralInfo) GetServerVersion() string

func (*GeneralInfo) GetTcpPort 

func (x *GeneralInfo) GetTcpPort() uint32

func (*GeneralInfo) GetTlsClientCertAuthEnabled added in v1.1.0 

func (x *GeneralInfo) GetTlsClientCertAuthEnabled() bool

func (*GeneralInfo) GetTlsEnabled 

func (x *GeneralInfo) GetTlsEnabled() bool

func (*GeneralInfo) GetUptimeSeconds 

func (x *GeneralInfo) GetUptimeSeconds() uint64

func (*GeneralInfo) ProtoMessage 

func (*GeneralInfo) ProtoMessage()

func (*GeneralInfo) ProtoReflect 

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

func (*GeneralInfo) Reset 

func (x *GeneralInfo) Reset()

func (*GeneralInfo) String 

func (x *GeneralInfo) String() string

type GetLogsRequest 

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

func (*GetLogsRequest) Descriptor deprecated 

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

Deprecated: Use GetLogsRequest.ProtoReflect.Descriptor instead.

func (*GetLogsRequest) ProtoMessage 

func (*GetLogsRequest) ProtoMessage()

func (*GetLogsRequest) ProtoReflect 

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

func (*GetLogsRequest) Reset 

func (x *GetLogsRequest) Reset()

func (*GetLogsRequest) String 

func (x *GetLogsRequest) String() string

type GetLogsResponse 

type GetLogsResponse struct {

	// List of returned logs.
	Logs []string `protobuf:"bytes,1,rep,name=logs,proto3" json:"logs,omitempty"`
	// contains filtered or unexported fields
}

func (*GetLogsResponse) Descriptor deprecated 

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

Deprecated: Use GetLogsResponse.ProtoReflect.Descriptor instead.

func (*GetLogsResponse) GetLogs 

func (x *GetLogsResponse) GetLogs() []string

func (*GetLogsResponse) ProtoMessage 

func (*GetLogsResponse) ProtoMessage()

func (*GetLogsResponse) ProtoReflect 

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

func (*GetLogsResponse) Reset 

func (x *GetLogsResponse) Reset()

func (*GetLogsResponse) String 

func (x *GetLogsResponse) String() string

type GetServerInfoRequest 

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

func (*GetServerInfoRequest) Descriptor deprecated 

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

Deprecated: Use GetServerInfoRequest.ProtoReflect.Descriptor instead.

func (*GetServerInfoRequest) ProtoMessage 

func (*GetServerInfoRequest) ProtoMessage()

func (*GetServerInfoRequest) ProtoReflect 

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

func (*GetServerInfoRequest) Reset 

func (x *GetServerInfoRequest) Reset()

func (*GetServerInfoRequest) String 

func (x *GetServerInfoRequest) String() string

type GetServerInfoResponse 

type GetServerInfoResponse struct {
	GeneralInfo *GeneralInfo  `protobuf:"bytes,1,opt,name=general_info,json=generalInfo,proto3" json:"general_info,omitempty"`
	MemoryInfo  *MemoryInfo   `protobuf:"bytes,2,opt,name=memory_info,json=memoryInfo,proto3" json:"memory_info,omitempty"`
	StorageInfo *StorageInfo  `protobuf:"bytes,3,opt,name=storage_info,json=storageInfo,proto3" json:"storage_info,omitempty"`
	ClientInfo  *ClientInfo   `protobuf:"bytes,4,opt,name=client_info,json=clientInfo,proto3" json:"client_info,omitempty"`
	DbInfo      *DatabaseInfo `protobuf:"bytes,5,opt,name=db_info,json=dbInfo,proto3" json:"db_info,omitempty"`
	// contains filtered or unexported fields
}

func (*GetServerInfoResponse) Descriptor deprecated 

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

Deprecated: Use GetServerInfoResponse.ProtoReflect.Descriptor instead.

func (*GetServerInfoResponse) GetClientInfo 

func (x *GetServerInfoResponse) GetClientInfo() *ClientInfo

func (*GetServerInfoResponse) GetDbInfo 

func (x *GetServerInfoResponse) GetDbInfo() *DatabaseInfo

func (*GetServerInfoResponse) GetGeneralInfo 

func (x *GetServerInfoResponse) GetGeneralInfo() *GeneralInfo

func (*GetServerInfoResponse) GetMemoryInfo 

func (x *GetServerInfoResponse) GetMemoryInfo() *MemoryInfo

func (*GetServerInfoResponse) GetStorageInfo 

func (x *GetServerInfoResponse) GetStorageInfo() *StorageInfo

func (*GetServerInfoResponse) ProtoMessage 

func (*GetServerInfoResponse) ProtoMessage()

func (*GetServerInfoResponse) ProtoReflect 

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

func (*GetServerInfoResponse) Reset 

func (x *GetServerInfoResponse) Reset()

func (*GetServerInfoResponse) String 

func (x *GetServerInfoResponse) String() string

type MemoryInfo 

type MemoryInfo struct {

	// Allocated memory.
	MemoryAlloc uint64 `protobuf:"varint,1,opt,name=memory_alloc,json=memoryAlloc,proto3" json:"memory_alloc,omitempty"`
	// Total allocated memory.
	MemoryTotalAlloc uint64 `protobuf:"varint,2,opt,name=memory_total_alloc,json=memoryTotalAlloc,proto3" json:"memory_total_alloc,omitempty"`
	// Memory obtained from OS.
	MemorySys uint64 `protobuf:"varint,3,opt,name=memory_sys,json=memorySys,proto3" json:"memory_sys,omitempty"`
	// contains filtered or unexported fields
}

MemoryInfo represents information about memory consumption.

func (*MemoryInfo) Descriptor deprecated 

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

Deprecated: Use MemoryInfo.ProtoReflect.Descriptor instead.

func (*MemoryInfo) GetMemoryAlloc 

func (x *MemoryInfo) GetMemoryAlloc() uint64

func (*MemoryInfo) GetMemorySys 

func (x *MemoryInfo) GetMemorySys() uint64

func (*MemoryInfo) GetMemoryTotalAlloc 

func (x *MemoryInfo) GetMemoryTotalAlloc() uint64

func (*MemoryInfo) ProtoMessage 

func (*MemoryInfo) ProtoMessage()

func (*MemoryInfo) ProtoReflect 

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

func (*MemoryInfo) Reset 

func (x *MemoryInfo) Reset()

func (*MemoryInfo) String 

func (x *MemoryInfo) String() string

type ReloadConfigRequest added in v1.2.0 

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

func (*ReloadConfigRequest) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use ReloadConfigRequest.ProtoReflect.Descriptor instead.

func (*ReloadConfigRequest) ProtoMessage added in v1.2.0 

func (*ReloadConfigRequest) ProtoMessage()

func (*ReloadConfigRequest) ProtoReflect added in v1.2.0 

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

func (*ReloadConfigRequest) Reset added in v1.2.0 

func (x *ReloadConfigRequest) Reset()

func (*ReloadConfigRequest) String added in v1.2.0 

func (x *ReloadConfigRequest) String() string

type ReloadConfigResponse added in v1.2.0 

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

func (*ReloadConfigResponse) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use ReloadConfigResponse.ProtoReflect.Descriptor instead.

func (*ReloadConfigResponse) ProtoMessage added in v1.2.0 

func (*ReloadConfigResponse) ProtoMessage()

func (*ReloadConfigResponse) ProtoReflect added in v1.2.0 

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

func (*ReloadConfigResponse) Reset added in v1.2.0 

func (x *ReloadConfigResponse) Reset()

func (*ReloadConfigResponse) String added in v1.2.0 

func (x *ReloadConfigResponse) String() string

type ServerServiceClient 

type ServerServiceClient interface {
	// GetServerInfo returns information about the server.
	GetServerInfo(ctx context.Context, in *GetServerInfoRequest, opts ...grpc.CallOption) (*GetServerInfoResponse, error)
	// GetLogs returns the server logs if the log file is enabled.
	GetLogs(ctx context.Context, in *GetLogsRequest, opts ...grpc.CallOption) (*GetLogsResponse, error)
	// ReloadConfig reloads the server configurations.
	// Not all configurations can be reloaded at runtime.
	ReloadConfig(ctx context.Context, in *ReloadConfigRequest, opts ...grpc.CallOption) (*ReloadConfigResponse, error)
}

ServerServiceClient is the client API for ServerService 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 NewServerServiceClient 

func NewServerServiceClient(cc grpc.ClientConnInterface) ServerServiceClient

type ServerServiceServer 

type ServerServiceServer interface {
	// GetServerInfo returns information about the server.
	GetServerInfo(context.Context, *GetServerInfoRequest) (*GetServerInfoResponse, error)
	// GetLogs returns the server logs if the log file is enabled.
	GetLogs(context.Context, *GetLogsRequest) (*GetLogsResponse, error)
	// ReloadConfig reloads the server configurations.
	// Not all configurations can be reloaded at runtime.
	ReloadConfig(context.Context, *ReloadConfigRequest) (*ReloadConfigResponse, error)
	// contains filtered or unexported methods
}

ServerServiceServer is the server API for ServerService service. All implementations must embed UnimplementedServerServiceServer for forward compatibility

type StorageInfo 

type StorageInfo struct {

	// Total amount of stored data in bytes.
	TotalDataSize uint64 `protobuf:"varint,1,opt,name=total_data_size,json=totalDataSize,proto3" json:"total_data_size,omitempty"`
	// Total number of keys stored on the server.
	TotalKeys uint64 `protobuf:"varint,2,opt,name=total_keys,json=totalKeys,proto3" json:"total_keys,omitempty"`
	// contains filtered or unexported fields
}

StorageInfo represents information about data storage.

func (*StorageInfo) Descriptor deprecated 

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

Deprecated: Use StorageInfo.ProtoReflect.Descriptor instead.

func (*StorageInfo) GetTotalDataSize 

func (x *StorageInfo) GetTotalDataSize() uint64

func (*StorageInfo) GetTotalKeys 

func (x *StorageInfo) GetTotalKeys() uint64

func (*StorageInfo) ProtoMessage 

func (*StorageInfo) ProtoMessage()

func (*StorageInfo) ProtoReflect 

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

func (*StorageInfo) Reset 

func (x *StorageInfo) Reset()

func (*StorageInfo) String 

func (x *StorageInfo) String() string

type UnimplementedServerServiceServer 

type UnimplementedServerServiceServer struct {
}

UnimplementedServerServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedServerServiceServer) GetLogs 

func (UnimplementedServerServiceServer) GetLogs(context.Context, *GetLogsRequest) (*GetLogsResponse, error)

func (UnimplementedServerServiceServer) GetServerInfo 

func (UnimplementedServerServiceServer) GetServerInfo(context.Context, *GetServerInfoRequest) (*GetServerInfoResponse, error)

func (UnimplementedServerServiceServer) ReloadConfig added in v1.2.0 

func (UnimplementedServerServiceServer) ReloadConfig(context.Context, *ReloadConfigRequest) (*ReloadConfigResponse, error)

type UnsafeServerServiceServer 

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

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

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.