examples

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 18, 2025 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

Package examples is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	Auth_SignIn_FullMethodName = "/armortal.protobuffed.example.Auth/SignIn"
	Auth_SignUp_FullMethodName = "/armortal.protobuffed.example.Auth/SignUp"
)

Variables

View Source 
var Auth_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "armortal.protobuffed.example.Auth",
	HandlerType: (*AuthServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SignIn",
			Handler:    _Auth_SignIn_Handler,
		},
		{
			MethodName: "SignUp",
			Handler:    _Auth_SignUp_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "example.proto",
}

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

View Source 
var File_example_proto protoreflect.FileDescriptor

Functions

func RegisterAuthHandler 

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

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

func RegisterAuthHandlerClient 

func RegisterAuthHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AuthClient) error

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

func RegisterAuthHandlerFromEndpoint 

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

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

func RegisterAuthHandlerServer 

func RegisterAuthHandlerServer(ctx context.Context, mux *runtime.ServeMux, server AuthServer) error

RegisterAuthHandlerServer registers the http handlers for service Auth to "mux". UnaryRPC :call AuthServer 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 RegisterAuthHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.

func RegisterAuthServer 

func RegisterAuthServer(s grpc.ServiceRegistrar, srv AuthServer)

Types

type AuthClient 

type AuthClient interface {
	SignIn(ctx context.Context, in *SignInRequest, opts ...grpc.CallOption) (*SignInResponse, error)
	SignUp(ctx context.Context, in *SignUpRequest, opts ...grpc.CallOption) (*SignUpResponse, error)
}

AuthClient is the client API for Auth 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 NewAuthClient 

func NewAuthClient(cc grpc.ClientConnInterface) AuthClient

type AuthServer 

type AuthServer interface {
	SignIn(context.Context, *SignInRequest) (*SignInResponse, error)
	SignUp(context.Context, *SignUpRequest) (*SignUpResponse, error)
	// contains filtered or unexported methods
}

AuthServer is the server API for Auth service. All implementations must embed UnimplementedAuthServer for forward compatibility.

type SignInRequest 

type SignInRequest struct {
	Email    string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

func (*SignInRequest) Descriptor deprecated 

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

Deprecated: Use SignInRequest.ProtoReflect.Descriptor instead.

func (*SignInRequest) GetEmail 

func (x *SignInRequest) GetEmail() string

func (*SignInRequest) GetPassword 

func (x *SignInRequest) GetPassword() string

func (*SignInRequest) ProtoMessage 

func (*SignInRequest) ProtoMessage()

func (*SignInRequest) ProtoReflect 

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

func (*SignInRequest) Reset 

func (x *SignInRequest) Reset()

func (*SignInRequest) String 

func (x *SignInRequest) String() string

type SignInResponse 

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

func (*SignInResponse) Descriptor deprecated 

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

Deprecated: Use SignInResponse.ProtoReflect.Descriptor instead.

func (*SignInResponse) GetToken 

func (x *SignInResponse) GetToken() string

func (*SignInResponse) ProtoMessage 

func (*SignInResponse) ProtoMessage()

func (*SignInResponse) ProtoReflect 

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

func (*SignInResponse) Reset 

func (x *SignInResponse) Reset()

func (*SignInResponse) String 

func (x *SignInResponse) String() string

type SignUpRequest 

type SignUpRequest struct {
	Email    string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

func (*SignUpRequest) Descriptor deprecated 

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

Deprecated: Use SignUpRequest.ProtoReflect.Descriptor instead.

func (*SignUpRequest) GetEmail 

func (x *SignUpRequest) GetEmail() string

func (*SignUpRequest) GetPassword 

func (x *SignUpRequest) GetPassword() string

func (*SignUpRequest) ProtoMessage 

func (*SignUpRequest) ProtoMessage()

func (*SignUpRequest) ProtoReflect 

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

func (*SignUpRequest) Reset 

func (x *SignUpRequest) Reset()

func (*SignUpRequest) String 

func (x *SignUpRequest) String() string

type SignUpResponse 

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

func (*SignUpResponse) Descriptor deprecated 

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

Deprecated: Use SignUpResponse.ProtoReflect.Descriptor instead.

func (*SignUpResponse) GetToken 

func (x *SignUpResponse) GetToken() string

func (*SignUpResponse) ProtoMessage 

func (*SignUpResponse) ProtoMessage()

func (*SignUpResponse) ProtoReflect 

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

func (*SignUpResponse) Reset 

func (x *SignUpResponse) Reset()

func (*SignUpResponse) String 

func (x *SignUpResponse) String() string

type UnimplementedAuthServer 

type UnimplementedAuthServer struct{}

UnimplementedAuthServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedAuthServer) SignIn 

func (UnimplementedAuthServer) SignIn(context.Context, *SignInRequest) (*SignInResponse, error)

func (UnimplementedAuthServer) SignUp 

func (UnimplementedAuthServer) SignUp(context.Context, *SignUpRequest) (*SignUpResponse, error)

type UnsafeAuthServer 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.