session

type CacheDriver struct {
	Cache          *cache.Cache //Cache which stores token data
	Length         int
	PrefixMode     string
	TokenGenerater func(s *CacheDriver, prefix string) (token string, err error) //Token name generate func
}

type CacheDriverOption interface {
	ApplyTo(*CacheDriver) error
}

type CacheDriverOptionConfig struct {
	Cache      *cache.Cache
	Length     int
	PrefixMode string
}

type ClientDriver struct {
	Key              []byte                              //Crypt key
	TokenMarshaler   func(*ClientDriver, *Session) error //Marshler data to Session.token
	TokenUnmarshaler func(*ClientDriver, *Session) error //Unmarshler data from Session.token
}

type ClientDriverOption interface {
	ApplyTo(*ClientDriver) error
}

type ClientDriverOptionConfig struct {
	Key []byte
}

type ContextKey string

type Driver interface {
	GetSessionToken(ts *Session) (token string, err error)
	GenerateToken(owner string) (token string, err error)
	Load(v *Session) error
	Save(t *Session, ttl time.Duration) error
	Delete(token string) error
	Close() error
}

type Field struct {
	Store *Store
	Name  string
}

type Flag uint64

type Option interface {
	ApplyTo(*Store) error
}

type OptionConfig struct {
	Driver        Driver
	TokenLifetime time.Duration
}

type ResponseWriter interface {
	http.ResponseWriter
	http.Hijacker
}

type Session struct {
	ExpiredAt      int64 //Timestamp when the token expired.
	CreatedTime    int64 //Timestamp when the token created.
	LastActiveTime int64 //Timestamp when the token Last Active.

	Store *Store
	Nonce []byte
	Flag  Flag
	Mutex *sync.RWMutex //Read write mutex.
	// contains filtered or unexported fields
}

type Store struct {
	Driver               Driver
	Marshaler            cache.Marshaler
	TokenLifetime        time.Duration //Token initial expired time.Token life time can be refreshed when accessed if UpdateActiveInterval is greater than 0.
	TokenMaxLifetime     time.Duration //Token max life time.Token can't live more than TokenMaxLifetime if TokenMaxLifetime if greater than 0.
	TokenContextName     ContextKey    //Name in request context store the token  data.Default Session is "token".
	CookieName           string        //Cookie name used in CookieMiddleware.Default Session is "herb-session".
	CookiePath           string        //Cookie path used in cookieMiddleware.Default Session is "/".
	CookieSecure         bool          //Cookie secure value used in cookie middleware.
	AutoGenerate         bool          //Whether auto generate token when guset visit.Default Session is false.
	Mode                 string        //Mode used in auto install middleware.
	UpdateActiveInterval time.Duration //The interval between what token active time refreshed.If less than or equal to 0,the token life time will not be refreshed.
	DefaultSessionFlag   Flag          //Default flag when creating session.
}

type StoreConfig struct {
	DriverName                   string
	Marshaler                    string
	Mode                         string
	TokenLifetimeInHour          int64  //Token initial expired time in second.Token life time can be update when accessed if UpdateActiveInterval is greater than 0.
	TokenLifetimeInDay           int64  //Token initial expired time in day.Token life time can be update when accessed if UpdateActiveInterval is greater than 0.Skipped if  TokenLifetimeInHour is set.
	TokenMaxLifetimeInDay        int64  //Token max life time.Token can't live more than TokenMaxLifetime if TokenMaxLifetime if greater than 0.
	TokenContextName             string //Name in request context store the token  data.Default Session is "token".
	CookieName                   string //Cookie name used in CookieMiddleware.Default Session is "herb-session".
	CookiePath                   string //Cookie path used in cookieMiddleware.Default Session is "/".
	CookieSecure                 bool   //Cookie secure value used in cookie middleware.
	AutoGenerate                 bool   //Whether auto generate token when guset visit.Default Session is false.
	UpdateActiveIntervalInSecond int64  //The interval between who token active time update.If less than or equal to 0,the token life time will not be refreshed.
	DefaultSessionFlag           Flag   //Default flag when creating session.
	ClientStoreKey               string
	TokenPrefixMode              string
	TokenLength                  int
	Cache                        cache.OptionConfigMap
}