package ipc

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

message ActiveGameEntry

omgwords.proto:267

message ActiveGamePlayer

omgwords.proto:262

Used in: ActiveGameEntry

message AnalysisCompleteEvent

ipc.proto:75

message Bag

omgwords.proto:481

Used in: GameDocument

message BroadcastGamesUpdatedEvent

ipc.proto:88

Sent when the annotation state of games within a broadcast changes (e.g. a game is claimed or unclaimed). Clients invalidate GetBroadcastGames only.

message BroadcastUpdatedEvent

ipc.proto:81

Sent when a live broadcast's feed data has been updated (scores, new round, etc.) Clients listening on channel-broadcast-{slug} re-fetch broadcast games on receipt.

enum ChallengeRule

omgwords.proto:432

Used in: GameDocument, LeagueSettings, OMGWordsChallengeResultEvent, omgwords_service.CreateAnnotatedGameRequest, omgwords_service.ImportGCGRequest

message ChatMessage

chat.proto:8

Used in: ChatMessages

message ChatMessageDeleted

chat.proto:23

message ChatMessages

chat.proto:21

Used as response type in: user_service.SocializeService.GetChatsForChannel

enum ChildStatus

users.proto:5

message ClientGameplayEvent

omgwords.proto:35

Used in: omgwords_service.AnnotatedGameEvent, puzzle_service.SubmissionRequest

enum ClientGameplayEvent.EventType

omgwords.proto:36

Used in: ClientGameplayEvent

message DeclineSeekRequest

omgseeks.proto:60

When a Receiver declines a Seeker:

message Division

league.proto:61

Used in: Season, league_service.AllDivisionStandingsResponse, league_service.DivisionStandingsResponse

message DivisionControls

tournament.proto:152

Used as request type in: tournament_service.TournamentService.SetDivisionControls

Used as field type in: DivisionControlsResponse, TournamentDivisionDataResponse

message DivisionControlsResponse

tournament.proto:221

message DivisionPairingsDeletedResponse

tournament.proto:199

message DivisionPairingsResponse

tournament.proto:192

message DivisionRoundControls

tournament.proto:213

Used as request type in: tournament_service.TournamentService.SetRoundControls

message ErrorMessage

errors.proto:4

enum FirstMethod

tournament.proto:88

Used in: RoundControl

message FullTournamentDivisions

tournament.proto:239

Used as response type in: tournament_service.TournamentService.GetTournament

message GameBoard

omgwords.proto:471

Used in: GameDocument

message GameDeletion

omgwords.proto:260

message GameDocument

omgwords.proto:487

A GameDocument encodes the entire state of a game. It includes a history of events, as well as information about the current state of the bag, timers, etc. It should be possible to recreate an entire omgwords game from a GameDocument state at any given time.

Used as response type in: omgwords_service.GameEventService.GetGameDocument

Used as field type in: game_service.GameDocumentResponse, GameDocumentEvent, omgwords_service.PatchDocumentRequest, omgwords_service.ReplaceDocumentRequest

message GameDocument.MinimalPlayerInfo

omgwords.proto:488

Used in: GameDocument

message GameDocumentEvent

omgwords.proto:189

A GameDocumentEvent should eventually replace the GameHistoryRefresher. For now, it will be used for annotated games.

enum GameEndReason

omgwords.proto:10

Used in: GameDocument, GameEndedEvent, GameInfoResponse, TournamentGame, TournamentGameEndedEvent, league_service.PlayerSeasonGame, tournament_service.TournamentResultOverrideRequest

message GameEndedEvent

omgwords.proto:331

GameEndedEvent is always sent from the server to both clients.

message GameEvent

omgwords.proto:371

GameEvent is an internal game event, saved in the GameDocument.

Used in: GameDocument, ServerOMGWordsEvent

enum GameEvent.Direction

omgwords.proto:391

Used in: GameEvent

enum GameEvent.Type

omgwords.proto:372

Used in: GameEvent

message GameHistoryRefresher

omgwords.proto:158

A GameHistoryRefresher is sent to both players when the game starts, and any observers at the time that they begin observing. It can also be sent to a player who reconnects in the middle of a game.

message GameInfoResponse

omgwords.proto:216

Used as response type in: game_service.GameMetadataService.GetMetadata

Used as field type in: GameInfoResponses

message GameInfoResponses

omgwords.proto:248

Used as response type in: game_service.GameMetadataService.GetActiveCorrespondenceGames, game_service.GameMetadataService.GetRecentCorrespondenceGames, game_service.GameMetadataService.GetRecentGames

message GameMetaEvent

omgwords.proto:115

GameMetaEvent defines how we serialize meta events to the database.

Used in: GameHistoryRefresher, MetaEventData

enum GameMetaEvent.EventType

omgwords.proto:116

Used in: GameMetaEvent

enum GameMode

omgwords.proto:73

Used in: GameRequest

message GameRequest

omgwords.proto:95

