server_utility

package
v0.0.8 Latest Latest
Warning

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

Go to latest
Published: Oct 22, 2024 License: BSD-3-Clause Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ServerUtilityService_SendStatusText_FullMethodName = "/mavsdk.rpc.server_utility.ServerUtilityService/SendStatusText"
)

Variables

View Source
var (
	StatusTextType_name = map[int32]string{
		0: "STATUS_TEXT_TYPE_DEBUG",
		1: "STATUS_TEXT_TYPE_INFO",
		2: "STATUS_TEXT_TYPE_NOTICE",
		3: "STATUS_TEXT_TYPE_WARNING",
		4: "STATUS_TEXT_TYPE_ERROR",
		5: "STATUS_TEXT_TYPE_CRITICAL",
		6: "STATUS_TEXT_TYPE_ALERT",
		7: "STATUS_TEXT_TYPE_EMERGENCY",
	}
	StatusTextType_value = map[string]int32{
		"STATUS_TEXT_TYPE_DEBUG":     0,
		"STATUS_TEXT_TYPE_INFO":      1,
		"STATUS_TEXT_TYPE_NOTICE":    2,
		"STATUS_TEXT_TYPE_WARNING":   3,
		"STATUS_TEXT_TYPE_ERROR":     4,
		"STATUS_TEXT_TYPE_CRITICAL":  5,
		"STATUS_TEXT_TYPE_ALERT":     6,
		"STATUS_TEXT_TYPE_EMERGENCY": 7,
	}
)

Enum value maps for StatusTextType.

View Source
var (
	ServerUtilityResult_Result_name = map[int32]string{
		0: "RESULT_UNKNOWN",
		1: "RESULT_SUCCESS",
		2: "RESULT_NO_SYSTEM",
		3: "RESULT_CONNECTION_ERROR",
		4: "RESULT_INVALID_ARGUMENT",
	}
	ServerUtilityResult_Result_value = map[string]int32{
		"RESULT_UNKNOWN":          0,
		"RESULT_SUCCESS":          1,
		"RESULT_NO_SYSTEM":        2,
		"RESULT_CONNECTION_ERROR": 3,
		"RESULT_INVALID_ARGUMENT": 4,
	}
)

Enum value maps for ServerUtilityResult_Result.

View Source
var File_server_utility_proto protoreflect.FileDescriptor
View Source
var ServerUtilityService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "mavsdk.rpc.server_utility.ServerUtilityService",
	HandlerType: (*ServerUtilityServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SendStatusText",
			Handler:    _ServerUtilityService_SendStatusText_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "server_utility.proto",
}

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

Functions

func RegisterServerUtilityServiceServer

func RegisterServerUtilityServiceServer(s grpc.ServiceRegistrar, srv ServerUtilityServiceServer)

Types

type SendStatusTextRequest

type SendStatusTextRequest struct {
	Type StatusTextType `protobuf:"varint,1,opt,name=type,proto3,enum=mavsdk.rpc.server_utility.StatusTextType" json:"type,omitempty"` // The text to send
	Text string         `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`                                                // Text message
	// contains filtered or unexported fields
}

func (*SendStatusTextRequest) Descriptor deprecated

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

Deprecated: Use SendStatusTextRequest.ProtoReflect.Descriptor instead.

func (*SendStatusTextRequest) GetText

func (x *SendStatusTextRequest) GetText() string

func (*SendStatusTextRequest) GetType

func (*SendStatusTextRequest) ProtoMessage

func (*SendStatusTextRequest) ProtoMessage()

func (*SendStatusTextRequest) ProtoReflect

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

func (*SendStatusTextRequest) Reset

func (x *SendStatusTextRequest) Reset()

func (*SendStatusTextRequest) String

func (x *SendStatusTextRequest) String() string

type SendStatusTextResponse

type SendStatusTextResponse struct {
	ServerUtilityResult *ServerUtilityResult `protobuf:"bytes,1,opt,name=server_utility_result,json=serverUtilityResult,proto3" json:"server_utility_result,omitempty"`
	// contains filtered or unexported fields
}

func (*SendStatusTextResponse) Descriptor deprecated

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

Deprecated: Use SendStatusTextResponse.ProtoReflect.Descriptor instead.

func (*SendStatusTextResponse) GetServerUtilityResult

func (x *SendStatusTextResponse) GetServerUtilityResult() *ServerUtilityResult

func (*SendStatusTextResponse) ProtoMessage

func (*SendStatusTextResponse) ProtoMessage()

func (*SendStatusTextResponse) ProtoReflect

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

func (*SendStatusTextResponse) Reset

func (x *SendStatusTextResponse) Reset()

func (*SendStatusTextResponse) String

func (x *SendStatusTextResponse) String() string

type ServerUtilityResult

