usermanager

Documentation

Index

• Constants
• Variables
• func MakeLocalManager(dbPath string, worldState common.WorldState) (*localManager, error)
• type APIRouter
  • func APIRouterOf(manager UserManager) *APIRouter
• type AuthorisationInfo
• type MaybeInt32
  • func JustInt32(v int32) MaybeInt32
• type MaybeInt64
  • func JustInt64(v int64) MaybeInt64
• type StatusResponse
• type StatusUpdate
• type UserInfo
• type UserManager
• type Voidmanager
  • func (v *Voidmanager) AuthenticateUser(bytes []byte) (int64, int64, error)
  • func (v *Voidmanager) AuthoriseNewSession(bytes []byte, info AuthorisationInfo) error
  • func (v *Voidmanager) DeleteUser(UID []byte) error
  • func (v *Voidmanager) GetUserInfo(UID []byte) (UserInfo, error)
  • func (v *Voidmanager) ListAllUsers() ([]UserInfo, error)
  • func (v *Voidmanager) UploadStatus(updates []StatusUpdate) ([]StatusResponse, error)
  • func (v *Voidmanager) WriteUserInfo(info UserInfo) error

Constants

const (
	TERMINATE = iota + 1
)

Variables

var ErrMangerIsVoid = errors.New("cannot perform operation with user manager as database path is not specified")

var ErrNoDownCredit = errors.New("No download credit left")

var ErrNoUpCredit = errors.New("No upload credit left")

var ErrSessionsCapReached = errors.New("Sessions cap has reached")

var ErrUserExpired = errors.New("User has expired")

var ErrUserNotFound = errors.New("UID does not correspond to a user")

Functions

func MakeLocalManager

func MakeLocalManager(dbPath string, worldState common.WorldState) (*localManager, error)

Types

type APIRouter

type APIRouter struct {
	*gmux.Router
	// contains filtered or unexported fields
}

func APIRouterOf

func APIRouterOf(manager UserManager) *APIRouter

type AuthorisationInfo

type AuthorisationInfo struct {
	NumExistingSessions int
}

type MaybeInt32

type MaybeInt32 *int32

func JustInt32

func JustInt32(v int32) MaybeInt32

type MaybeInt64

type MaybeInt64 *int64

func JustInt64

func JustInt64(v int64) MaybeInt64

type StatusResponse

type StatusResponse struct {
	UID     []byte
	Action  int
	Message string
}

type StatusUpdate

type StatusUpdate struct {
	UID        []byte
	Active     bool
	NumSession int

	UpUsage   int64
	DownUsage int64
	Timestamp int64
}

type UserInfo

type UserInfo struct {
	UID         []byte
	SessionsCap MaybeInt32
	UpRate      MaybeInt64
	DownRate    MaybeInt64
	UpCredit    MaybeInt64
	DownCredit  MaybeInt64
	ExpiryTime  MaybeInt64
}

type UserManager

type UserManager interface {
	AuthenticateUser([]byte) (int64, int64, error)
	AuthoriseNewSession([]byte, AuthorisationInfo) error
	UploadStatus([]StatusUpdate) ([]StatusResponse, error)
	ListAllUsers() ([]UserInfo, error)
	GetUserInfo(UID []byte) (UserInfo, error)
	WriteUserInfo(UserInfo) error
	DeleteUser(UID []byte) error
}

type Voidmanager

type Voidmanager struct{}

func (*Voidmanager) AuthenticateUser

func (v *Voidmanager) AuthenticateUser(bytes []byte) (int64, int64, error)

func (*Voidmanager) AuthoriseNewSession

func (v *Voidmanager) AuthoriseNewSession(bytes []byte, info AuthorisationInfo) error

func (*Voidmanager) DeleteUser

func (v *Voidmanager) DeleteUser(UID []byte) error

func (*Voidmanager) GetUserInfo

func (v *Voidmanager) GetUserInfo(UID []byte) (UserInfo, error)

func (*Voidmanager) ListAllUsers

func (v *Voidmanager) ListAllUsers() ([]UserInfo, error)

func (*Voidmanager) UploadStatus

func (v *Voidmanager) UploadStatus(updates []StatusUpdate) ([]StatusResponse, error)

func (*Voidmanager) WriteUserInfo

func (v *Voidmanager) WriteUserInfo(info UserInfo) error