Used in: DivisionControls, GameInfoResponse, InstantiateGame, SeekRequest, tournament_service.TournamentDivisionSummary, tournament_service.TournamentMetadata

message GameRules

omgwords.proto:62

A GameRules is just the name of a board layout + the name of a letter distribution. These must exist in a database or file somewhere.

Used in: GameRequest, omgwords_service.CreateAnnotatedGameRequest, omgwords_service.ImportGCGRequest

enum GameType

omgwords.proto:83

Used in: GameDocument, GameInfoResponse

message GetDivisionTimeBankWarningsRequest

league.proto:136

Used as request type in: league_service.LeagueService.GetDivisionTimeBankWarnings

message GetDivisionTimeBankWarningsResponse

league.proto:141

Used as response type in: league_service.LeagueService.GetDivisionTimeBankWarnings

message GetFollowersRequest

presence.proto:22

Request for getting followers of a user

message GetFollowersResponse

presence.proto:27

Response containing list of follower user IDs

message GetFollowsRequest

presence.proto:32

Request for getting users that a user follows

message GetFollowsResponse

presence.proto:37

Response containing list of user IDs that the user follows

message InitRealmInfo

ipc.proto:107

InitRealmInfo is a request for the API server to send back information about that realm back to the user. For example, for the lobby realm, we would like lists of active games, chats, etc; for game realms, we would like the game history.

message InstantiateGame

omgwords.proto:252

InstantiateGame is an internal message passed to gamesvc in order to instantiate a game.

message JoinPath

ipc.proto:120

When we go to a new path in our SPA, we send a JoinPath. When we leave the path, we send an Unjoin realm. d

message LagMeasurement

ipc.proto:112

message League

league.proto:9

Used in: league_service.GetAllLeaguesResponse, league_service.LeagueResponse

message LeaguePlayerStanding

league.proto:81

Used in: Division, league_service.SeasonSummary

message LeagueSettings

league.proto:19

Used in: League, league_service.CreateLeagueRequest, league_service.UpdateLeagueSettingsRequest

message MatchUser

omgseeks.proto:8

A MatchUser requests or receives a match via a seek or a match request.

Used in: SeekRequest

enum MessageType

ipc.proto:15

In order to make socket messages as small and simple as possible, we should include the message type with the socket message. Whenever we add a new client <-> server socket message type, add it to this list.

message MetaEventData

omgwords.proto:469

Used in: GameDocument

message MonitoringData

tournament.proto:281

Monitoring/Invigilation data for tournament participants

Used in: MonitoringStreamStatusUpdate, TournamentMonitoringUpdate, tournament_service.GetTournamentMonitoringResponse

message MonitoringStreamStatusUpdate

tournament.proto:302

Single user monitoring stream status update (sent via WebSocket to individual user)

message NewGameEvent

omgwords.proto:358

A NewGameEvent gets sent from the server to the involved clients when a new game is about to begin. It should follow a SoughtGameProcessEvent.

message OMGWordsChallengeResultEvent

omgwords.proto:323

enum PairError

pair.proto:51

Used in: PairResponse

enum PairMethod

pair.proto:5

Used in: PairRequest

message PairRequest

pair.proto:26

Used as request type in: pair_service.PairService.HandlePairRequest

message PairResponse

pair.proto:88

Used as response type in: pair_service.PairService.HandlePairRequest, tournament_service.TournamentService.RunCOP

message Pairing

tournament.proto:173

Used in: DivisionPairingsResponse, DivisionRoundControls, PlayersAddedOrRemovedResponse, TournamentDivisionDataResponse

enum PairingMethod

tournament.proto:72

Used in: RoundControl

enum PlacementStatus

league.proto:120

PlacementStatus indicates a player's status for next season placement

Used in: LeaguePlayerStanding

enum PlayState

omgwords.proto:425

Used in: GameDocument, ServerOMGWordsEvent

message PlayerCheckinResponse

tournament.proto:266

message PlayerInfo

omgwords.proto:200

Meta information about the player of a particular game.

Used in: GameInfoResponse, omgwords_service.AnnotatedGamesResponse.AnnotatedGame, omgwords_service.CreateAnnotatedGameRequest

message PlayerRegistration

league.proto:72

Used in: Division

message PlayerStanding

tournament.proto:181

Used in: RoundStandings

message PlayersAddedOrRemovedResponse

tournament.proto:205

message Pong

ipc.proto:114

message PresenceEntry

presence.proto:15

Only authenticated connections.

message ProfileUpdate

users.proto:11

message ProfileUpdate.Rating

users.proto:13

Used in: ProfileUpdate

enum PromotionFormula

league.proto:54

PromotionFormula defines how many players are promoted/relegated per division

Used in: Season, league_service.UpdateSeasonPromotionFormulaRequest

enum RatingMode

omgwords.proto:78

Used in: GameRequest

message ReadyForGame

omgwords.proto:273

message ReadyForTournamentGame

tournament.proto:46

This can be sent from the user to the tournament or vice-versa.

