Documentation ¶
Overview ¶
Package user is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- 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 CreateUserReq
- func (*CreateUserReq) Descriptor() ([]byte, []int)
- func (m *CreateUserReq) GetUser() *User
- func (*CreateUserReq) ProtoMessage()
- func (m *CreateUserReq) Reset()
- func (m *CreateUserReq) String() string
- func (m *CreateUserReq) XXX_DiscardUnknown()
- func (m *CreateUserReq) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CreateUserReq) XXX_Merge(src proto.Message)
- func (m *CreateUserReq) XXX_Size() int
- func (m *CreateUserReq) XXX_Unmarshal(b []byte) error
- type CreateUserResp
- func (*CreateUserResp) Descriptor() ([]byte, []int)
- func (m *CreateUserResp) GetId() string
- func (*CreateUserResp) ProtoMessage()
- func (m *CreateUserResp) Reset()
- func (m *CreateUserResp) String() string
- func (m *CreateUserResp) XXX_DiscardUnknown()
- func (m *CreateUserResp) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CreateUserResp) XXX_Merge(src proto.Message)
- func (m *CreateUserResp) XXX_Size() int
- func (m *CreateUserResp) XXX_Unmarshal(b []byte) error
- type ReadUserReq
- func (*ReadUserReq) Descriptor() ([]byte, []int)
- func (m *ReadUserReq) GetId() string
- func (*ReadUserReq) ProtoMessage()
- func (m *ReadUserReq) Reset()
- func (m *ReadUserReq) String() string
- func (m *ReadUserReq) XXX_DiscardUnknown()
- func (m *ReadUserReq) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ReadUserReq) XXX_Merge(src proto.Message)
- func (m *ReadUserReq) XXX_Size() int
- func (m *ReadUserReq) XXX_Unmarshal(b []byte) error
- type ReadUserResp
- func (*ReadUserResp) Descriptor() ([]byte, []int)
- func (m *ReadUserResp) GetUser() *User
- func (*ReadUserResp) ProtoMessage()
- func (m *ReadUserResp) Reset()
- func (m *ReadUserResp) String() string
- func (m *ReadUserResp) XXX_DiscardUnknown()
- func (m *ReadUserResp) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ReadUserResp) XXX_Merge(src proto.Message)
- func (m *ReadUserResp) XXX_Size() int
- func (m *ReadUserResp) XXX_Unmarshal(b []byte) error
- type UnimplementedUserServiceServer
- type User
- func (*User) Descriptor() ([]byte, []int)
- func (m *User) GetEmail() string
- func (m *User) GetId() string
- func (m *User) GetName() string
- func (*User) ProtoMessage()
- func (m *User) Reset()
- func (m *User) String() string
- func (m *User) XXX_DiscardUnknown()
- func (m *User) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *User) XXX_Merge(src proto.Message)
- func (m *User) XXX_Size() int
- func (m *User) XXX_Unmarshal(b []byte) error
- type UserServiceClient
- type UserServiceServer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 CreateUserReq ¶
type CreateUserReq struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*CreateUserReq) Descriptor ¶
func (*CreateUserReq) Descriptor() ([]byte, []int)
func (*CreateUserReq) GetUser ¶
func (m *CreateUserReq) GetUser() *User
func (*CreateUserReq) ProtoMessage ¶
func (*CreateUserReq) ProtoMessage()
func (*CreateUserReq) Reset ¶
func (m *CreateUserReq) Reset()
func (*CreateUserReq) String ¶
func (m *CreateUserReq) String() string
func (*CreateUserReq) XXX_DiscardUnknown ¶
func (m *CreateUserReq) XXX_DiscardUnknown()
func (*CreateUserReq) XXX_Marshal ¶
func (m *CreateUserReq) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*CreateUserReq) XXX_Merge ¶
func (m *CreateUserReq) XXX_Merge(src proto.Message)
func (*CreateUserReq) XXX_Size ¶
func (m *CreateUserReq) XXX_Size() int
func (*CreateUserReq) XXX_Unmarshal ¶
func (m *CreateUserReq) XXX_Unmarshal(b []byte) error
type CreateUserResp ¶
type CreateUserResp struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*CreateUserResp) Descriptor ¶
func (*CreateUserResp) Descriptor() ([]byte, []int)
func (*CreateUserResp) GetId ¶
func (m *CreateUserResp) GetId() string
func (*CreateUserResp) ProtoMessage ¶
func (*CreateUserResp) ProtoMessage()
func (*CreateUserResp) Reset ¶
func (m *CreateUserResp) Reset()
func (*CreateUserResp) String ¶
func (m *CreateUserResp) String() string
func (*CreateUserResp) XXX_DiscardUnknown ¶
func (m *CreateUserResp) XXX_DiscardUnknown()
func (*CreateUserResp) XXX_Marshal ¶
func (m *CreateUserResp) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*CreateUserResp) XXX_Merge ¶
func (m *CreateUserResp) XXX_Merge(src proto.Message)
func (*CreateUserResp) XXX_Size ¶
func (m *CreateUserResp) XXX_Size() int
func (*CreateUserResp) XXX_Unmarshal ¶
func (m *CreateUserResp) XXX_Unmarshal(b []byte) error
type ReadUserReq ¶
type ReadUserReq struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*ReadUserReq) Descriptor ¶
func (*ReadUserReq) Descriptor() ([]byte, []int)
func (*ReadUserReq) GetId ¶
func (m *ReadUserReq) GetId() string
func (*ReadUserReq) ProtoMessage ¶
func (*ReadUserReq) ProtoMessage()
func (*ReadUserReq) Reset ¶
func (m *ReadUserReq) Reset()
func (*ReadUserReq) String ¶
func (m *ReadUserReq) String() string
func (*ReadUserReq) XXX_DiscardUnknown ¶
func (m *ReadUserReq) XXX_DiscardUnknown()
func (*ReadUserReq) XXX_Marshal ¶
func (m *ReadUserReq) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ReadUserReq) XXX_Merge ¶
func (m *ReadUserReq) XXX_Merge(src proto.Message)
func (*ReadUserReq) XXX_Size ¶
func (m *ReadUserReq) XXX_Size() int
func (*ReadUserReq) XXX_Unmarshal ¶
func (m *ReadUserReq) XXX_Unmarshal(b []byte) error
type ReadUserResp ¶
type ReadUserResp struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*ReadUserResp) Descriptor ¶
func (*ReadUserResp) Descriptor() ([]byte, []int)
func (*ReadUserResp) GetUser ¶
func (m *ReadUserResp) GetUser() *User
func (*ReadUserResp) ProtoMessage ¶
func (*ReadUserResp) ProtoMessage()
func (*ReadUserResp) Reset ¶
func (m *ReadUserResp) Reset()
func (*ReadUserResp) String ¶
func (m *ReadUserResp) String() string
func (*ReadUserResp) XXX_DiscardUnknown ¶
func (m *ReadUserResp) XXX_DiscardUnknown()
func (*ReadUserResp) XXX_Marshal ¶
func (m *ReadUserResp) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ReadUserResp) XXX_Merge ¶
func (m *ReadUserResp) XXX_Merge(src proto.Message)
func (*ReadUserResp) XXX_Size ¶
func (m *ReadUserResp) XXX_Size() int
func (*ReadUserResp) XXX_Unmarshal ¶
func (m *ReadUserResp) XXX_Unmarshal(b []byte) error
type UnimplementedUserServiceServer ¶
type UnimplementedUserServiceServer struct { }
UnimplementedUserServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedUserServiceServer) Create ¶
func (*UnimplementedUserServiceServer) Create(ctx context.Context, req *CreateUserReq) (*CreateUserResp, error)
func (*UnimplementedUserServiceServer) Read ¶
func (*UnimplementedUserServiceServer) Read(ctx context.Context, req *ReadUserReq) (*ReadUserResp, error)
type User ¶
type User struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*User) Descriptor ¶
func (*User) ProtoMessage ¶
func (*User) ProtoMessage()
func (*User) XXX_DiscardUnknown ¶
func (m *User) XXX_DiscardUnknown()
func (*User) XXX_Unmarshal ¶
type UserServiceClient ¶
type UserServiceClient interface { Create(ctx context.Context, in *CreateUserReq, opts ...grpc.CallOption) (*CreateUserResp, error) Read(ctx context.Context, in *ReadUserReq, opts ...grpc.CallOption) (*ReadUserResp, 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 { Create(context.Context, *CreateUserReq) (*CreateUserResp, error) Read(context.Context, *ReadUserReq) (*ReadUserResp, error) }
UserServiceServer is the server API for UserService service.