server/beego
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(session): fix session doc (#5687)

Browse Source
This commit is contained in:
Alan Xu 2024-08-02 12:43:36 +08:00 committed by GitHub
parent 06d869664a
commit d269d74cd2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
server/web/session/README.md
View File

@ -84,17 +84,19 @@ Finally in the handlerfunc you can use it like this
When you develop a web app, maybe you want to write own provider because you must meet the requirements. When you develop a web app, maybe you want to write own provider because you must meet the requirements.
Writing a provider is easy. You only need to define two struct types Writing a provider is easy. You only need to define two struct types
(Session and Provider), which satisfy the interface definition. Maybe you will find the **memory** provider is a good (Store and Provider), which satisfy the interface definition. Maybe you will find the **memory** provider is a good
example. example.
type SessionStore interface { // Store contains all data for one session process with specific id.
Set(key, value interface{}) error //set session value type Store interface {
Get(key interface{}) interface{} //get session value Set(ctx context.Context, key, value interface{}) error // Set set session value
Delete(key interface{}) error //delete session value Get(ctx context.Context, key interface{}) interface{} // Get get session value
SessionID() string //back current sessionID Delete(ctx context.Context, key interface{}) error // Delete delete session value
SessionRelease(w http.ResponseWriter) // release the resource & save data to provider & return the data SessionID(ctx context.Context) string // SessionID return current sessionID
Flush() error //delete all data SessionReleaseIfPresent(ctx context.Context, w http.ResponseWriter) // SessionReleaseIfPresent release the resource & save data to provider & return the data when the session is present, not all implementation support this feature, you need to check if the specific implementation if support this feature.
} SessionRelease(ctx context.Context, w http.ResponseWriter) // SessionRelease release the resource & save data to provider & return the data
Flush(ctx context.Context) error // Flush delete all data
}
type Provider interface { type Provider interface {
SessionInit(gclifetime int64, config string) error SessionInit(gclifetime int64, config string) error