example

Documentation

Overview

Package example is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Variables
• func RegisterUserServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterUserServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UserServiceClient) error
• func RegisterUserServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterUserServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server UserServiceServer) error
• func RegisterUserServiceServer(s *grpc.Server, srv UserServiceServer)
• type AddUserRequest
  • func (*AddUserRequest) Descriptor() ([]byte, []int)
  • func (*AddUserRequest) ProtoMessage()
  • func (x *AddUserRequest) ProtoReflect() protoreflect.Message
  • func (x *AddUserRequest) Reset()
  • func (x *AddUserRequest) String() string
• type ListUsersRequest
  • func (*ListUsersRequest) Descriptor() ([]byte, []int)
  • func (*ListUsersRequest) ProtoMessage()
  • func (x *ListUsersRequest) ProtoReflect() protoreflect.Message
  • func (x *ListUsersRequest) Reset()
  • func (x *ListUsersRequest) String() string
• type UnimplementedUserServiceServer
  • func (*UnimplementedUserServiceServer) AddUser(context.Context, *AddUserRequest) (*User, error)
  • func (*UnimplementedUserServiceServer) ListUsers(*ListUsersRequest, UserService_ListUsersServer) error
• type User
  • func (*User) Descriptor() ([]byte, []int)
  • func (x *User) GetId() string
  • func (*User) ProtoMessage()
  • func (x *User) ProtoReflect() protoreflect.Message
  • func (x *User) Reset()
  • func (x *User) String() string
• type UserServiceClient
  • func NewUserServiceClient(cc grpc.ClientConnInterface) UserServiceClient
• type UserServiceServer
• type UserService_ListUsersClient
• type UserService_ListUsersServer

Variables

var File_example_proto protoreflect.FileDescriptor

Functions

func RegisterUserServiceHandler

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

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

func RegisterUserServiceHandlerClient

func RegisterUserServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UserServiceClient) error

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

func RegisterUserServiceHandlerFromEndpoint

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

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

func RegisterUserServiceHandlerServer

func RegisterUserServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server UserServiceServer) error

RegisterUserServiceHandlerServer registers the http handlers for service UserService to "mux". UnaryRPC :call UserServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

func RegisterUserServiceServer

func RegisterUserServiceServer(s *grpc.Server, srv UserServiceServer)

Types

type AddUserRequest

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

func (*AddUserRequest) Descriptor

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

Deprecated: Use AddUserRequest.ProtoReflect.Descriptor instead.

func (*AddUserRequest) ProtoMessage

func (*AddUserRequest) ProtoMessage()

func (*AddUserRequest) ProtoReflect

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

func (*AddUserRequest) Reset

func (x *AddUserRequest) Reset()

func (*AddUserRequest) String

func (x *AddUserRequest) String() string

type ListUsersRequest

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

func (*ListUsersRequest) Descriptor

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

Deprecated: Use ListUsersRequest.ProtoReflect.Descriptor instead.

func (*ListUsersRequest) ProtoMessage

func (*ListUsersRequest) ProtoMessage()

func (*ListUsersRequest) ProtoReflect

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

func (*ListUsersRequest) Reset

func (x *ListUsersRequest) Reset()

func (*ListUsersRequest) String

func (x *ListUsersRequest) String() string

type UnimplementedUserServiceServer

type UnimplementedUserServiceServer struct {
}

UnimplementedUserServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedUserServiceServer) AddUser

func (*UnimplementedUserServiceServer) AddUser(context.Context, *AddUserRequest) (*User, error)

func (*UnimplementedUserServiceServer) ListUsers

func (*UnimplementedUserServiceServer) ListUsers(*ListUsersRequest, UserService_ListUsersServer) error

type User

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

func (*User) Descriptor

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

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetId

func (x *User) GetId() string

func (*User) ProtoMessage

func (*User) ProtoMessage()

func (*User) ProtoReflect

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

func (*User) Reset

func (x *User) Reset()

func (*User) String

func (x *User) String() string

type UserServiceClient

type UserServiceClient interface {
	AddUser(ctx context.Context, in *AddUserRequest, opts ...grpc.CallOption) (*User, error)
	ListUsers(ctx context.Context, in *ListUsersRequest, opts ...grpc.CallOption) (UserService_ListUsersClient, error)
}

UserServiceClient is the client API for UserService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewUserServiceClient

func NewUserServiceClient(cc grpc.ClientConnInterface) UserServiceClient

type UserServiceServer

type UserServiceServer interface {
	AddUser(context.Context, *AddUserRequest) (*User, error)
	ListUsers(*ListUsersRequest, UserService_ListUsersServer) error
}

UserServiceServer is the server API for UserService service.

type UserService_ListUsersClient

type UserService_ListUsersClient interface {
	Recv() (*User, error)
	grpc.ClientStream
}

type UserService_ListUsersServer

type UserService_ListUsersServer interface {
	Send(*User) error
	grpc.ServerStream
}