proto

Documentation

Overview

Package proto is a reverse proxy.

It translates gRPC into JSON-RPC 2.0

Index

• Constants
• Variables
• func RegisterEchoServiceServer(s grpc.ServiceRegistrar, srv EchoServiceServer)
• type EchoRequest
  • func (*EchoRequest) Descriptor() ([]byte, []int)
  • func (x *EchoRequest) GetName() string
  • func (x *EchoRequest) GetType() EchoType
  • func (*EchoRequest) ProtoMessage()
  • func (x *EchoRequest) ProtoReflect() protoreflect.Message
  • func (x *EchoRequest) Reset()
  • func (x *EchoRequest) String() string
• type EchoResponse
  • func (*EchoResponse) Descriptor() ([]byte, []int)
  • func (x *EchoResponse) GetMessage() string
  • func (*EchoResponse) ProtoMessage()
  • func (x *EchoResponse) ProtoReflect() protoreflect.Message
  • func (x *EchoResponse) Reset()
  • func (x *EchoResponse) String() string
• type EchoServiceClient
  • func NewEchoServiceClient(cc grpc.ClientConnInterface) EchoServiceClient
• type EchoServiceJsonRPC
  • func RegisterEchoServiceJsonRPC(conn *grpc.ClientConn) *EchoServiceJsonRPC
  • func (s *EchoServiceJsonRPC) Methods() map[string]func(ctx context.Context, message json.RawMessage) (any, error)
• type EchoServiceServer
• type EchoType
  • func (EchoType) Descriptor() protoreflect.EnumDescriptor
  • func (x EchoType) Enum() *EchoType
  • func (EchoType) EnumDescriptor() ([]byte, []int)
  • func (x EchoType) Number() protoreflect.EnumNumber
  • func (x EchoType) String() string
  • func (EchoType) Type() protoreflect.EnumType
• type UnimplementedEchoServiceServer
  • func (UnimplementedEchoServiceServer) Echo(context.Context, *EchoRequest) (*EchoResponse, error)
• type UnsafeEchoServiceServer

Constants

const (
	EchoService_Echo_FullMethodName = "/proto.EchoService/Echo"
)

Variables

var (
	EchoType_name = map[int32]string{
		0: "FOO",
		1: "BAR",
	}
	EchoType_value = map[string]int32{
		"FOO": 0,
		"BAR": 1,
	}
)

Enum value maps for EchoType.

var EchoService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "proto.EchoService",
	HandlerType: (*EchoServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Echo",
			Handler:    _EchoService_Echo_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "echo.proto",
}

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

var File_echo_proto protoreflect.FileDescriptor

Functions

func RegisterEchoServiceServer

func RegisterEchoServiceServer(s grpc.ServiceRegistrar, srv EchoServiceServer)

Types

type EchoRequest

type EchoRequest struct {
	Name string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Type EchoType `protobuf:"varint,2,opt,name=type,proto3,enum=proto.EchoType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*EchoRequest) Descriptor

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

Deprecated: Use EchoRequest.ProtoReflect.Descriptor instead.

func (*EchoRequest) GetName

func (x *EchoRequest) GetName() string

func (*EchoRequest) GetType

func (x *EchoRequest) GetType() EchoType

func (*EchoRequest) ProtoMessage

func (*EchoRequest) ProtoMessage()

func (*EchoRequest) ProtoReflect

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

func (*EchoRequest) Reset

func (x *EchoRequest) Reset()

func (*EchoRequest) String

func (x *EchoRequest) String() string

type EchoResponse

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

func (*EchoResponse) Descriptor

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

Deprecated: Use EchoResponse.ProtoReflect.Descriptor instead.

func (*EchoResponse) GetMessage

func (x *EchoResponse) GetMessage() string

func (*EchoResponse) ProtoMessage

func (*EchoResponse) ProtoMessage()

func (*EchoResponse) ProtoReflect

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

func (*EchoResponse) Reset

func (x *EchoResponse) Reset()

func (*EchoResponse) String

func (x *EchoResponse) String() string

type EchoServiceClient

type EchoServiceClient interface {
	Echo(ctx context.Context, in *EchoRequest, opts ...grpc.CallOption) (*EchoResponse, error)
}

EchoServiceClient is the client API for EchoService 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 NewEchoServiceClient

func NewEchoServiceClient(cc grpc.ClientConnInterface) EchoServiceClient

type EchoServiceJsonRPC

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

func RegisterEchoServiceJsonRPC

func RegisterEchoServiceJsonRPC(conn *grpc.ClientConn) *EchoServiceJsonRPC

RegisterEchoServiceJsonRPC register the grpc client EchoService for json-rpc. The handlers forward requests to the grpc endpoint over "conn".

func (*EchoServiceJsonRPC) Methods

func (s *EchoServiceJsonRPC) Methods() map[string]func(ctx context.Context, message json.RawMessage) (any, error)

type EchoServiceServer

type EchoServiceServer interface {
	Echo(context.Context, *EchoRequest) (*EchoResponse, error)
	// contains filtered or unexported methods
}

EchoServiceServer is the server API for EchoService service. All implementations must embed UnimplementedEchoServiceServer for forward compatibility

type EchoType

type EchoType int32

const (
	EchoType_FOO EchoType = 0
	EchoType_BAR EchoType = 1
)

func (EchoType) Descriptor

func (EchoType) Descriptor() protoreflect.EnumDescriptor

func (EchoType) Enum

func (x EchoType) Enum() *EchoType

func (EchoType) EnumDescriptor

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

Deprecated: Use EchoType.Descriptor instead.

func (EchoType) Number

func (x EchoType) Number() protoreflect.EnumNumber

func (EchoType) String

func (x EchoType) String() string

func (EchoType) Type

func (EchoType) Type() protoreflect.EnumType

type UnimplementedEchoServiceServer

type UnimplementedEchoServiceServer struct {
}

UnimplementedEchoServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedEchoServiceServer) Echo

func (UnimplementedEchoServiceServer) Echo(context.Context, *EchoRequest) (*EchoResponse, error)

type UnsafeEchoServiceServer

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

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