engine

README

Session

Middleware support for echo, utilizing by admpub/sessions.

Installation

go get github.com/webx-top/echo

Usage

package main

import (
    "github.com/webx-top/echo"
    "github.com/webx-top/echo/engine/standard"
    "github.com/webx-top/echo/middleware/session"
    cookieStore "github.com/webx-top/echo/middleware/session/engine/cookie"
)

func index(c echo.Context) error {
    session := c.Session()

    var count int
    v := session.Get("count")

    if v == nil {
        count = 0
    } else {
        count = v.(int)
        count += 1
    }

    session.Set("count", count)

    data := struct {
        Visit int
    }{
        Visit: count,
    }

    return c.JSON(http.StatusOK, data)
}

func main() {
    sessionOptions:=&echo.SessionOptions{
        Name:   `GOSESSIONID`,
        Engine: `cookie`,
        CookieOptions: &echo.CookieOptions{
            Path:     `/`,
            HttpOnly: true,
        },
    }
    cookieStore.RegWithOptions(&cookieStore.CookieOptions{
        KeyPairs: [][]byte{
            []byte("secret-key"),
        },
        SessionOptions: sessionOptions,
    })

    e := echo.New()

    // Attach middleware
    e.Use(session.Middleware(sessionOptions))

    // Routes
    e.Get("/", index)

    e.Run(standard.New(":8080"))
}

Documentation

Index

• Constants
• Variables
• func Del(name string)
• func Exists(name string) bool
• func GenerateSessionID(prefix ...string) string
• func Get(name string) sessions.Store
• func NewMySession(store sessions.Store, name string, ctx echo.Context) echo.Sessioner
• func NewSession(ctx echo.Context) echo.Sessioner
• func Reg(name string, store sessions.Store)
• func StoreEngine(options *echo.SessionOptions) (store sessions.Store)
• type Closer
• type Session
  • func (s *Session) AddFlash(value interface{}, vars ...string) echo.Sessioner
  • func (s *Session) AddPreSaveHook(hook func(echo.Context) error)
  • func (s *Session) Clear() echo.Sessioner
  • func (s *Session) Delete(key string) echo.Sessioner
  • func (s *Session) Flashes(vars ...string) []interface{}
  • func (s *Session) Get(key string) interface{}
  • func (s *Session) ID() string
  • func (s *Session) MustID() string
  • func (s *Session) RemoveID(sessionID string) error
  • func (s *Session) Save() error
  • func (s *Session) Session() *sessions.Session
  • func (s *Session) Set(key string, val interface{}) echo.Sessioner
  • func (s *Session) SetID(id string, notReload ...bool) error
  • func (s *Session) SetPreSaveHook(hooks ...func(echo.Context) error)
  • func (s *Session) Written() bool
• type Stores
  • func (s *Stores) Del(name string)
  • func (s *Stores) Exists(name string) bool
  • func (s *Stores) Get(name string) sessions.Store
  • func (s *Stores) Set(name string, store sessions.Store)

Constants

const (
	DefaultMaxAge = 86400 * 30 // 30days
)

Defaults for sessions.Options

Variables

var ErrInvalidSessionID = errors.New("invalid session ID")

Functions

func Del

func Del(name string)

func Exists

func Exists(name string) bool

func GenerateSessionID

func GenerateSessionID(prefix ...string) string

func Get

func Get(name string) sessions.Store

func NewMySession

func NewMySession(store sessions.Store, name string, ctx echo.Context) echo.Sessioner

func NewSession

func NewSession(ctx echo.Context) echo.Sessioner

func Reg

func Reg(name string, store sessions.Store)

func StoreEngine

func StoreEngine(options *echo.SessionOptions) (store sessions.Store)

Types

type Closer

type Closer interface {
	Close() error
}

type Session

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

func (*Session) AddFlash

func (s *Session) AddFlash(value interface{}, vars ...string) echo.Sessioner

func (*Session) AddPreSaveHook

func (s *Session) AddPreSaveHook(hook func(echo.Context) error)

func (*Session) Clear

func (s *Session) Clear() echo.Sessioner

func (*Session) Delete

func (s *Session) Delete(key string) echo.Sessioner

func (*Session) Flashes

func (s *Session) Flashes(vars ...string) []interface{}

func (*Session) Get

func (s *Session) Get(key string) interface{}

func (*Session) ID

func (s *Session) ID() string

func (*Session) MustID

func (s *Session) MustID() string

func (*Session) RemoveID

func (s *Session) RemoveID(sessionID string) error

func (*Session) Save

func (s *Session) Save() error

func (*Session) Session

func (s *Session) Session() *sessions.Session

func (*Session) Set

func (s *Session) Set(key string, val interface{}) echo.Sessioner

func (*Session) SetID

func (s *Session) SetID(id string, notReload ...bool) error

func (*Session) SetPreSaveHook

func (s *Session) SetPreSaveHook(hooks ...func(echo.Context) error)

func (*Session) Written

func (s *Session) Written() bool

type Stores

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

func (*Stores) Del

func (s *Stores) Del(name string)

func (*Stores) Exists

func (s *Stores) Exists(name string) bool

func (*Stores) Get

func (s *Stores) Get(name string) sessions.Store

func (*Stores) Set

func (s *Stores) Set(name string, store sessions.Store)