aaa

Documentation

Overview

Package aaa provides Carrier WiFi related services

Index

• Constants
• func CreateSessionId() string
• type Session
• type SessionTable
• type TimeoutNotifier

Constants

const (
	MinimalSessionTimeout = time.Millisecond * 10
	DefaultSessionTimeout = time.Hour * 6
)

Functions

func CreateSessionId

func CreateSessionId() string

CreateSessionId creates & returns unique session ID string

Types

type Session

type Session interface {
	// Lock - locks the Session's mutex
	Lock()
	// Unlock - unlocks the Session's mutex
	Unlock()
	// GetCtx returns AAA Session Context
	GetCtx() *protos.Context
	// SetCtx sets AAA Session Context - must be called on a Locked session
	SetCtx(ctx *protos.Context)
	// StopTimeout - stops the session's timeout if possible, returns if the timeout was successfully stopped
	StopTimeout() bool
}

Session - struct to save an authenticated session state

type SessionTable

type SessionTable interface {
	// AddSession - adds a new session to the table & returns the newly created session pointer.
	// If a session with the same ID already is in the table - returns "Session with SID: XYZ already exist" as well as the
	// existing session.
	AddSession(pc *protos.Context, tout time.Duration, cb TimeoutNotifier, overwrite ...bool) (s Session, err error)
	// GetSession returns session corresponding to the given sid or nil if not found
	GetSession(sid string) (session Session)
	// FindSession returns session ID corresponding to the given IMSI (empty string if not found)
	FindSession(imsi string) (sessionId string)
	// GetSessionByImsi returns session corresponding to the given IMSI or nil if not found
	GetSessionByImsi(imsi string) (session Session)
	// RemoveSession - removes the session with the given SID and returns it, returns nil if not found
	RemoveSession(sid string) Session
	// SetTimeout - [Re]sets the session's cleanup timeout to fire after tout duration
	SetTimeout(sid string, tout time.Duration, callback TimeoutNotifier) bool
}

SessionTable - synchronized map of authenticated sessions

type TimeoutNotifier

type TimeoutNotifier func(Session) error

TimeoutNotifier is a callback function to be called on session timeout