transport

Documentation

Index

• Constants
• Variables
• type Options
• type Service
  • func New(options Options) *Service
  • func (s *Service) DeleteSessionFromResponse(w http.ResponseWriter) error
  • func (s *Service) FetchSessionIDFromRequest(r *http.Request) (string, error)
  • func (s *Service) SetSessionOnResponse(signedSessionID string, userSession *user.Session, w http.ResponseWriter) error
• type ServiceInterface

Constants

const (
	// DefaultCookieName is the default cookie name used
	DefaultCookieName = "session"
	// DefaultCookiePath is the default cookie path
	DefaultCookiePath = "/"
)

Variables

var ErrNoSessionOnRequest = errors.New("no session on request")

ErrNoSessionOnRequest is thrown when a session is not found on a request

Types

type Options

type Options struct {
	CookieName string
	CookiePath string
	HTTPOnly   bool
	Secure     bool
}

Options defines the behavior of the transport service

type Service

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

Service writes sessions on responseWriters and reads sessions from requests

func New

func New(options Options) *Service

New returns a new transport service

func (*Service) DeleteSessionFromResponse

func (s *Service) DeleteSessionFromResponse(w http.ResponseWriter) error

DeleteSessionFromResponse deletes a user session from a responseWriter

func (*Service) FetchSessionIDFromRequest

func (s *Service) FetchSessionIDFromRequest(r *http.Request) (string, error)

FetchSessionIDFromRequest retrieves a signed session id from a request

func (*Service) SetSessionOnResponse

func (s *Service) SetSessionOnResponse(signedSessionID string, userSession *user.Session, w http.ResponseWriter) error

SetSessionOnResponse sets a signed session id and a user session on a responseWriter

type ServiceInterface

type ServiceInterface interface {
	SetSessionOnResponse(session string, userSession *user.Session, w http.ResponseWriter) error
	DeleteSessionFromResponse(w http.ResponseWriter) error
	FetchSessionIDFromRequest(r *http.Request) (string, error)
}

ServiceInterface defines the methods performed by the transport service