greeter

Documentation

Overview

Package greeter is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Variables
• func RegisterGreeterHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterGreeterHandlerClient(ctx context.Context, mux *runtime.ServeMux, client GreeterClient) error
• func RegisterGreeterHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterGreeterHandlerServer(ctx context.Context, mux *runtime.ServeMux, server GreeterServer) error
• func RegisterGreeterServer(s grpc.ServiceRegistrar, srv GreeterServer)
• type GreeterClient
  • func NewGreeterClient(cc grpc.ClientConnInterface) GreeterClient
• type GreeterRequest
  • func (*GreeterRequest) Descriptor() ([]byte, []int)
  • func (*GreeterRequest) ProtoMessage()
  • func (x *GreeterRequest) ProtoReflect() protoreflect.Message
  • func (x *GreeterRequest) Reset()
  • func (x *GreeterRequest) String() string
• type GreeterResponse
  • func (*GreeterResponse) Descriptor() ([]byte, []int)
  • func (*GreeterResponse) ProtoMessage()
  • func (x *GreeterResponse) ProtoReflect() protoreflect.Message
  • func (x *GreeterResponse) Reset()
  • func (x *GreeterResponse) String() string
• type GreeterServer
• type UnimplementedGreeterServer
  • func (UnimplementedGreeterServer) Greeter(context.Context, *GreeterRequest) (*GreeterResponse, error)
• type UnsafeGreeterServer

Variables

var File_v1_greeter_proto protoreflect.FileDescriptor

var Greeter_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.v1.Greeter",
	HandlerType: (*GreeterServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Greeter",
			Handler:    _Greeter_Greeter_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "v1/greeter.proto",
}

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

Functions

func RegisterGreeterHandler

func RegisterGreeterHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterGreeterHandler registers the http handlers for service Greeter to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterGreeterHandlerClient

func RegisterGreeterHandlerClient(ctx context.Context, mux *runtime.ServeMux, client GreeterClient) error

RegisterGreeterHandlerClient registers the http handlers for service Greeter to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "GreeterClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "GreeterClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "GreeterClient" to call the correct interceptors.

func RegisterGreeterHandlerFromEndpoint

func RegisterGreeterHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterGreeterHandlerFromEndpoint is same as RegisterGreeterHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterGreeterHandlerServer

func RegisterGreeterHandlerServer(ctx context.Context, mux *runtime.ServeMux, server GreeterServer) error

RegisterGreeterHandlerServer registers the http handlers for service Greeter to "mux". UnaryRPC :call GreeterServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterGreeterHandlerFromEndpoint instead.

func RegisterGreeterServer

func RegisterGreeterServer(s grpc.ServiceRegistrar, srv GreeterServer)

Types

type GreeterClient

type GreeterClient interface {
	Greeter(ctx context.Context, in *GreeterRequest, opts ...grpc.CallOption) (*GreeterResponse, error)
}

GreeterClient is the client API for Greeter 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 NewGreeterClient

func NewGreeterClient(cc grpc.ClientConnInterface) GreeterClient

type GreeterRequest

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

func (*GreeterRequest) Descriptor

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

Deprecated: Use GreeterRequest.ProtoReflect.Descriptor instead.

func (*GreeterRequest) ProtoMessage

func (*GreeterRequest) ProtoMessage()

func (*GreeterRequest) ProtoReflect

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

func (*GreeterRequest) Reset

func (x *GreeterRequest) Reset()

func (*GreeterRequest) String

func (x *GreeterRequest) String() string

type GreeterResponse

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

func (*GreeterResponse) Descriptor

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

Deprecated: Use GreeterResponse.ProtoReflect.Descriptor instead.

func (*GreeterResponse) ProtoMessage

func (*GreeterResponse) ProtoMessage()

func (*GreeterResponse) ProtoReflect

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

func (*GreeterResponse) Reset

func (x *GreeterResponse) Reset()

func (*GreeterResponse) String

func (x *GreeterResponse) String() string

type GreeterServer

type GreeterServer interface {
	Greeter(context.Context, *GreeterRequest) (*GreeterResponse, error)
}

GreeterServer is the server API for Greeter service. All implementations should embed UnimplementedGreeterServer for forward compatibility

type UnimplementedGreeterServer

type UnimplementedGreeterServer struct {
}

UnimplementedGreeterServer should be embedded to have forward compatible implementations.

func (UnimplementedGreeterServer) Greeter

func (UnimplementedGreeterServer) Greeter(context.Context, *GreeterRequest) (*GreeterResponse, error)

type UnsafeGreeterServer

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

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