usermanager

Documentation

Overview

Package usermanager provides a service for user management.

Index

• type Quota
• type User
  • func NewUser(userInfo models.UserInfo, quota Quota) *User
  • func (u *User) RequestQuota() error
• type UserInformer
• type UserList
• type UserManager
  • func NewUserManager(informer UserInformer, quotaCfg definition.Quota, users UserList) *UserManager
  • func (um *UserManager) CreateUser(userID string) (*User, error)
  • func (um *UserManager) Users() UserList
• type UserSession

Types

type Quota

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

Quota defines a user quota for requests.

type User

type User struct {
	UserInfo models.UserInfo
	Session  UserSession
}

User defines user info and session.

func NewUser

func NewUser(userInfo models.UserInfo, quota Quota) *User

NewUser creates a new User.

func (*User) RequestQuota

func (u *User) RequestQuota() error

RequestQuota checks a user request limit.

type UserInformer

type UserInformer interface {
	GetUserInfo(userID string) (models.UserInfo, error)
}

UserInformer defines an interface for getting user info.

type UserList

type UserList map[string]*User // UID -> UserInfo.

UserList represents map of users stored in UserManager.

type UserManager

type UserManager struct {
	UserInformer UserInformer
	QuotaConfig  definition.Quota
	// contains filtered or unexported fields
}

UserManager defines a user manager service.

func NewUserManager

func NewUserManager(informer UserInformer, quotaCfg definition.Quota, users UserList) *UserManager

NewUserManager creates a new user manager.

func (*UserManager) CreateUser

func (um *UserManager) CreateUser(userID string) (*User, error)

CreateUser creates a new user.

func (*UserManager) Users

func (um *UserManager) Users() UserList

Users returns all users.

type UserSession

type UserSession struct {
	PlatformSessionID string
	ChannelID         string
	Direct            bool

	Quota Quota

	LastActionTs time.Time
	IdleInterval uint

	Clone           *dblabmodels.Clone
	ConnParams      models.Clone
	Pool            *pgxpool.Pool `json:"-"`
	CloneConnection *pgx.Conn     `json:"-"`
	DBVersion       int           `json:"-"`
}

UserSession defines a user session.