...

Package helloworld

import "github.com/grpc-ecosystem/grpc-gateway/v2/examples/internal/helloworld"
Overview
Index

Overview ▾

Package helloworld 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, opts []grpc.DialOption) (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 GreeterServer
type HelloReply
    func (*HelloReply) Descriptor() ([]byte, []int)
    func (x *HelloReply) GetMessage() string
    func (*HelloReply) ProtoMessage()
    func (x *HelloReply) ProtoReflect() protoreflect.Message
    func (x *HelloReply) Reset()
    func (x *HelloReply) String() string
type HelloRequest
    func (*HelloRequest) Descriptor() ([]byte, []int)
    func (x *HelloRequest) GetBoolVal() *wrapperspb.BoolValue
    func (x *HelloRequest) GetBytesVal() *wrapperspb.BytesValue
    func (x *HelloRequest) GetDoubleVal() *wrapperspb.DoubleValue
    func (x *HelloRequest) GetFloatVal() *wrapperspb.FloatValue
    func (x *HelloRequest) GetInt32Val() *wrapperspb.Int32Value
    func (x *HelloRequest) GetInt64Val() *wrapperspb.Int64Value
    func (x *HelloRequest) GetName() string
    func (x *HelloRequest) GetStrVal() *wrapperspb.StringValue
    func (x *HelloRequest) GetUint32Val() *wrapperspb.UInt32Value
    func (x *HelloRequest) GetUint64Val() *wrapperspb.UInt64Value
    func (*HelloRequest) ProtoMessage()
    func (x *HelloRequest) ProtoReflect() protoreflect.Message
    func (x *HelloRequest) Reset()
    func (x *HelloRequest) String() string
type UnimplementedGreeterServer
    func (UnimplementedGreeterServer) SayHello(context.Context, *HelloRequest) (*HelloReply, error)
type UnsafeGreeterServer

Package files

helloworld.pb.go helloworld.pb.gw.go helloworld_grpc.pb.go

Variables

var File_examples_internal_helloworld_helloworld_proto protoreflect.FileDescriptor

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)

var Greeter_ServiceDesc = grpc.ServiceDesc{
    ServiceName: "grpc.gateway.examples.internal.helloworld.Greeter",
    HandlerType: (*GreeterServer)(nil),
    Methods: []grpc.MethodDesc{
        {
            MethodName: "SayHello",
            Handler:    _Greeter_SayHello_Handler,
        },
    },
    Streams:  []grpc.StreamDesc{},
    Metadata: "examples/internal/helloworld/helloworld.proto",
}

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)

type GreeterClient

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.

type GreeterClient interface {
    SayHello(ctx context.Context, in *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error)
}

func NewGreeterClient

func NewGreeterClient(cc grpc.ClientConnInterface) GreeterClient

type GreeterServer

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

type GreeterServer interface {
    SayHello(context.Context, *HelloRequest) (*HelloReply, error)
}

type HelloReply

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

func (*HelloReply) Descriptor

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

Deprecated: Use HelloReply.ProtoReflect.Descriptor instead.

func (*HelloReply) GetMessage

func (x *HelloReply) GetMessage() string

func (*HelloReply) ProtoMessage

func (*HelloReply) ProtoMessage()

func (*HelloReply) ProtoReflect

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

func (*HelloReply) Reset

func (x *HelloReply) Reset()

func (*HelloReply) String

func (x *HelloReply) String() string

type HelloRequest

type HelloRequest struct {
    Name      string                  `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    StrVal    *wrapperspb.StringValue `protobuf:"bytes,2,opt,name=strVal,proto3" json:"strVal,omitempty"`
    FloatVal  *wrapperspb.FloatValue  `protobuf:"bytes,3,opt,name=floatVal,proto3" json:"floatVal,omitempty"`
    DoubleVal *wrapperspb.DoubleValue `protobuf:"bytes,4,opt,name=doubleVal,proto3" json:"doubleVal,omitempty"`
    BoolVal   *wrapperspb.BoolValue   `protobuf:"bytes,5,opt,name=boolVal,proto3" json:"boolVal,omitempty"`
    BytesVal  *wrapperspb.BytesValue  `protobuf:"bytes,6,opt,name=bytesVal,proto3" json:"bytesVal,omitempty"`
    Int32Val  *wrapperspb.Int32Value  `protobuf:"bytes,7,opt,name=int32Val,proto3" json:"int32Val,omitempty"`
    Uint32Val *wrapperspb.UInt32Value `protobuf:"bytes,8,opt,name=uint32Val,proto3" json:"uint32Val,omitempty"`
    Int64Val  *wrapperspb.Int64Value  `protobuf:"bytes,9,opt,name=int64Val,proto3" json:"int64Val,omitempty"`
    Uint64Val *wrapperspb.UInt64Value `protobuf:"bytes,10,opt,name=uint64Val,proto3" json:"uint64Val,omitempty"`
    // contains filtered or unexported fields
}

func (*HelloRequest) Descriptor

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

Deprecated: Use HelloRequest.ProtoReflect.Descriptor instead.

func (*HelloRequest) GetBoolVal

func (x *HelloRequest) GetBoolVal() *wrapperspb.BoolValue

func (*HelloRequest) GetBytesVal

func (x *HelloRequest) GetBytesVal() *wrapperspb.BytesValue

func (*HelloRequest) GetDoubleVal

func (x *HelloRequest) GetDoubleVal() *wrapperspb.DoubleValue

func (*HelloRequest) GetFloatVal

func (x *HelloRequest) GetFloatVal() *wrapperspb.FloatValue

func (*HelloRequest) GetInt32Val

func (x *HelloRequest) GetInt32Val() *wrapperspb.Int32Value

func (*HelloRequest) GetInt64Val

func (x *HelloRequest) GetInt64Val() *wrapperspb.Int64Value

func (*HelloRequest) GetName

func (x *HelloRequest) GetName() string

func (*HelloRequest) GetStrVal

func (x *HelloRequest) GetStrVal() *wrapperspb.StringValue

func (*HelloRequest) GetUint32Val

func (x *HelloRequest) GetUint32Val() *wrapperspb.UInt32Value

func (*HelloRequest) GetUint64Val

func (x *HelloRequest) GetUint64Val() *wrapperspb.UInt64Value

func (*HelloRequest) ProtoMessage

func (*HelloRequest) ProtoMessage()

func (*HelloRequest) ProtoReflect

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

func (*HelloRequest) Reset

func (x *HelloRequest) Reset()

func (*HelloRequest) String

func (x *HelloRequest) String() string

type UnimplementedGreeterServer

UnimplementedGreeterServer should be embedded to have forward compatible implementations.

type UnimplementedGreeterServer struct {
}

func (UnimplementedGreeterServer) SayHello

func (UnimplementedGreeterServer) SayHello(context.Context, *HelloRequest) (*HelloReply, error)

type UnsafeGreeterServer

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.

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