Documentation ¶
Overview ¶
Package pb is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterSnippetboxHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterSnippetboxHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SnippetboxClient) error
- func RegisterSnippetboxHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterSnippetboxHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SnippetboxServer) error
- func RegisterSnippetboxServer(s grpc.ServiceRegistrar, srv SnippetboxServer)
- type CreateUserRequest
- func (*CreateUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateUserRequest) GetEmail() string
- func (x *CreateUserRequest) GetFullName() string
- func (x *CreateUserRequest) GetName() string
- func (x *CreateUserRequest) GetPassword() string
- func (*CreateUserRequest) ProtoMessage()
- func (x *CreateUserRequest) ProtoReflect() protoreflect.Message
- func (x *CreateUserRequest) Reset()
- func (x *CreateUserRequest) String() string
- type CreateUserResponse
- type LoginUserRequest
- func (*LoginUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *LoginUserRequest) GetName() string
- func (x *LoginUserRequest) GetPassword() string
- func (*LoginUserRequest) ProtoMessage()
- func (x *LoginUserRequest) ProtoReflect() protoreflect.Message
- func (x *LoginUserRequest) Reset()
- func (x *LoginUserRequest) String() string
- type LoginUserResponse
- func (*LoginUserResponse) Descriptor() ([]byte, []int)deprecated
- func (x *LoginUserResponse) GetAccessToken() string
- func (x *LoginUserResponse) GetAccessTokenExpiresAt() *timestamppb.Timestamp
- func (x *LoginUserResponse) GetRefreshToken() string
- func (x *LoginUserResponse) GetRefreshTokenExpiresAt() *timestamppb.Timestamp
- func (x *LoginUserResponse) GetSessionId() string
- func (x *LoginUserResponse) GetUser() *User
- func (*LoginUserResponse) ProtoMessage()
- func (x *LoginUserResponse) ProtoReflect() protoreflect.Message
- func (x *LoginUserResponse) Reset()
- func (x *LoginUserResponse) String() string
- type SnippetboxClient
- type SnippetboxServer
- type UnimplementedSnippetboxServer
- func (UnimplementedSnippetboxServer) CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error)
- func (UnimplementedSnippetboxServer) LoginUser(context.Context, *LoginUserRequest) (*LoginUserResponse, error)
- func (UnimplementedSnippetboxServer) UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error)
- type UnsafeSnippetboxServer
- type UpdateUserRequest
- func (*UpdateUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateUserRequest) GetEmail() string
- func (x *UpdateUserRequest) GetFullName() string
- func (x *UpdateUserRequest) GetName() string
- func (x *UpdateUserRequest) GetPassword() string
- func (*UpdateUserRequest) ProtoMessage()
- func (x *UpdateUserRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateUserRequest) Reset()
- func (x *UpdateUserRequest) String() string
- type UpdateUserResponse
- type User
- func (*User) Descriptor() ([]byte, []int)deprecated
- func (x *User) GetCreated() *timestamppb.Timestamp
- func (x *User) GetEmail() string
- func (x *User) GetFullName() string
- func (x *User) GetName() string
- func (x *User) GetPasswordChangedAt() *timestamppb.Timestamp
- func (*User) ProtoMessage()
- func (x *User) ProtoReflect() protoreflect.Message
- func (x *User) Reset()
- func (x *User) String() string
Constants ¶
const ( Snippetbox_CreateUser_FullMethodName = "/pb.Snippetbox/CreateUser" Snippetbox_UpdateUser_FullMethodName = "/pb.Snippetbox/UpdateUser" Snippetbox_LoginUser_FullMethodName = "/pb.Snippetbox/LoginUser" )
Variables ¶
var File_rpc_create_user_proto protoreflect.FileDescriptor
var File_rpc_login_user_proto protoreflect.FileDescriptor
var File_rpc_update_user_proto protoreflect.FileDescriptor
var File_service_snippetbox_proto protoreflect.FileDescriptor
var File_user_proto protoreflect.FileDescriptor
var Snippetbox_ServiceDesc = grpc.ServiceDesc{ ServiceName: "pb.Snippetbox", HandlerType: (*SnippetboxServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CreateUser", Handler: _Snippetbox_CreateUser_Handler, }, { MethodName: "UpdateUser", Handler: _Snippetbox_UpdateUser_Handler, }, { MethodName: "LoginUser", Handler: _Snippetbox_LoginUser_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "service_snippetbox.proto", }
Snippetbox_ServiceDesc is the grpc.ServiceDesc for Snippetbox service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSnippetboxHandler ¶
func RegisterSnippetboxHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterSnippetboxHandler registers the http handlers for service Snippetbox to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterSnippetboxHandlerClient ¶
func RegisterSnippetboxHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SnippetboxClient) error
RegisterSnippetboxHandlerClient registers the http handlers for service Snippetbox to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "SnippetboxClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "SnippetboxClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "SnippetboxClient" to call the correct interceptors.
func RegisterSnippetboxHandlerFromEndpoint ¶
func RegisterSnippetboxHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterSnippetboxHandlerFromEndpoint is same as RegisterSnippetboxHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterSnippetboxHandlerServer ¶
func RegisterSnippetboxHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SnippetboxServer) error
RegisterSnippetboxHandlerServer registers the http handlers for service Snippetbox to "mux". UnaryRPC :call SnippetboxServer 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 RegisterSnippetboxHandlerFromEndpoint instead.
func RegisterSnippetboxServer ¶
func RegisterSnippetboxServer(s grpc.ServiceRegistrar, srv SnippetboxServer)
Types ¶
type CreateUserRequest ¶
type CreateUserRequest struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` FullName string `protobuf:"bytes,2,opt,name=full_name,json=fullName,proto3" json:"full_name,omitempty"` Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"` Password string `protobuf:"bytes,4,opt,name=password,proto3" json:"password,omitempty"` // contains filtered or unexported fields }
func (*CreateUserRequest) Descriptor
deprecated
func (*CreateUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateUserRequest.ProtoReflect.Descriptor instead.
func (*CreateUserRequest) GetEmail ¶
func (x *CreateUserRequest) GetEmail() string
func (*CreateUserRequest) GetFullName ¶
func (x *CreateUserRequest) GetFullName() string
func (*CreateUserRequest) GetName ¶
func (x *CreateUserRequest) GetName() string
func (*CreateUserRequest) GetPassword ¶
func (x *CreateUserRequest) GetPassword() string
func (*CreateUserRequest) ProtoMessage ¶
func (*CreateUserRequest) ProtoMessage()
func (*CreateUserRequest) ProtoReflect ¶
func (x *CreateUserRequest) ProtoReflect() protoreflect.Message
func (*CreateUserRequest) Reset ¶
func (x *CreateUserRequest) Reset()
func (*CreateUserRequest) String ¶
func (x *CreateUserRequest) String() string
type CreateUserResponse ¶
type CreateUserResponse struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // contains filtered or unexported fields }
func (*CreateUserResponse) Descriptor
deprecated
func (*CreateUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateUserResponse.ProtoReflect.Descriptor instead.
func (*CreateUserResponse) GetUser ¶
func (x *CreateUserResponse) GetUser() *User
func (*CreateUserResponse) ProtoMessage ¶
func (*CreateUserResponse) ProtoMessage()
func (*CreateUserResponse) ProtoReflect ¶
func (x *CreateUserResponse) ProtoReflect() protoreflect.Message
func (*CreateUserResponse) Reset ¶
func (x *CreateUserResponse) Reset()
func (*CreateUserResponse) String ¶
func (x *CreateUserResponse) String() string
type LoginUserRequest ¶
type LoginUserRequest struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"` // contains filtered or unexported fields }
func (*LoginUserRequest) Descriptor
deprecated
func (*LoginUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use LoginUserRequest.ProtoReflect.Descriptor instead.
func (*LoginUserRequest) GetName ¶
func (x *LoginUserRequest) GetName() string
func (*LoginUserRequest) GetPassword ¶
func (x *LoginUserRequest) GetPassword() string
func (*LoginUserRequest) ProtoMessage ¶
func (*LoginUserRequest) ProtoMessage()
func (*LoginUserRequest) ProtoReflect ¶
func (x *LoginUserRequest) ProtoReflect() protoreflect.Message
func (*LoginUserRequest) Reset ¶
func (x *LoginUserRequest) Reset()
func (*LoginUserRequest) String ¶
func (x *LoginUserRequest) String() string
type LoginUserResponse ¶
type LoginUserResponse struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` SessionId string `protobuf:"bytes,2,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"` AccessToken string `protobuf:"bytes,3,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"` RefreshToken string `protobuf:"bytes,4,opt,name=refresh_token,json=refreshToken,proto3" json:"refresh_token,omitempty"` AccessTokenExpiresAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=access_token_expires_at,json=accessTokenExpiresAt,proto3" json:"access_token_expires_at,omitempty"` RefreshTokenExpiresAt *timestamppb.Timestamp `` /* 128-byte string literal not displayed */ // contains filtered or unexported fields }
func (*LoginUserResponse) Descriptor
deprecated
func (*LoginUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use LoginUserResponse.ProtoReflect.Descriptor instead.
func (*LoginUserResponse) GetAccessToken ¶
func (x *LoginUserResponse) GetAccessToken() string
func (*LoginUserResponse) GetAccessTokenExpiresAt ¶
func (x *LoginUserResponse) GetAccessTokenExpiresAt() *timestamppb.Timestamp
func (*LoginUserResponse) GetRefreshToken ¶
func (x *LoginUserResponse) GetRefreshToken() string
func (*LoginUserResponse) GetRefreshTokenExpiresAt ¶
func (x *LoginUserResponse) GetRefreshTokenExpiresAt() *timestamppb.Timestamp
func (*LoginUserResponse) GetSessionId ¶
func (x *LoginUserResponse) GetSessionId() string
func (*LoginUserResponse) GetUser ¶
func (x *LoginUserResponse) GetUser() *User
func (*LoginUserResponse) ProtoMessage ¶
func (*LoginUserResponse) ProtoMessage()
func (*LoginUserResponse) ProtoReflect ¶
func (x *LoginUserResponse) ProtoReflect() protoreflect.Message
func (*LoginUserResponse) Reset ¶
func (x *LoginUserResponse) Reset()
func (*LoginUserResponse) String ¶
func (x *LoginUserResponse) String() string
type SnippetboxClient ¶
type SnippetboxClient interface { CreateUser(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*CreateUserResponse, error) UpdateUser(ctx context.Context, in *UpdateUserRequest, opts ...grpc.CallOption) (*UpdateUserResponse, error) LoginUser(ctx context.Context, in *LoginUserRequest, opts ...grpc.CallOption) (*LoginUserResponse, error) }
SnippetboxClient is the client API for Snippetbox 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 NewSnippetboxClient ¶
func NewSnippetboxClient(cc grpc.ClientConnInterface) SnippetboxClient
type SnippetboxServer ¶
type SnippetboxServer interface { CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error) UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error) LoginUser(context.Context, *LoginUserRequest) (*LoginUserResponse, error) // contains filtered or unexported methods }
SnippetboxServer is the server API for Snippetbox service. All implementations must embed UnimplementedSnippetboxServer for forward compatibility
type UnimplementedSnippetboxServer ¶
type UnimplementedSnippetboxServer struct { }
UnimplementedSnippetboxServer must be embedded to have forward compatible implementations.
func (UnimplementedSnippetboxServer) CreateUser ¶
func (UnimplementedSnippetboxServer) CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error)
func (UnimplementedSnippetboxServer) LoginUser ¶
func (UnimplementedSnippetboxServer) LoginUser(context.Context, *LoginUserRequest) (*LoginUserResponse, error)
func (UnimplementedSnippetboxServer) UpdateUser ¶
func (UnimplementedSnippetboxServer) UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error)
type UnsafeSnippetboxServer ¶
type UnsafeSnippetboxServer interface {
// contains filtered or unexported methods
}
UnsafeSnippetboxServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SnippetboxServer will result in compilation errors.
type UpdateUserRequest ¶
type UpdateUserRequest struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` FullName *string `protobuf:"bytes,2,opt,name=full_name,json=fullName,proto3,oneof" json:"full_name,omitempty"` Email *string `protobuf:"bytes,3,opt,name=email,proto3,oneof" json:"email,omitempty"` Password *string `protobuf:"bytes,4,opt,name=password,proto3,oneof" json:"password,omitempty"` // contains filtered or unexported fields }
func (*UpdateUserRequest) Descriptor
deprecated
func (*UpdateUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateUserRequest.ProtoReflect.Descriptor instead.
func (*UpdateUserRequest) GetEmail ¶
func (x *UpdateUserRequest) GetEmail() string
func (*UpdateUserRequest) GetFullName ¶
func (x *UpdateUserRequest) GetFullName() string
func (*UpdateUserRequest) GetName ¶
func (x *UpdateUserRequest) GetName() string
func (*UpdateUserRequest) GetPassword ¶
func (x *UpdateUserRequest) GetPassword() string
func (*UpdateUserRequest) ProtoMessage ¶
func (*UpdateUserRequest) ProtoMessage()
func (*UpdateUserRequest) ProtoReflect ¶
func (x *UpdateUserRequest) ProtoReflect() protoreflect.Message
func (*UpdateUserRequest) Reset ¶
func (x *UpdateUserRequest) Reset()
func (*UpdateUserRequest) String ¶
func (x *UpdateUserRequest) String() string
type UpdateUserResponse ¶
type UpdateUserResponse struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // contains filtered or unexported fields }
func (*UpdateUserResponse) Descriptor
deprecated
func (*UpdateUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateUserResponse.ProtoReflect.Descriptor instead.
func (*UpdateUserResponse) GetUser ¶
func (x *UpdateUserResponse) GetUser() *User
func (*UpdateUserResponse) ProtoMessage ¶
func (*UpdateUserResponse) ProtoMessage()
func (*UpdateUserResponse) ProtoReflect ¶
func (x *UpdateUserResponse) ProtoReflect() protoreflect.Message
func (*UpdateUserResponse) Reset ¶
func (x *UpdateUserResponse) Reset()
func (*UpdateUserResponse) String ¶
func (x *UpdateUserResponse) String() string
type User ¶
type User struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` FullName string `protobuf:"bytes,2,opt,name=full_name,json=fullName,proto3" json:"full_name,omitempty"` Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"` PasswordChangedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=password_changed_at,json=passwordChangedAt,proto3" json:"password_changed_at,omitempty"` Created *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=created,proto3" json:"created,omitempty"` // contains filtered or unexported fields }
func (*User) Descriptor
deprecated
func (*User) GetCreated ¶
func (x *User) GetCreated() *timestamppb.Timestamp
func (*User) GetFullName ¶
func (*User) GetPasswordChangedAt ¶
func (x *User) GetPasswordChangedAt() *timestamppb.Timestamp
func (*User) ProtoMessage ¶
func (*User) ProtoMessage()
func (*User) ProtoReflect ¶
func (x *User) ProtoReflect() protoreflect.Message