Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterAuthServer(s grpc.ServiceRegistrar, srv AuthServer)
- type AuthClient
- type AuthServer
- type ForceLogoutReq
- func (x *ForceLogoutReq) Check() error
- func (*ForceLogoutReq) Descriptor() ([]byte, []int)deprecated
- func (x *ForceLogoutReq) GetPlatformID() int32
- func (x *ForceLogoutReq) GetUserID() string
- func (*ForceLogoutReq) ProtoMessage()
- func (x *ForceLogoutReq) ProtoReflect() protoreflect.Message
- func (x *ForceLogoutReq) Reset()
- func (x *ForceLogoutReq) String() string
- type ForceLogoutResp
- type GetUserTokenReq
- func (x *GetUserTokenReq) Check() error
- func (*GetUserTokenReq) Descriptor() ([]byte, []int)deprecated
- func (x *GetUserTokenReq) GetPlatformID() int32
- func (x *GetUserTokenReq) GetUserID() string
- func (*GetUserTokenReq) ProtoMessage()
- func (x *GetUserTokenReq) ProtoReflect() protoreflect.Message
- func (x *GetUserTokenReq) Reset()
- func (x *GetUserTokenReq) String() string
- type GetUserTokenResp
- func (*GetUserTokenResp) Descriptor() ([]byte, []int)deprecated
- func (x *GetUserTokenResp) GetExpireTimeSeconds() int64
- func (x *GetUserTokenResp) GetToken() string
- func (*GetUserTokenResp) ProtoMessage()
- func (x *GetUserTokenResp) ProtoReflect() protoreflect.Message
- func (x *GetUserTokenResp) Reset()
- func (x *GetUserTokenResp) String() string
- type InvalidateTokenReq
- func (*InvalidateTokenReq) Descriptor() ([]byte, []int)deprecated
- func (x *InvalidateTokenReq) GetPlatformID() int32
- func (x *InvalidateTokenReq) GetPreservedToken() string
- func (x *InvalidateTokenReq) GetUserID() string
- func (*InvalidateTokenReq) ProtoMessage()
- func (x *InvalidateTokenReq) ProtoReflect() protoreflect.Message
- func (x *InvalidateTokenReq) Reset()
- func (x *InvalidateTokenReq) String() string
- type InvalidateTokenResp
- type ParseTokenReq
- func (x *ParseTokenReq) Check() error
- func (*ParseTokenReq) Descriptor() ([]byte, []int)deprecated
- func (x *ParseTokenReq) GetToken() string
- func (*ParseTokenReq) ProtoMessage()
- func (x *ParseTokenReq) ProtoReflect() protoreflect.Message
- func (x *ParseTokenReq) Reset()
- func (x *ParseTokenReq) String() string
- type ParseTokenResp
- func (*ParseTokenResp) Descriptor() ([]byte, []int)deprecated
- func (x *ParseTokenResp) GetExpireTimeSeconds() int64
- func (x *ParseTokenResp) GetPlatformID() int32
- func (x *ParseTokenResp) GetUserID() string
- func (*ParseTokenResp) ProtoMessage()
- func (x *ParseTokenResp) ProtoReflect() protoreflect.Message
- func (x *ParseTokenResp) Reset()
- func (x *ParseTokenResp) String() string
- type UnimplementedAuthServer
- func (UnimplementedAuthServer) ForceLogout(context.Context, *ForceLogoutReq) (*ForceLogoutResp, error)
- func (UnimplementedAuthServer) GetUserToken(context.Context, *GetUserTokenReq) (*GetUserTokenResp, error)
- func (UnimplementedAuthServer) InvalidateToken(context.Context, *InvalidateTokenReq) (*InvalidateTokenResp, error)
- func (UnimplementedAuthServer) ParseToken(context.Context, *ParseTokenReq) (*ParseTokenResp, error)
- func (UnimplementedAuthServer) UserToken(context.Context, *UserTokenReq) (*UserTokenResp, error)
- type UnsafeAuthServer
- type UserTokenReq
- func (x *UserTokenReq) Check() error
- func (*UserTokenReq) Descriptor() ([]byte, []int)deprecated
- func (x *UserTokenReq) GetPlatformID() int32
- func (x *UserTokenReq) GetSecret() string
- func (x *UserTokenReq) GetUserID() string
- func (*UserTokenReq) ProtoMessage()
- func (x *UserTokenReq) ProtoReflect() protoreflect.Message
- func (x *UserTokenReq) Reset()
- func (x *UserTokenReq) String() string
- type UserTokenResp
- func (*UserTokenResp) Descriptor() ([]byte, []int)deprecated
- func (x *UserTokenResp) GetExpireTimeSeconds() int64
- func (x *UserTokenResp) GetToken() string
- func (*UserTokenResp) ProtoMessage()
- func (x *UserTokenResp) ProtoReflect() protoreflect.Message
- func (x *UserTokenResp) Reset()
- func (x *UserTokenResp) String() string
Constants ¶
const ( Auth_UserToken_FullMethodName = "/openim.auth.Auth/userToken" Auth_GetUserToken_FullMethodName = "/openim.auth.Auth/getUserToken" Auth_ForceLogout_FullMethodName = "/openim.auth.Auth/forceLogout" Auth_ParseToken_FullMethodName = "/openim.auth.Auth/parseToken" Auth_InvalidateToken_FullMethodName = "/openim.auth.Auth/invalidateToken" )
Variables ¶
var Auth_ServiceDesc = grpc.ServiceDesc{ ServiceName: "openim.auth.Auth", HandlerType: (*AuthServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "userToken", Handler: _Auth_UserToken_Handler, }, { MethodName: "getUserToken", Handler: _Auth_GetUserToken_Handler, }, { MethodName: "forceLogout", Handler: _Auth_ForceLogout_Handler, }, { MethodName: "parseToken", Handler: _Auth_ParseToken_Handler, }, { MethodName: "invalidateToken", Handler: _Auth_InvalidateToken_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "auth/auth.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)
var File_auth_auth_proto protoreflect.FileDescriptor
Functions ¶
func RegisterAuthServer ¶
func RegisterAuthServer(s grpc.ServiceRegistrar, srv AuthServer)
Types ¶
type AuthClient ¶
type AuthClient interface { // Generate token UserToken(ctx context.Context, in *UserTokenReq, opts ...grpc.CallOption) (*UserTokenResp, error) // Admin retrieves user token GetUserToken(ctx context.Context, in *GetUserTokenReq, opts ...grpc.CallOption) (*GetUserTokenResp, error) // Force logout ForceLogout(ctx context.Context, in *ForceLogoutReq, opts ...grpc.CallOption) (*ForceLogoutResp, error) // Parse token ParseToken(ctx context.Context, in *ParseTokenReq, opts ...grpc.CallOption) (*ParseTokenResp, error) // Invalidate or mark the token as kicked out InvalidateToken(ctx context.Context, in *InvalidateTokenReq, opts ...grpc.CallOption) (*InvalidateTokenResp, 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 { // Generate token UserToken(context.Context, *UserTokenReq) (*UserTokenResp, error) // Admin retrieves user token GetUserToken(context.Context, *GetUserTokenReq) (*GetUserTokenResp, error) // Force logout ForceLogout(context.Context, *ForceLogoutReq) (*ForceLogoutResp, error) // Parse token ParseToken(context.Context, *ParseTokenReq) (*ParseTokenResp, error) // Invalidate or mark the token as kicked out InvalidateToken(context.Context, *InvalidateTokenReq) (*InvalidateTokenResp, error) }
AuthServer is the server API for Auth service. All implementations should embed UnimplementedAuthServer for forward compatibility.
type ForceLogoutReq ¶
type ForceLogoutReq struct { PlatformID int32 `protobuf:"varint,1,opt,name=platformID,proto3" json:"platformID"` UserID string `protobuf:"bytes,2,opt,name=userID,proto3" json:"userID"` // contains filtered or unexported fields }
func (*ForceLogoutReq) Check ¶
func (x *ForceLogoutReq) Check() error
func (*ForceLogoutReq) Descriptor
deprecated
func (*ForceLogoutReq) Descriptor() ([]byte, []int)
Deprecated: Use ForceLogoutReq.ProtoReflect.Descriptor instead.
func (*ForceLogoutReq) GetPlatformID ¶
func (x *ForceLogoutReq) GetPlatformID() int32
func (*ForceLogoutReq) GetUserID ¶
func (x *ForceLogoutReq) GetUserID() string
func (*ForceLogoutReq) ProtoMessage ¶
func (*ForceLogoutReq) ProtoMessage()
func (*ForceLogoutReq) ProtoReflect ¶
func (x *ForceLogoutReq) ProtoReflect() protoreflect.Message
func (*ForceLogoutReq) Reset ¶
func (x *ForceLogoutReq) Reset()
func (*ForceLogoutReq) String ¶
func (x *ForceLogoutReq) String() string
type ForceLogoutResp ¶
type ForceLogoutResp struct {
// contains filtered or unexported fields
}
func (*ForceLogoutResp) Descriptor
deprecated
func (*ForceLogoutResp) Descriptor() ([]byte, []int)
Deprecated: Use ForceLogoutResp.ProtoReflect.Descriptor instead.
func (*ForceLogoutResp) ProtoMessage ¶
func (*ForceLogoutResp) ProtoMessage()
func (*ForceLogoutResp) ProtoReflect ¶
func (x *ForceLogoutResp) ProtoReflect() protoreflect.Message
func (*ForceLogoutResp) Reset ¶
func (x *ForceLogoutResp) Reset()
func (*ForceLogoutResp) String ¶
func (x *ForceLogoutResp) String() string
type GetUserTokenReq ¶
type GetUserTokenReq struct { PlatformID int32 `protobuf:"varint,1,opt,name=platformID,proto3" json:"platformID"` UserID string `protobuf:"bytes,2,opt,name=userID,proto3" json:"userID"` // contains filtered or unexported fields }
func (*GetUserTokenReq) Check ¶
func (x *GetUserTokenReq) Check() error
func (*GetUserTokenReq) Descriptor
deprecated
func (*GetUserTokenReq) Descriptor() ([]byte, []int)
Deprecated: Use GetUserTokenReq.ProtoReflect.Descriptor instead.
func (*GetUserTokenReq) GetPlatformID ¶
func (x *GetUserTokenReq) GetPlatformID() int32
func (*GetUserTokenReq) GetUserID ¶
func (x *GetUserTokenReq) GetUserID() string
func (*GetUserTokenReq) ProtoMessage ¶
func (*GetUserTokenReq) ProtoMessage()
func (*GetUserTokenReq) ProtoReflect ¶
func (x *GetUserTokenReq) ProtoReflect() protoreflect.Message
func (*GetUserTokenReq) Reset ¶
func (x *GetUserTokenReq) Reset()
func (*GetUserTokenReq) String ¶
func (x *GetUserTokenReq) String() string
type GetUserTokenResp ¶
type GetUserTokenResp struct { Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token"` ExpireTimeSeconds int64 `protobuf:"varint,2,opt,name=expireTimeSeconds,proto3" json:"expireTimeSeconds"` // contains filtered or unexported fields }
func (*GetUserTokenResp) Descriptor
deprecated
func (*GetUserTokenResp) Descriptor() ([]byte, []int)
Deprecated: Use GetUserTokenResp.ProtoReflect.Descriptor instead.
func (*GetUserTokenResp) GetExpireTimeSeconds ¶
func (x *GetUserTokenResp) GetExpireTimeSeconds() int64
func (*GetUserTokenResp) GetToken ¶
func (x *GetUserTokenResp) GetToken() string
func (*GetUserTokenResp) ProtoMessage ¶
func (*GetUserTokenResp) ProtoMessage()
func (*GetUserTokenResp) ProtoReflect ¶
func (x *GetUserTokenResp) ProtoReflect() protoreflect.Message
func (*GetUserTokenResp) Reset ¶
func (x *GetUserTokenResp) Reset()
func (*GetUserTokenResp) String ¶
func (x *GetUserTokenResp) String() string
type InvalidateTokenReq ¶
type InvalidateTokenReq struct { PreservedToken string `protobuf:"bytes,1,opt,name=preservedToken,proto3" json:"preservedToken"` UserID string `protobuf:"bytes,2,opt,name=userID,proto3" json:"userID"` PlatformID int32 `protobuf:"varint,3,opt,name=platformID,proto3" json:"platformID"` // contains filtered or unexported fields }
func (*InvalidateTokenReq) Descriptor
deprecated
func (*InvalidateTokenReq) Descriptor() ([]byte, []int)
Deprecated: Use InvalidateTokenReq.ProtoReflect.Descriptor instead.
func (*InvalidateTokenReq) GetPlatformID ¶
func (x *InvalidateTokenReq) GetPlatformID() int32
func (*InvalidateTokenReq) GetPreservedToken ¶
func (x *InvalidateTokenReq) GetPreservedToken() string
func (*InvalidateTokenReq) GetUserID ¶
func (x *InvalidateTokenReq) GetUserID() string
func (*InvalidateTokenReq) ProtoMessage ¶
func (*InvalidateTokenReq) ProtoMessage()
func (*InvalidateTokenReq) ProtoReflect ¶
func (x *InvalidateTokenReq) ProtoReflect() protoreflect.Message
func (*InvalidateTokenReq) Reset ¶
func (x *InvalidateTokenReq) Reset()
func (*InvalidateTokenReq) String ¶
func (x *InvalidateTokenReq) String() string
type InvalidateTokenResp ¶
type InvalidateTokenResp struct {
// contains filtered or unexported fields
}
func (*InvalidateTokenResp) Descriptor
deprecated
func (*InvalidateTokenResp) Descriptor() ([]byte, []int)
Deprecated: Use InvalidateTokenResp.ProtoReflect.Descriptor instead.
func (*InvalidateTokenResp) ProtoMessage ¶
func (*InvalidateTokenResp) ProtoMessage()
func (*InvalidateTokenResp) ProtoReflect ¶
func (x *InvalidateTokenResp) ProtoReflect() protoreflect.Message
func (*InvalidateTokenResp) Reset ¶
func (x *InvalidateTokenResp) Reset()
func (*InvalidateTokenResp) String ¶
func (x *InvalidateTokenResp) String() string
type ParseTokenReq ¶
type ParseTokenReq struct { Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token"` // contains filtered or unexported fields }
func (*ParseTokenReq) Check ¶
func (x *ParseTokenReq) Check() error
func (*ParseTokenReq) Descriptor
deprecated
func (*ParseTokenReq) Descriptor() ([]byte, []int)
Deprecated: Use ParseTokenReq.ProtoReflect.Descriptor instead.
func (*ParseTokenReq) GetToken ¶
func (x *ParseTokenReq) GetToken() string
func (*ParseTokenReq) ProtoMessage ¶
func (*ParseTokenReq) ProtoMessage()
func (*ParseTokenReq) ProtoReflect ¶
func (x *ParseTokenReq) ProtoReflect() protoreflect.Message
func (*ParseTokenReq) Reset ¶
func (x *ParseTokenReq) Reset()
func (*ParseTokenReq) String ¶
func (x *ParseTokenReq) String() string
type ParseTokenResp ¶
type ParseTokenResp struct { UserID string `protobuf:"bytes,1,opt,name=userID,proto3" json:"userID"` PlatformID int32 `protobuf:"varint,2,opt,name=platformID,proto3" json:"platformID"` ExpireTimeSeconds int64 `protobuf:"varint,4,opt,name=expireTimeSeconds,proto3" json:"expireTimeSeconds"` // contains filtered or unexported fields }
func (*ParseTokenResp) Descriptor
deprecated
func (*ParseTokenResp) Descriptor() ([]byte, []int)
Deprecated: Use ParseTokenResp.ProtoReflect.Descriptor instead.
func (*ParseTokenResp) GetExpireTimeSeconds ¶
func (x *ParseTokenResp) GetExpireTimeSeconds() int64
func (*ParseTokenResp) GetPlatformID ¶
func (x *ParseTokenResp) GetPlatformID() int32
func (*ParseTokenResp) GetUserID ¶
func (x *ParseTokenResp) GetUserID() string
func (*ParseTokenResp) ProtoMessage ¶
func (*ParseTokenResp) ProtoMessage()
func (*ParseTokenResp) ProtoReflect ¶
func (x *ParseTokenResp) ProtoReflect() protoreflect.Message
func (*ParseTokenResp) Reset ¶
func (x *ParseTokenResp) Reset()
func (*ParseTokenResp) String ¶
func (x *ParseTokenResp) String() string
type UnimplementedAuthServer ¶
type UnimplementedAuthServer struct{}
UnimplementedAuthServer should 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) ForceLogout ¶
func (UnimplementedAuthServer) ForceLogout(context.Context, *ForceLogoutReq) (*ForceLogoutResp, error)
func (UnimplementedAuthServer) GetUserToken ¶
func (UnimplementedAuthServer) GetUserToken(context.Context, *GetUserTokenReq) (*GetUserTokenResp, error)
func (UnimplementedAuthServer) InvalidateToken ¶
func (UnimplementedAuthServer) InvalidateToken(context.Context, *InvalidateTokenReq) (*InvalidateTokenResp, error)
func (UnimplementedAuthServer) ParseToken ¶
func (UnimplementedAuthServer) ParseToken(context.Context, *ParseTokenReq) (*ParseTokenResp, error)
func (UnimplementedAuthServer) UserToken ¶
func (UnimplementedAuthServer) UserToken(context.Context, *UserTokenReq) (*UserTokenResp, 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.
type UserTokenReq ¶
type UserTokenReq struct { Secret string `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret"` PlatformID int32 `protobuf:"varint,2,opt,name=platformID,proto3" json:"platformID"` UserID string `protobuf:"bytes,3,opt,name=userID,proto3" json:"userID"` // contains filtered or unexported fields }
func (*UserTokenReq) Check ¶
func (x *UserTokenReq) Check() error
func (*UserTokenReq) Descriptor
deprecated
func (*UserTokenReq) Descriptor() ([]byte, []int)
Deprecated: Use UserTokenReq.ProtoReflect.Descriptor instead.
func (*UserTokenReq) GetPlatformID ¶
func (x *UserTokenReq) GetPlatformID() int32
func (*UserTokenReq) GetSecret ¶
func (x *UserTokenReq) GetSecret() string
func (*UserTokenReq) GetUserID ¶
func (x *UserTokenReq) GetUserID() string
func (*UserTokenReq) ProtoMessage ¶
func (*UserTokenReq) ProtoMessage()
func (*UserTokenReq) ProtoReflect ¶
func (x *UserTokenReq) ProtoReflect() protoreflect.Message
func (*UserTokenReq) Reset ¶
func (x *UserTokenReq) Reset()
func (*UserTokenReq) String ¶
func (x *UserTokenReq) String() string
type UserTokenResp ¶
type UserTokenResp struct { Token string `protobuf:"bytes,2,opt,name=token,proto3" json:"token"` ExpireTimeSeconds int64 `protobuf:"varint,3,opt,name=expireTimeSeconds,proto3" json:"expireTimeSeconds"` // contains filtered or unexported fields }
func (*UserTokenResp) Descriptor
deprecated
func (*UserTokenResp) Descriptor() ([]byte, []int)
Deprecated: Use UserTokenResp.ProtoReflect.Descriptor instead.
func (*UserTokenResp) GetExpireTimeSeconds ¶
func (x *UserTokenResp) GetExpireTimeSeconds() int64
func (*UserTokenResp) GetToken ¶
func (x *UserTokenResp) GetToken() string
func (*UserTokenResp) ProtoMessage ¶
func (*UserTokenResp) ProtoMessage()
func (*UserTokenResp) ProtoReflect ¶
func (x *UserTokenResp) ProtoReflect() protoreflect.Message
func (*UserTokenResp) Reset ¶
func (x *UserTokenResp) Reset()
func (*UserTokenResp) String ¶
func (x *UserTokenResp) String() string