ffs

Documentation

Index

• Constants
• type Clan_t
• type Error
  • func (e Error) Error() string
• type Option
  • func WithPath(path string) Option
• type Report_t
• type Session_t
  • func (sess Session_t) IsAuthenticated() bool
• type Store
  • func New(options ...Option) (*Store, error)
  • func (s *Store) Close() error
  • func (s *Store) CreateSession(clan, magicKey string) (Session_t, error)
  • func (s *Store) DeleteSession(sid string) error
  • func (s *Store) GetClan(uid int64) (Clan_t, error)
  • func (s *Store) GetClans(id string) ([]string, error)
  • func (s *Store) GetSession(r *http.Request) Session_t
• type Turn_t
• type Unit_t

Constants

const (
	ErrCreateSchema        = Error("create schema")
	ErrCreateMeta          = Error("create metadata")
	ErrDatabaseExists      = Error("database exists")
	ErrForeignKeysDisabled = Error("foreign keys disabled")
	ErrInvalidPath         = Error("invalid path")
	ErrPragmaReturnedNil   = Error("pragma returned nil")
)

Types

type Clan_t

type Clan_t struct {
	Id    string    // id of the player's clan
	Turns []*Turn_t // list of turns that the clan has uploaded reports for
}

type Error

type Error string

func (Error) Error

func (e Error) Error() string

type Option

type Option func(*Store) error

func WithPath

func WithPath(path string) Option

type Report_t

type Report_t struct {
	Id    int64    // id of the report from the database table
	Clan  string   // id of the clan that owns the report
	Units []Unit_t // list of units included in this report
	Path  string   // path to the report file
	Map   string   // path to the map, only set when there is a map file
}

type Session_t

type Session_t struct {
	Id        string
	Uid       int64
	Clan      string
	ExpiresAt time.Time
}

func (Session_t) IsAuthenticated

func (sess Session_t) IsAuthenticated() bool

type Store

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

func New

func New(options ...Option) (*Store, error)

func (*Store) Close

func (s *Store) Close() error

func (*Store) CreateSession

func (s *Store) CreateSession(clan, magicKey string) (Session_t, error)

func (*Store) DeleteSession

func (s *Store) DeleteSession(sid string) error

func (*Store) GetClan

func (s *Store) GetClan(uid int64) (Clan_t, error)

func (*Store) GetClans

func (s *Store) GetClans(id string) ([]string, error)

func (*Store) GetSession

func (s *Store) GetSession(r *http.Request) Session_t

type Turn_t

type Turn_t struct {
	Id      string
	Reports []*Report_t // list of reports that the clan has uploaded for this turn
}

type Unit_t

type Unit_t struct {
	Id          string
	CurrentHex  string
	PreviousHex string
}