model

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 11, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// DeletedUserEmail は、削除されたユーザのメールアドレスを表します。
	// メールアドレスの UNIQUE 制約は論理削除されていないレコードのみを対象としているため、削除済みユーザのメールアドレスが重複しても問題ない。
	DeletedUserEmail = ""
)

Variables

View Source 
var (
	ErrKVSEntryValueTooLarge  = errors.New("value size is too large")
	ErrPrivateKVSETagMismatch = errors.New("private KVS etag mismatch")
)
View Source 
var (
	ErrRoomSecretEmpty    = errors.New("room secret is empty")
	ErrRoomSecretMismatch = errors.New("room secret mismatch")
	ErrRoomMaxCapacity    = errors.New("room is full")
	ErrUserAlreadyInRoom  = errors.New("user is already in room")
	ErrUserNotInRoom      = errors.New("user is not in room")
)
View Source 
var (
	ErrMasterDataContentTooLarge = errors.New("master data content is too large")
)
View Source 
var (
	ErrUserDeactivated = errors.New("user is deactivated")
)
View Source 
var (
	ErrUserProfileTooLarge = errors.New("user profile is too large")
)

Functions

This section is empty.

Types

type Echo 

type Echo struct {
	ID        uuid.UUID
	Message   string
	Timestamp time.Time
}

func NewEcho 

func NewEcho(message string, timestamp time.Time) Echo

type GlobalKVSBucket 

type GlobalKVSBucket struct {
	KVSBucket
}

GlobalKVSBucket は、全ユーザで共有される KVS を表します。 専用 API が提供されていないプロダクト固有の機能は、この機能で代用される想定です。

func NewGlobalKVSBucket 

func NewGlobalKVSBucket(entries []KVSEntry) GlobalKVSBucket

type KVSBucket 

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

KVSBucket は、KVS におけるエントリの配列操作を提供します。

func NewKVSBucket 

func NewKVSBucket(entries []KVSEntry) KVSBucket

func (KVSBucket) HasKey 

func (m KVSBucket) HasKey(key string) bool

func (KVSBucket) Raw 

func (m KVSBucket) Raw() []KVSEntry

func (*KVSBucket) Set 

func (m *KVSBucket) Set(entries []KVSEntry)

type KVSCriteria 

type KVSCriteria struct {
	ExactMatch  []string
	PrefixMatch []string
}

func NewKVSCriteria 

func NewKVSCriteria(exactMatch, prefixMatch []string) KVSCriteria

func (KVSCriteria) IsEmpty 

func (c KVSCriteria) IsEmpty() bool

type KVSEntry 

type KVSEntry struct {
	Key   string
	Value []byte
}

KVSEntry は、KVS に読み書きされるデータの最小単位です。

func NewKVSEntry 

func NewKVSEntry(key string, value []byte) (KVSEntry, error)

func (KVSEntry) IsEmpty 

func (e KVSEntry) IsEmpty() bool

type LeaderBoard added in v0.2.0 

type LeaderBoard struct {
	ID     string
	Scores []LeaderBoardScore
}

func NewLeaderBoard added in v0.2.0 

func NewLeaderBoard(id string, scored []LeaderBoardScore) LeaderBoard

func (*LeaderBoard) SubmitScore added in v0.2.0 

func (l *LeaderBoard) SubmitScore(score LeaderBoardScore)

SubmitScore は、リーダーボードにスコアを提出します。 スコアの保持者はユーザとは限らない ので、誰でもスコアを上書きできるようになっています。 例えばブログのいいね数ランキングをリーダーボード機能で実現する場合、いいね送信者がスコアを提出することになります。

type LeaderBoardScore added in v0.2.0 

type LeaderBoardScore struct {
	// ScoreID は、スコア集計対象である任意のオブジェクトIDが指定されます。
	// 例: ユーザID、ブログID
	ScoreID   string
	Score     int
	Timestamp time.Time
}

LeaderBoardScore は、リーダーボードに登録されるスコアを表します。

func NewLeaderBoardScore added in v0.2.0 

func NewLeaderBoardScore(scoreID string, score int, timestamp time.Time) LeaderBoardScore

type LobbyService added in v0.3.0 

type LobbyService struct{}

LobbyService は、WebRTC のロビー機能を提供します。

func NewLobbyService added in v0.3.0 

func NewLobbyService() LobbyService

func (LobbyService) CreatePrivateRoom added in v0.3.0 

func (s LobbyService) CreatePrivateRoom(id uuid.UUID, ownerUserID uuid.UUID, maxCapacity int, secret string, detail []byte) (Room, error)

func (LobbyService) CreatePublicRoom added in v0.3.0 

