greeter

Documentation

Overview

Package greeter is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Variables
• func NewGreeterEndpoints() []*api.Endpoint
• func RegisterGreeterGw(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterGreeterGwClient(ctx context.Context, mux *runtime.ServeMux, client GreeterClient) error
• func RegisterGreeterGwFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterGreeterGwServer(ctx context.Context, mux *runtime.ServeMux, server GreeterServer) error
• func RegisterGreeterHandler(s server.Server, hdlr GreeterHandler, opts ...server.HandlerOption) error
• func RegisterGreeterServer(s grpc.ServiceRegistrar, srv GreeterServer)
• type GreeterClient
  • func NewGreeterClient(cc grpc.ClientConnInterface) GreeterClient
• type GreeterHandler
• type GreeterServer
• type GreeterService
  • func NewGreeterService(name string, c client.Client) GreeterService
• type Request
  • func (*Request) Descriptor() ([]byte, []int)
  • func (x *Request) GetName() string
  • func (*Request) ProtoMessage()
  • func (x *Request) ProtoReflect() protoreflect.Message
  • func (x *Request) Reset()
  • func (x *Request) String() string
• type Response
  • func (*Response) Descriptor() ([]byte, []int)
  • func (x *Response) GetGreeting() string
  • func (*Response) ProtoMessage()
  • func (x *Response) ProtoReflect() protoreflect.Message
  • func (x *Response) Reset()
  • func (x *Response) String() string
• type UnimplementedGreeterServer
  • func (UnimplementedGreeterServer) Hello(context.Context, *Request) (*Response, error)
• type UnsafeGreeterServer

Variables

var File_protos_greeter_hello_proto protoreflect.FileDescriptor

var Greeter_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "protos.Greeter",
	HandlerType: (*GreeterServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Hello",
			Handler:    _Greeter_Hello_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "protos/greeter/hello.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 NewGreeterEndpoints

func NewGreeterEndpoints() []*api.Endpoint

func RegisterGreeterGw

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

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

func RegisterGreeterGwClient

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

RegisterGreeterGwClient 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 RegisterGreeterGwFromEndpoint

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

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

func RegisterGreeterGwServer

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

RegisterGreeterGwServer 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 RegisterGreeterGwFromEndpoint instead.

func RegisterGreeterHandler

func RegisterGreeterHandler(s server.Server, hdlr GreeterHandler, opts ...server.HandlerOption) error

func RegisterGreeterServer

func RegisterGreeterServer(s grpc.ServiceRegistrar, srv GreeterServer)

Types

type GreeterClient

type GreeterClient interface {
	Hello(ctx context.Context, in *Request, opts ...grpc.CallOption) (*Response, 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 GreeterHandler

type GreeterHandler interface {
	Hello(context.Context, *Request, *Response) error
}

type GreeterServer

type GreeterServer interface {
	Hello(context.Context, *Request) (*Response, error)
	// contains filtered or unexported methods
}

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

type GreeterService

type GreeterService interface {
	Hello(ctx context.Context, in *Request, opts ...client.CallOption) (*Response, error)
}

func NewGreeterService

func NewGreeterService(name string, c client.Client) GreeterService

type Request

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

func (*Request) Descriptor

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

Deprecated: Use Request.ProtoReflect.Descriptor instead.

func (*Request) GetName

func (x *Request) GetName() string

func (*Request) ProtoMessage

func (*Request) ProtoMessage()

func (*Request) ProtoReflect

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

func (*Request) Reset

func (x *Request) Reset()

func (*Request) String

func (x *Request) String() string

type Response

type Response struct {
	Greeting string `protobuf:"bytes,2,opt,name=greeting,proto3" json:"greeting,omitempty"`
	// contains filtered or unexported fields
}

func (*Response) Descriptor

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

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetGreeting

func (x *Response) GetGreeting() string

func (*Response) ProtoMessage

func (*Response) ProtoMessage()

func (*Response) ProtoReflect

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

func (*Response) Reset

func (x *Response) Reset()

func (*Response) String

func (x *Response) String() string

type UnimplementedGreeterServer

type UnimplementedGreeterServer struct {
}

UnimplementedGreeterServer must be embedded to have forward compatible implementations.

func (UnimplementedGreeterServer) Hello

func (UnimplementedGreeterServer) Hello(context.Context, *Request) (*Response, 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.