sessions

README

gin-sessions

WARNING

This repository contains code from

LICENSE of this repository: Copyright (c) 2023 The Gorilla Authors. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Documentation

Index

• func NewCookie(name, value string, options *Options) *http.Cookie
• func Save(c *gin.Context) error
• func SetCookieToContext(c *gin.Context, cookie *http.Cookie)
• type MultiError
  • func (m MultiError) Error() string
• type Options
• type Registry
  • func GetRegistry(c *gin.Context) *Registry
  • func (s *Registry) Get(store Store, name string) (session *Session, err error)
  • func (s *Registry) Save(c *gin.Context) error
• type Session
  • func NewSession(store Store, name string) *Session
  • func (s *Session) Name() string
  • func (s *Session) Save(c *gin.Context) error
  • func (s *Session) Store() Store
• type Store

Functions

func NewCookie

func NewCookie(name, value string, options *Options) *http.Cookie

func Save

func Save(c *gin.Context) error

func SetCookieToContext

func SetCookieToContext(c *gin.Context, cookie *http.Cookie)

Set httpCookie to gin.Context

Types

type MultiError

type MultiError []error

MultiError stores multiple errors.

Borrowed from the App Engine SDK.

func (MultiError) Error

func (m MultiError) Error() string

type Options

type Options struct {
	Path     string
	Domain   string
	MaxAge   int
	Secure   bool
	HttpOnly bool
}

type Registry

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

func GetRegistry

func GetRegistry(c *gin.Context) *Registry

func (*Registry) Get

func (s *Registry) Get(store Store, name string) (session *Session, err error)

func (*Registry) Save

func (s *Registry) Save(c *gin.Context) error

type Session

type Session struct {
	// ID should be generated by store
	ID string
	// User data of session
	Values  map[interface{}]interface{}
	Options *Options
	IsNew   bool
	// contains filtered or unexported fields
}

func NewSession

func NewSession(store Store, name string) *Session

func (*Session) Name

func (s *Session) Name() string

func (*Session) Save

func (s *Session) Save(c *gin.Context) error

func (*Session) Store

func (s *Session) Store() Store

type Store

type Store interface {
	// To return a cached session
	Get(c *gin.Context, name string) (*Session, error)

	// To create a new session
	New(c *gin.Context, name string) (*Session, error)

	// To save a changed session
	Save(c *gin.Context, s *Session) error

	// To delete a session
	Delete(c *gin.Context, s *Session) error
}