func (s LobbyService) CreatePublicRoom(id uuid.UUID, ownerUserID uuid.UUID, maxCapacity int, detail []byte) Room

type MasterData added in v0.3.0 

type MasterData struct {
	Revision  int
	Content   []byte
	IsActive  bool
	Comment   string
	CreatedAt time.Time
}

func NewMasterData added in v0.3.0 

func NewMasterData(revision int, content []byte, isActive bool, comment string, createdAt time.Time) (MasterData, error)

type MasterDataService added in v0.3.0 

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

func NewMasterDataService added in v0.3.0 

func NewMasterDataService(active MasterData, revisions []int) (*MasterDataService, error)

func (*MasterDataService) NewNextRevision added in v0.3.0 

func (s *MasterDataService) NewNextRevision(content []byte, comment string, now time.Time) (MasterData, error)

func (*MasterDataService) SwitchActive added in v0.3.0 

func (s *MasterDataService) SwitchActive(target MasterData) (MasterData, MasterData, error)

type PrivateKVSBucket 

type PrivateKVSBucket struct {
	KVSBucket

	UserID uuid.UUID
	// contains filtered or unexported fields
}

PrivateKVSBucket はユーザごとに独立した KVS で、他ユーザには公開されません。

func NewPrivateKVSBucket 

func NewPrivateKVSBucket(userID uuid.UUID, etag uuid.UUID, entries []KVSEntry) PrivateKVSBucket

func (PrivateKVSBucket) ETag 

func (m PrivateKVSBucket) ETag() uuid.UUID

func (*PrivateKVSBucket) Set 

func (m *PrivateKVSBucket) Set(etag uuid.UUID, entries []KVSEntry) error

type Room added in v0.3.0 

type Room struct {
	ID          uuid.UUID
	OwnerUserID uuid.UUID
	Type        RoomType
	MaxCapacity int
	Secret      string
	Details     []byte

	UserIDs []uuid.UUID
}

Room は、WebRTC のルームを表します。

func NewRoom added in v0.3.0 

func NewRoom(id uuid.UUID, ownerUserID uuid.UUID, roomType RoomType, maxCapacity int, secret string, details []byte, userIDs []uuid.UUID) Room

func (*Room) Join added in v0.3.0 

func (r *Room) Join(userID uuid.UUID, secret string) error

func (*Room) Leave added in v0.3.0 

func (r *Room) Leave(userID uuid.UUID) error

type RoomType added in v0.3.0 

type RoomType int
const (
	// 誰でも自由に出入りできるルーム。
	RoomTypePublic RoomType = iota + 1
	// 合言葉を知っているユーザのみが出入りできるルーム。
	RoomTypePrivate
)

type User 

type User struct {
	ID     uuid.UUID
	Email  string
	Status UserStatus
}

func NewUser 

func NewUser(id uuid.UUID, email string, status UserStatus) User

func (*User) Activate 

func (u *User) Activate() error

func (*User) Delete added in v0.2.0 

func (u *User) Delete()

func (User) IsUnavailable added in v0.2.0 

func (u User) IsUnavailable() bool

type UserAuthentication 

type UserAuthentication struct {
	UserID uuid.UUID
	// BaaS ごとにユーザIDの表現が異なるため、文字列型にしている。
	BaasUserID          string
	LastAuthenticatedAt time.Time
}

UserAuthentication はユーザの認証に必要な情報を提供します。 認証/再認証のみで利用され、セッション管理のコンテキストでは利用されません。

func NewUserAuthentication 

func NewUserAuthentication(userID uuid.UUID, baasUserID string, lastAuthenticatedAt time.Time) UserAuthentication

func (*UserAuthentication) Refresh 

func (a *UserAuthentication) Refresh(now time.Time)

type UserProfile 

type UserProfile struct {
	UserID uuid.UUID
	// contains filtered or unexported fields
}

プロフィールのデータ構造はプロダクトによって異なり、汎化が難しい。 そのため、プロフィールをバイナリデータとして扱い、プロダクトごとに独自スキーマを定義させる。

func NewUserProfile 

func NewUserProfile(userID uuid.UUID, v []byte) (UserProfile, error)

func (UserProfile) Bytes 

func (p UserProfile) Bytes() []byte

type UserStatus 

type UserStatus int
const (
	// 設定が未完了で、他ユーザには公開されていない状態。
	// サインイン後、設定を完了するまでこの状態が続く。
	UserStatusPending UserStatus = 1 + iota
	// アカウントが利用可能で、他ユーザにも公開されている状態。
	UserStatusActive
	// アカウントが削除され、利用不可な状態。
	// この状態になると、二度と利用できなくなる。
	UserStatusDeactivated
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.