presence

Documentation

Overview

Package presence provides a high-level store of information about user presence on pages

Index

• type SessionID
• type Store
  • func NewStore() *Store
  • func (s *Store) Add(topic Topic, sessionID SessionID) (changed bool)
  • func (s *Store) Count(topic Topic) (count int)
  • func (s *Store) Forget(sessionID SessionID)
  • func (s *Store) IsKnown(sessionID SessionID) bool
  • func (s *Store) List(topic Topic) (users []User, anonymousSessions []SessionID)
  • func (s *Store) Remember(sessionID SessionID, userID UserID, userIdentifier UserIdentifier)
  • func (s *Store) Remove(topic Topic, sessionID SessionID) (changed bool)
• type Topic
• type User
• type UserID
• type UserIdentifier

Types

type SessionID

type SessionID string

type Store

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

func NewStore

func NewStore() *Store

func (*Store) Add

func (s *Store) Add(topic Topic, sessionID SessionID) (changed bool)

func (*Store) Count

func (s *Store) Count(topic Topic) (count int)

func (*Store) Forget

func (s *Store) Forget(sessionID SessionID)

func (*Store) IsKnown

func (s *Store) IsKnown(sessionID SessionID) bool

func (*Store) List

func (s *Store) List(topic Topic) (users []User, anonymousSessions []SessionID)

func (*Store) Remember

func (s *Store) Remember(sessionID SessionID, userID UserID, userIdentifier UserIdentifier)

func (*Store) Remove

func (s *Store) Remove(topic Topic, sessionID SessionID) (changed bool)

type Topic

type Topic string

type User

type User struct {
	ID         UserID
	Identifier UserIdentifier
}

type UserID

type UserID string

type UserIdentifier

type UserIdentifier string