hiscore

Documentation

Overview

Hiscore package implements the communication between a Gopher2600 high-score server and the local client. It is a proof-of-concept and is not yet fully defined.

Index

• func Login(input io.Reader, output io.Writer, username string) error
• func Logoff() error
• func SetServer(input io.Reader, output io.Writer, server string) error
• type Preferences
  • func (p *Preferences) Load() error
  • func (p *Preferences) Save() error
  • func (p *Preferences) String() string
• type Session
  • func NewSession() (*Session, error)
  • func (sess *Session) EndSession(playTime time.Duration) error
  • func (sess *Session) StartSession(name string, hash string) error

Functions

func Login

func Login(input io.Reader, output io.Writer, username string) error

Login prepares the authentication token for the hiscore server.

func Logoff

func Logoff() error

Logoff forgets the authentication token for the hiscore server.

func SetServer

func SetServer(input io.Reader, output io.Writer, server string) error

SetServer to use for hiscore storage.

Types

type Preferences

type Preferences struct {
	AuthToken prefs.String
	Server    prefs.String
	// contains filtered or unexported fields
}

func (*Preferences) Load

func (p *Preferences) Load() error

Load hiscore preferences from disk.

func (*Preferences) Save

func (p *Preferences) Save() error

Save current hiscore preferences to disk.

func (*Preferences) String

func (p *Preferences) String() string

type Session

type Session struct {
	Prefs *Preferences
	// contains filtered or unexported fields
}

Session represents a gaming session with the hi-score server. A session is started (with StartSession()) when a game starts, and concludes (with EndSession() when the game ends by uploading the game stats. Instances of the Session type can be used more than once.

func NewSession

func NewSession() (*Session, error)

NewSession is the preferred method of initialisation of the Session type.

func (*Session) EndSession

func (sess *Session) EndSession(playTime time.Duration) error

EndSession notifies the the HiScore server that a game has finished, with details of the game session (time spent, score, etc.)

func (*Session) StartSession

func (sess *Session) StartSession(name string, hash string) error

StartSession notifies the HiScore server that a game is about to start.