Documentation
¶
Index ¶
- Constants
- Variables
- type Callback
- type CallbackError
- type CallbackName
- type Hash
- type Kind
- type Manager
- func (m *Manager) AddCallback(kind Kind, name CallbackName, fn func(ctx context.Context, t Token) error) error
- func (m *Manager) Checkin(ctx context.Context, hash Hash) error
- func (m *Manager) Cleanup(ctx context.Context) (err error)
- func (m *Manager) Create(ctx context.Context, k Kind, ttl time.Duration, checkins int32) (t Token, err error)
- func (m *Manager) Delete(ctx context.Context, t Token) error
- func (m *Manager) Get(ctx context.Context, hash Hash) (t Token, err error)
- func (m *Manager) GetCallback(name CallbackName) (*Callback, error)
- func (m *Manager) GetCallbacks(k Kind) []Callback
- func (m *Manager) Init() error
- func (m *Manager) List(k Kind) []Token
- func (m *Manager) Logger() *zap.Logger
- func (m *Manager) RemoveCallback(name CallbackName) error
- func (m *Manager) SetLogger(logger *zap.Logger) error
- func (m *Manager) Store() (Store, error)
- func (m *Manager) Validate() error
- type Store
- type Token
Constants ¶
const DefaultTTL = 1 * time.Hour
DefaultTTL defines the default token longevity duration from the moment of its creation
const Length = 32
Length total length in bytes (including prefix, id and random bytes)
Variables ¶
var ( ErrNilDatabase = errors.New("data is nil") ErrNilTokenStore = errors.New("token store is nil") ErrEmptyTokenHash = errors.New("token hash is empty") ErrTokenNotFound = errors.New("token not found") ErrTokenExpired = errors.New("token is expired") ErrTokenUsedUp = errors.New("token is all used up") ErrTokenDuplicateCallbackID = errors.New("token callback id is already registered") ErrTokenCallbackNotFound = errors.New("token callback not found") ErrNilTokenManager = errors.New("token manager is nil") ErrNothingChanged = errors.New("nothing changed") ErrDuplicateToken = errors.New("duplicate token") )
errors
Functions ¶
This section is empty.
Types ¶
type Callback ¶
type Callback struct {
Name CallbackName
Kind Kind
Function func(ctx context.Context, t Token) error
}
Callback is a function metadata
type CallbackError ¶
CallbackError represents an error which could be produced by callback
type CallbackName ¶
type CallbackName [32]byte
func NewCallbackName ¶
func NewCallbackName(s string) (name CallbackName)
func (CallbackName) Scan ¶
func (name CallbackName) Scan(data interface{}) error
type Kind ¶
type Kind uint16
ObjectKind represents the type of a token, used by a token container
type Manager ¶
type Manager struct {
// base context for the token callback call chain
BaseContext context.Context
sync.RWMutex
// contains filtered or unexported fields
}
userManager is a general-purpose token container
func NewManager ¶
NewManager returns an initialized token container
func (*Manager) AddCallback ¶
func (m *Manager) AddCallback(kind Kind, name CallbackName, fn func(ctx context.Context, t Token) error) error
AddCallback adds callback function to container's callstack to be called upon token checkins
func (*Manager) Cleanup ¶
Cleanup performs a full cleanup of the container by removing tokens which failed to pass validation
func (*Manager) Create ¶
func (m *Manager) Create(ctx context.Context, k Kind, ttl time.Duration, checkins int32) (t Token, err error)
Upsert initializes, registers and returns a new token
func (*Manager) GetCallback ¶
func (m *Manager) GetCallback(name CallbackName) (*Callback, error)
GetCallback returns a named callback if it exists
func (*Manager) GetCallbacks ¶
GetCallbacks returns callback stack by a given token kind
func (*Manager) RemoveCallback ¶
func (m *Manager) RemoveCallback(name CallbackName) error
RemoveCallback removes token callback by ObjectID, returns ErrTokenCallbackNotfound
type Store ¶
type Store interface {
Put(ctx context.Context, t Token) error
Get(ctx context.Context, hash Hash) (Token, error)
Delete(ctx context.Context, hash Hash) error
}
Store describes the token store contract interface
type Token ¶
type Token struct {
// the kind of operation this token is associated to
Kind Kind `db:"kind" json:"kind"`
// token string id
Hash Hash `db:"hash" json:"hash"`
// holds the initial checkin threshold number
CheckinTotal int32 `db:"checkin_total" json:"checkin_total"`
// holds how many checkins could be performed before it's void
CheckinRemainder int32 `db:"checkin_remainder" json:"checkin_remainder"`
// time when this token was created
CreatedAt time.Time `db:"created_at" json:"created_at"`
// denotes when this token becomes void and is removed
ExpireAt time.Time `db:"expire_at" json:"expire_at"`
}
Hash represents a general-purpose token NOTE: the token will expire after certain conditions are met i.e. after specific time or a set number of checkins TODO add complexity variations for different use cases, i.e. SMS code should be short
Source Files