helloworld

Documentation

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, ...) (err error)
• func RegisterGreeterHandlerServer(ctx context.Context, mux *runtime.ServeMux, server GreeterService) error
• func RegisterGreeterService(s grpc.ServiceRegistrar, srv *GreeterService)
• type GreeterClient
  • func NewGreeterClient(cc grpc.ClientConnInterface) GreeterClient
• type GreeterService
  • func NewGreeterService(s interface{}) *GreeterService
• 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() *wrappers.BoolValue
  • func (x *HelloRequest) GetBytesVal() *wrappers.BytesValue
  • func (x *HelloRequest) GetDoubleVal() *wrappers.DoubleValue
  • func (x *HelloRequest) GetFloatVal() *wrappers.FloatValue
  • func (x *HelloRequest) GetInt32Val() *wrappers.Int32Value
  • func (x *HelloRequest) GetInt64Val() *wrappers.Int64Value
  • func (x *HelloRequest) GetName() string
  • func (x *HelloRequest) GetStrVal() *wrappers.StringValue
  • func (x *HelloRequest) GetUint32Val() *wrappers.UInt32Value
  • func (x *HelloRequest) GetUint64Val() *wrappers.UInt64Value
  • func (*HelloRequest) ProtoMessage()
  • func (x *HelloRequest) ProtoReflect() protoreflect.Message
  • func (x *HelloRequest) Reset()
  • func (x *HelloRequest) String() string
• type UnstableGreeterService

Variables

var File_examples_internal_helloworld_helloworld_proto protoreflect.FileDescriptor

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 GreeterService) error

RegisterGreeterHandlerServer registers the http handlers for service Greeter to "mux". UnaryRPC :call GreeterService 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 RegisterGreeterService

func RegisterGreeterService(s grpc.ServiceRegistrar, srv *GreeterService)

RegisterGreeterService registers a service implementation with a gRPC server.

Types

type GreeterClient

type GreeterClient interface {
	SayHello(ctx context.Context, in *HelloRequest, opts ...grpc.CallOption) (*HelloReply, 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 GreeterService

type GreeterService struct {
	SayHello func(context.Context, *HelloRequest) (*HelloReply, error)
}

GreeterService is the service API for Greeter service. Fields should be assigned to their respective handler implementations only before RegisterGreeterService is called. Any unassigned fields will result in the handler for that method returning an Unimplemented error.

func NewGreeterService

func NewGreeterService(s interface{}) *GreeterService

NewGreeterService creates a new GreeterService containing the implemented methods of the Greeter service in s. Any unimplemented methods will result in the gRPC server returning an UNIMPLEMENTED status to the client. This includes situations where the method handler is misspelled or has the wrong signature. For this reason, this function should be used with great care and is not recommended to be used by most users.

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    *wrappers.StringValue `protobuf:"bytes,2,opt,name=strVal,proto3" json:"strVal,omitempty"`
	FloatVal  *wrappers.FloatValue  `protobuf:"bytes,3,opt,name=floatVal,proto3" json:"floatVal,omitempty"`
	DoubleVal *wrappers.DoubleValue `protobuf:"bytes,4,opt,name=doubleVal,proto3" json:"doubleVal,omitempty"`
	BoolVal   *wrappers.BoolValue   `protobuf:"bytes,5,opt,name=boolVal,proto3" json:"boolVal,omitempty"`
	BytesVal  *wrappers.BytesValue  `protobuf:"bytes,6,opt,name=bytesVal,proto3" json:"bytesVal,omitempty"`
	Int32Val  *wrappers.Int32Value  `protobuf:"bytes,7,opt,name=int32Val,proto3" json:"int32Val,omitempty"`
	Uint32Val *wrappers.UInt32Value `protobuf:"bytes,8,opt,name=uint32Val,proto3" json:"uint32Val,omitempty"`
	Int64Val  *wrappers.Int64Value  `protobuf:"bytes,9,opt,name=int64Val,proto3" json:"int64Val,omitempty"`
	Uint64Val *wrappers.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() *wrappers.BoolValue

func (*HelloRequest) GetBytesVal

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

func (*HelloRequest) GetDoubleVal

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

func (*HelloRequest) GetFloatVal

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

func (*HelloRequest) GetInt32Val

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

func (*HelloRequest) GetInt64Val

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

func (*HelloRequest) GetName

func (x *HelloRequest) GetName() string

func (*HelloRequest) GetStrVal

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

func (*HelloRequest) GetUint32Val

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

func (*HelloRequest) GetUint64Val

func (x *HelloRequest) GetUint64Val() *wrappers.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 UnstableGreeterService

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

UnstableGreeterService is the service API for Greeter service. New methods may be added to this interface if they are added to the service definition, which is not a backward-compatible change. For this reason, use of this type is not recommended.