type ServerUtilityResult struct {
	Result    ServerUtilityResult_Result `protobuf:"varint,1,opt,name=result,proto3,enum=mavsdk.rpc.server_utility.ServerUtilityResult_Result" json:"result,omitempty"` // Result enum value
	ResultStr string                     `protobuf:"bytes,2,opt,name=result_str,json=resultStr,proto3" json:"result_str,omitempty"`                                     // Human-readable English string describing the result
	// contains filtered or unexported fields
}

func (*ServerUtilityResult) Descriptor deprecated

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

Deprecated: Use ServerUtilityResult.ProtoReflect.Descriptor instead.

func (*ServerUtilityResult) GetResult

func (*ServerUtilityResult) GetResultStr

func (x *ServerUtilityResult) GetResultStr() string

func (*ServerUtilityResult) ProtoMessage

func (*ServerUtilityResult) ProtoMessage()

func (*ServerUtilityResult) ProtoReflect

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

func (*ServerUtilityResult) Reset

func (x *ServerUtilityResult) Reset()

func (*ServerUtilityResult) String

func (x *ServerUtilityResult) String() string

type ServerUtilityResult_Result

type ServerUtilityResult_Result int32

Possible results returned for server utility requests.

const (
	ServerUtilityResult_RESULT_UNKNOWN          ServerUtilityResult_Result = 0 // Unknown result
	ServerUtilityResult_RESULT_SUCCESS          ServerUtilityResult_Result = 1 // Request succeeded
	ServerUtilityResult_RESULT_NO_SYSTEM        ServerUtilityResult_Result = 2 // No system is connected
	ServerUtilityResult_RESULT_CONNECTION_ERROR ServerUtilityResult_Result = 3 // Connection error
	ServerUtilityResult_RESULT_INVALID_ARGUMENT ServerUtilityResult_Result = 4 // Invalid argument
)

func (ServerUtilityResult_Result) Descriptor

func (ServerUtilityResult_Result) Enum

func (ServerUtilityResult_Result) EnumDescriptor deprecated

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

Deprecated: Use ServerUtilityResult_Result.Descriptor instead.

func (ServerUtilityResult_Result) Number

func (ServerUtilityResult_Result) String

func (ServerUtilityResult_Result) Type

type ServerUtilityServiceClient

type ServerUtilityServiceClient interface {
	// Sends a statustext.
	SendStatusText(ctx context.Context, in *SendStatusTextRequest, opts ...grpc.CallOption) (*SendStatusTextResponse, error)
}

ServerUtilityServiceClient is the client API for ServerUtilityService 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.

Utility for onboard MAVSDK instances for common "server" tasks.

type ServerUtilityServiceServer

type ServerUtilityServiceServer interface {
	// Sends a statustext.
	SendStatusText(context.Context, *SendStatusTextRequest) (*SendStatusTextResponse, error)
	// contains filtered or unexported methods
}

ServerUtilityServiceServer is the server API for ServerUtilityService service. All implementations must embed UnimplementedServerUtilityServiceServer for forward compatibility.

Utility for onboard MAVSDK instances for common "server" tasks.

type ServiceImpl

type ServiceImpl struct {
	Client ServerUtilityServiceClient
}

func (*ServiceImpl) SendStatusText

func (s *ServiceImpl) SendStatusText(ctx context.Context, statusTextType *StatusTextType, text string) (*SendStatusTextResponse, error)

type StatusTextType

type StatusTextType int32

Status types.

const (
	StatusTextType_STATUS_TEXT_TYPE_DEBUG     StatusTextType = 0 // Debug
	StatusTextType_STATUS_TEXT_TYPE_INFO      StatusTextType = 1 // Information
	StatusTextType_STATUS_TEXT_TYPE_NOTICE    StatusTextType = 2 // Notice
	StatusTextType_STATUS_TEXT_TYPE_WARNING   StatusTextType = 3 // Warning
	StatusTextType_STATUS_TEXT_TYPE_ERROR     StatusTextType = 4 // Error
	StatusTextType_STATUS_TEXT_TYPE_CRITICAL  StatusTextType = 5 // Critical
	StatusTextType_STATUS_TEXT_TYPE_ALERT     StatusTextType = 6 // Alert
	StatusTextType_STATUS_TEXT_TYPE_EMERGENCY StatusTextType = 7 // Emergency
)

func (StatusTextType) Descriptor

func (StatusTextType) Enum

func (x StatusTextType) Enum() *StatusTextType

func (StatusTextType) EnumDescriptor deprecated

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

Deprecated: Use StatusTextType.Descriptor instead.

func (StatusTextType) Number

func (StatusTextType) String

func (x StatusTextType) String() string

func (StatusTextType) Type

type UnimplementedServerUtilityServiceServer

type UnimplementedServerUtilityServiceServer struct{}

UnimplementedServerUtilityServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedServerUtilityServiceServer) SendStatusText

type UnsafeServerUtilityServiceServer

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

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

Jump to

Keyboard shortcuts

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