message RegisterRealmRequest

ipc.proto:92

message RegisterRealmResponse

ipc.proto:97

message RematchStartedEvent

omgwords.proto:351

RematchStartedEvent gets sent to a game for which there is a rematch. It notifies that observers of the game that a rematch has started.

message RoundControl

tournament.proto:107

Used in: DivisionRoundControls, TournamentDivisionDataResponse, tournament_service.SingleRoundControlsRequest, tournament_service.TournamentDivisionSummary

message RoundPairings

pair.proto:18

Used in: PairRequest

message RoundResults

pair.proto:22

Used in: PairRequest

message RoundStandings

tournament.proto:190

Used in: DivisionControlsResponse, DivisionPairingsResponse, DivisionRoundControls, PlayersAddedOrRemovedResponse, TournamentDivisionDataResponse

message Season

league.proto:33

Used in: league_service.AllSeasonsResponse, league_service.PastSeasonsResponse, league_service.RecentSeasonsResponse, league_service.SeasonResponse

enum SeasonStatus

league.proto:45

Used in: Season, league_service.BootstrapSeasonRequest

message SeekRequest

omgseeks.proto:25

Used in: SeekRequests

message SeekRequests

omgseeks.proto:57

SeekRequests sends all open seek requests.

enum SeekState

omgseeks.proto:19

Used in: SeekRequest

message ServerChallengeResultEvent

omgwords.proto:316

The server will send back a challenge result event only in the case of a challenge. In all other cases, the server will send back a ServerGameplayEvent. A ServerChallengeResultEvent is sent back along with a list of ServerGameplayEvents, instead of trying to reconstruct and send the right incremental events. The reason is that the logic is complex and has many special cases, and is already fully implemented in Macondo. We don't wish to re-implement it both in this repo's backend and frontend. XXX: This message type is obsolete, and will be replaced by OMGWordsChallengeResultEvent

message ServerGameplayEvent

omgwords.proto:280

The server will send back a ServerGameplayEvent to a ClientGameplayEvent. The server will also send these asynchronously for opponent gameplay events. XXX: This message type is obsolete and will be replaced by ServerOMGWordsEvent

message ServerMessage

ipc.proto:116

message ServerOMGWordsEvent

omgwords.proto:294

ServerOMGWordsEvent is a new event type.

message SoughtGameProcessEvent

omgseeks.proto:54

A SoughtGameProcessEvent gets sent when a match request (or seek request) get accepted (from client to server), or canceled -- when sent from server to client.

enum StandingResult

league.proto:111

Used in: LeaguePlayerStanding, league_service.LeagueRosterSeason

enum StreamStatus

tournament.proto:273

Stream status for monitoring

Used in: MonitoringData

message TimeBankWarning

league.proto:130

Used in: GetDivisionTimeBankWarningsResponse

message TimeControl

league.proto:28

Used in: LeagueSettings

message TimedOut

omgwords.proto:365

message Timers

omgwords.proto:441

Used in: GameDocument

message TournamentDataForGame

omgwords.proto:191

Used in: InstantiateGame

message TournamentDataResponse

tournament.proto:246

message TournamentDivisionDataResponse

tournament.proto:228

Used in: FullTournamentDivisions

message TournamentDivisionDeletedResponse

tournament.proto:261

message TournamentFinishedResponse

tournament.proto:244

message TournamentGame

tournament.proto:166

Used in: Pairing

message TournamentGameEndedEvent

tournament.proto:17

New tournaments will use full tournament messages (specifically, TournamentDivisionDataResponse et al). This event is also used in the tournament_service's RecentGamesResponse, which can be used to fetch information for the last games played in a tournament.

Used in: tournament_service.RecentGamesResponse

message TournamentGameEndedEvent.Player

tournament.proto:19

Used in: TournamentGameEndedEvent

enum TournamentGameResult

tournament.proto:56

Used in: DivisionControls, Pairing, TournamentGame, TournamentGameEndedEvent.Player, tournament_service.TournamentPairingRequest, tournament_service.TournamentResultOverrideRequest

message TournamentMonitoringUpdate

tournament.proto:296

Broadcast message for monitoring updates

message TournamentPerson

tournament.proto:94

Used in: PlayerCheckinResponse, TournamentPersons

message TournamentPersons

tournament.proto:101

Used as request type in: tournament_service.TournamentService.AddDirectors, tournament_service.TournamentService.AddPlayers, tournament_service.TournamentService.RemoveDirectors, tournament_service.TournamentService.RemovePlayers

Used as field type in: PlayersAddedOrRemovedResponse, TournamentDataResponse, TournamentDivisionDataResponse

message TournamentRoundStarted

tournament.proto:37

This message makes the "Status Bar" show up and also tells the players that the backend is now accepting "ready" messages for this round.

message UnjoinRealm

ipc.proto:122

(message has no fields)

message UserPresence

presence.proto:4

Used in: UserPresences

message UserPresences

presence.proto:12

enum WooglesError

errors.proto:6