pb

type Assignments struct {
	Rosters    []*Roster `protobuf:"bytes,1,rep,name=rosters" json:"rosters,omitempty"`
	Assignment string    `protobuf:"bytes,10,opt,name=assignment" json:"assignment,omitempty"`
}

type BackendClient interface {
	// Run MMF once.  Return a matchobject that fits this profile.
	// INPUT: MatchObject message with these fields populated:
	//  - id
	//  - properties
	//  - [optional] roster, any fields you fill are available to your MMF.
	//  - [optional] pools, any fields you fill are available to your MMF.
	// OUTPUT: MatchObject message with these fields populated:
	//  - id
	//  - properties
	//  - error. Empty if no error was encountered
	//  - rosters, if you choose to fill them in your MMF. (Recommended)
	//  - pools, if you used the MMLogicAPI in your MMF. (Recommended, and provides stats)
	CreateMatch(ctx context.Context, in *MatchObject, opts ...grpc.CallOption) (*MatchObject, error)
	// Continually run MMF and stream MatchObjects that fit this profile until
	// the backend client closes the connection.  Same inputs/outputs as CreateMatch.
	ListMatches(ctx context.Context, in *MatchObject, opts ...grpc.CallOption) (Backend_ListMatchesClient, error)
	// Delete a MatchObject from state storage manually. (MatchObjects in state
	// storage will also automatically expire after a while, defined in the config)
	// INPUT: MatchObject message with the 'id' field populated.
	// (All other fields are ignored.)
	DeleteMatch(ctx context.Context, in *MatchObject, opts ...grpc.CallOption) (*Result, error)
	// Write the connection info for the list of players in the
	// Assignments.messages.Rosters to state storage.  The Frontend API is
	// responsible for sending anything sent here to the game clients.
	// Sending a player to this function kicks off a process that removes
	// the player from future matchmaking functions by adding them to the
	// 'deindexed' player list and then deleting their player ID from state storage
	// indexes.
	// INPUT: Assignments message with these fields populated:
	//  - assignment, anything you write to this string is sent to Frontend API
	//  - rosters. You can send any number of rosters, containing any number of
	//     player messages. All players from all rosters will be sent the assignment.
	//     The only field in the Roster's Player messages used by CreateAssignments is
	//     the id field.  All other fields in the Player messages are silently ignored.
	CreateAssignments(ctx context.Context, in *Assignments, opts ...grpc.CallOption) (*Result, error)
	// Remove DGS connection info from state storage for players.
	// INPUT: Roster message with the 'players' field populated.
	//    The only field in the Roster's Player messages used by
	//    DeleteAssignments is the 'id' field.  All others are silently ignored.  If
	//    you need to delete multiple rosters, make multiple calls.
	DeleteAssignments(ctx context.Context, in *Roster, opts ...grpc.CallOption) (*Result, error)
}

type BackendServer interface {
	// Run MMF once.  Return a matchobject that fits this profile.
	// INPUT: MatchObject message with these fields populated:
	//  - id
	//  - properties
	//  - [optional] roster, any fields you fill are available to your MMF.
	//  - [optional] pools, any fields you fill are available to your MMF.
	// OUTPUT: MatchObject message with these fields populated:
	//  - id
	//  - properties
	//  - error. Empty if no error was encountered
	//  - rosters, if you choose to fill them in your MMF. (Recommended)
	//  - pools, if you used the MMLogicAPI in your MMF. (Recommended, and provides stats)
	CreateMatch(context.Context, *MatchObject) (*MatchObject, error)
	// Continually run MMF and stream MatchObjects that fit this profile until
	// the backend client closes the connection.  Same inputs/outputs as CreateMatch.
	ListMatches(*MatchObject, Backend_ListMatchesServer) error
	// Delete a MatchObject from state storage manually. (MatchObjects in state
	// storage will also automatically expire after a while, defined in the config)
	// INPUT: MatchObject message with the 'id' field populated.
	// (All other fields are ignored.)
	DeleteMatch(context.Context, *MatchObject) (*Result, error)
	// Write the connection info for the list of players in the
	// Assignments.messages.Rosters to state storage.  The Frontend API is
	// responsible for sending anything sent here to the game clients.
	// Sending a player to this function kicks off a process that removes
	// the player from future matchmaking functions by adding them to the
	// 'deindexed' player list and then deleting their player ID from state storage
	// indexes.
	// INPUT: Assignments message with these fields populated:
	//  - assignment, anything you write to this string is sent to Frontend API
	//  - rosters. You can send any number of rosters, containing any number of
	//     player messages. All players from all rosters will be sent the assignment.
	//     The only field in the Roster's Player messages used by CreateAssignments is
	//     the id field.  All other fields in the Player messages are silently ignored.
	CreateAssignments(context.Context, *Assignments) (*Result, error)
	// Remove DGS connection info from state storage for players.
	// INPUT: Roster message with the 'players' field populated.
	//    The only field in the Roster's Player messages used by
	//    DeleteAssignments is the 'id' field.  All others are silently ignored.  If
	//    you need to delete multiple rosters, make multiple calls.
	DeleteAssignments(context.Context, *Roster) (*Result, error)
}

type Backend_ListMatchesClient interface {
	Recv() (*MatchObject, error)
	grpc.ClientStream
}

type Backend_ListMatchesServer interface {
	Send(*MatchObject) error
	grpc.ServerStream
}

type Filter struct {
	Name      string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Attribute string `protobuf:"bytes,2,opt,name=attribute" json:"attribute,omitempty"`
	Maxv      int64  `protobuf:"varint,3,opt,name=maxv" json:"maxv,omitempty"`
	Minv      int64  `protobuf:"varint,4,opt,name=minv" json:"minv,omitempty"`
	Stats     *Stats `protobuf:"bytes,5,opt,name=stats" json:"stats,omitempty"`
}

type FrontendClient interface {
	// CreatePlayer will put the player  in state storage, and then look
	// through the 'properties' field for the attributes you have defined as
	// indices your matchmaker config.  If the attributes exist and are valid
	// integers, they will be indexed.
	// INPUT: Player message with these fields populated:
	//  - id
	//  - properties
	// OUTPUT: Result message denoting success or failure (and an error if
	// necessary)
	CreatePlayer(ctx context.Context, in *Player, opts ...grpc.CallOption) (*Result, error)
	// DeletePlayer removes the player from state storage by doing the
	// following:
	//  1) Delete player from configured indices.  This effectively removes the
	//     player from matchmaking when using recommended MMF patterns.
	//     Everything after this is just cleanup to save stage storage space.
	//  2) 'Lazily' delete the player's state storage record.  This is kicked
	//     off in the background and may take some time to complete.
	//  2) 'Lazily' delete the player's metadata indicies (like, the timestamp when
	//     they called CreatePlayer, and the last time the record was accessed).  This
	//     is also kicked off in the background and may take some time to complete.
	// INPUT: Player message with the 'id' field populated.
	// OUTPUT: Result message denoting success or failure (and an error if
	// necessary)
	DeletePlayer(ctx context.Context, in *Player, opts ...grpc.CallOption) (*Result, error)
	// GetUpdates streams matchmaking results from Open Match for the
	// provided player ID.
	// INPUT: Player message with the 'id' field populated.
	// OUTPUT: a stream of player objects with one or more of the following
	// fields populated, if an update to that field is seen in state storage:
	//  - 'assignment': string that usually contains game server connection information.
	//  - 'status': string to communicate current matchmaking status to the client.
	//  - 'error': string to pass along error information to the client.
	//
	// During normal operation, the expectation is that the 'assignment' field
	// will be updated by a Backend process calling the 'CreateAssignments' Backend API
	// endpoint.  'Status' and 'Error' are free for developers to use as they see fit.
	// Even if you had multiple players enter a matchmaking request as a group, the
	// Backend API 'CreateAssignments' call will write the results to state
	// storage separately under each player's ID. OM expects you to make all game
	// clients 'GetUpdates' with their own ID from the Frontend API to get
	// their results.
	//
	// NOTE: This call generates a small amount of load on the Frontend API and state
	//  storage while watching the player record for updates. You are expected
	//  to close the stream from your client after receiving your matchmaking
	//  results (or a reasonable timeout), or you will continue to
	//  generate load on OM until you do!
	// NOTE: Just bear in mind that every update will send egress traffic from
	//  Open Match to game clients! Frugality is recommended.
	GetUpdates(ctx context.Context, in *Player, opts ...grpc.CallOption) (Frontend_GetUpdatesClient, error)
}

type FrontendServer interface {
	// CreatePlayer will put the player  in state storage, and then look
	// through the 'properties' field for the attributes you have defined as
	// indices your matchmaker config.  If the attributes exist and are valid
	// integers, they will be indexed.
	// INPUT: Player message with these fields populated:
	//  - id
	//  - properties
	// OUTPUT: Result message denoting success or failure (and an error if
	// necessary)
	CreatePlayer(context.Context, *Player) (*Result, error)
	// DeletePlayer removes the player from state storage by doing the
	// following:
	//  1) Delete player from configured indices.  This effectively removes the
	//     player from matchmaking when using recommended MMF patterns.
	//     Everything after this is just cleanup to save stage storage space.
	//  2) 'Lazily' delete the player's state storage record.  This is kicked
	//     off in the background and may take some time to complete.
	//  2) 'Lazily' delete the player's metadata indicies (like, the timestamp when
	//     they called CreatePlayer, and the last time the record was accessed).  This
	//     is also kicked off in the background and may take some time to complete.
	// INPUT: Player message with the 'id' field populated.
	// OUTPUT: Result message denoting success or failure (and an error if
	// necessary)
	DeletePlayer(context.Context, *Player) (*Result, error)
	// GetUpdates streams matchmaking results from Open Match for the
	// provided player ID.
	// INPUT: Player message with the 'id' field populated.
	// OUTPUT: a stream of player objects with one or more of the following
	// fields populated, if an update to that field is seen in state storage:
	//  - 'assignment': string that usually contains game server connection information.
	//  - 'status': string to communicate current matchmaking status to the client.
	//  - 'error': string to pass along error information to the client.
	//
	// During normal operation, the expectation is that the 'assignment' field
	// will be updated by a Backend process calling the 'CreateAssignments' Backend API
	// endpoint.  'Status' and 'Error' are free for developers to use as they see fit.
	// Even if you had multiple players enter a matchmaking request as a group, the
	// Backend API 'CreateAssignments' call will write the results to state
	// storage separately under each player's ID. OM expects you to make all game
	// clients 'GetUpdates' with their own ID from the Frontend API to get
	// their results.
	//
	// NOTE: This call generates a small amount of load on the Frontend API and state
	//  storage while watching the player record for updates. You are expected
	//  to close the stream from your client after receiving your matchmaking
	//  results (or a reasonable timeout), or you will continue to
	//  generate load on OM until you do!
	// NOTE: Just bear in mind that every update will send egress traffic from
	//  Open Match to game clients! Frugality is recommended.
	GetUpdates(*Player, Frontend_GetUpdatesServer) error
}

type Frontend_GetUpdatesClient interface {
	Recv() (*Player, error)
	grpc.ClientStream
}

type Frontend_GetUpdatesServer interface {
	Send(*Player) error
	grpc.ServerStream
}

type IlInput struct {
}

type MatchObject struct {
	Id         string        `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Properties string        `protobuf:"bytes,2,opt,name=properties" json:"properties,omitempty"`
	Error      string        `protobuf:"bytes,3,opt,name=error" json:"error,omitempty"`
	Rosters    []*Roster     `protobuf:"bytes,4,rep,name=rosters" json:"rosters,omitempty"`
	Pools      []*PlayerPool `protobuf:"bytes,5,rep,name=pools" json:"pools,omitempty"`
}

type MmLogicClient interface {
	//  Send GetProfile a match object with the ID field populated, it will return a
	//  'filled' one.
	//  Note: filters are assumed to have been checked for validity by the
	//  backendapi  when accepting a profile
	GetProfile(ctx context.Context, in *MatchObject, opts ...grpc.CallOption) (*MatchObject, error)
	// CreateProposal is called by MMFs that wish to write their results to
	// a proposed MatchObject, that can be sent out the Backend API once it has
	// been approved (by default, by the evaluator process).
	//  - adds all players in all Rosters to the proposed player ignore list
	//  - writes the proposed match to the provided key
	//  - adds that key to the list of proposals to be considered
	// INPUT:
	//  * TO RETURN A MATCHOBJECT AFTER A SUCCESSFUL MMF RUN
	//    To create a match MatchObject message with these fields populated:
	//      - id, set to the value of the MMF_PROPOSAL_ID env var
	//      - properties
	//      - error.  You must explicitly set this to an empty string if your MMF
	//      - roster, with the playerIDs filled in the 'players' repeated field.
	//      - [optional] pools, set to the output from the 'GetPlayerPools' call,
	//        will populate the pools with stats about how many players the filters
	//        matched and how long the filters took to run, which will be sent out
	//        the backend api along with your match results.
	//        was successful.
	//  * TO RETURN AN ERROR
	//    To report a failure or error, send a MatchObject message with these
	//    these fields populated:
	//      - id, set to the value of the MMF_ERROR_ID env var.
	//      - error, set to a string value describing the error your MMF encountered.
	//      - [optional] properties, anything you put here is returned to the
	//        backend along with your error.
	//      - [optional] rosters, anything you put here is returned to the
	//        backend along with your error.
	//      - [optional] pools, set to the output from the 'GetPlayerPools' call,
	//        will populate the pools with stats about how many players the filters
	//        matched and how long the filters took to run, which will be sent out
	//        the backend api along with your match results.
	// OUTPUT: a Result message with a boolean success value and an error string
	// if an error was encountered
	CreateProposal(ctx context.Context, in *MatchObject, opts ...grpc.CallOption) (*Result, error)
	// Player listing and filtering functions
	//
	// RetrievePlayerPool gets the list of players that match every Filter in the
	// PlayerPool, .excluding players in any configured ignore lists.  It
	// combines the results, and returns the resulting player pool.
	GetPlayerPool(ctx context.Context, in *PlayerPool, opts ...grpc.CallOption) (MmLogic_GetPlayerPoolClient, error)
	// Ignore List functions
	//
	// IlInput is an empty message reserved for future use.
	GetAllIgnoredPlayers(ctx context.Context, in *IlInput, opts ...grpc.CallOption) (*Roster, error)
	// ListIgnoredPlayers retrieves players from the ignore list specified in the
	// config file under 'ignoreLists.proposed.name'.
	ListIgnoredPlayers(ctx context.Context, in *IlInput, opts ...grpc.CallOption) (*Roster, error)
}

type MmLogicServer interface {
	//  Send GetProfile a match object with the ID field populated, it will return a
	//  'filled' one.
	//  Note: filters are assumed to have been checked for validity by the
	//  backendapi  when accepting a profile
	GetProfile(context.Context, *MatchObject) (*MatchObject, error)
	// CreateProposal is called by MMFs that wish to write their results to
	// a proposed MatchObject, that can be sent out the Backend API once it has
	// been approved (by default, by the evaluator process).
	//  - adds all players in all Rosters to the proposed player ignore list
	//  - writes the proposed match to the provided key
	//  - adds that key to the list of proposals to be considered
	// INPUT:
	//  * TO RETURN A MATCHOBJECT AFTER A SUCCESSFUL MMF RUN
	//    To create a match MatchObject message with these fields populated:
	//      - id, set to the value of the MMF_PROPOSAL_ID env var
	//      - properties
	//      - error.  You must explicitly set this to an empty string if your MMF
	//      - roster, with the playerIDs filled in the 'players' repeated field.
	//      - [optional] pools, set to the output from the 'GetPlayerPools' call,
	//        will populate the pools with stats about how many players the filters
	//        matched and how long the filters took to run, which will be sent out
	//        the backend api along with your match results.
	//        was successful.
	//  * TO RETURN AN ERROR
	//    To report a failure or error, send a MatchObject message with these
	//    these fields populated:
	//      - id, set to the value of the MMF_ERROR_ID env var.
	//      - error, set to a string value describing the error your MMF encountered.
	//      - [optional] properties, anything you put here is returned to the
	//        backend along with your error.
	//      - [optional] rosters, anything you put here is returned to the
	//        backend along with your error.
	//      - [optional] pools, set to the output from the 'GetPlayerPools' call,
	//        will populate the pools with stats about how many players the filters
	//        matched and how long the filters took to run, which will be sent out
	//        the backend api along with your match results.
	// OUTPUT: a Result message with a boolean success value and an error string
	// if an error was encountered
	CreateProposal(context.Context, *MatchObject) (*Result, error)
	// Player listing and filtering functions
	//
	// RetrievePlayerPool gets the list of players that match every Filter in the
	// PlayerPool, .excluding players in any configured ignore lists.  It
	// combines the results, and returns the resulting player pool.
	GetPlayerPool(*PlayerPool, MmLogic_GetPlayerPoolServer) error
	// Ignore List functions
	//
	// IlInput is an empty message reserved for future use.
	GetAllIgnoredPlayers(context.Context, *IlInput) (*Roster, error)
	// ListIgnoredPlayers retrieves players from the ignore list specified in the
	// config file under 'ignoreLists.proposed.name'.
	ListIgnoredPlayers(context.Context, *IlInput) (*Roster, error)
}

type MmLogic_GetPlayerPoolClient interface {
	Recv() (*PlayerPool, error)
	grpc.ClientStream
}

type MmLogic_GetPlayerPoolServer interface {
	Send(*PlayerPool) error
	grpc.ServerStream
}

type Player struct {
	Id         string              `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Properties string              `protobuf:"bytes,2,opt,name=properties" json:"properties,omitempty"`
	Pool       string              `protobuf:"bytes,3,opt,name=pool" json:"pool,omitempty"`
	Attributes []*Player_Attribute `protobuf:"bytes,4,rep,name=attributes" json:"attributes,omitempty"`
	Assignment string              `protobuf:"bytes,5,opt,name=assignment" json:"assignment,omitempty"`
	Status     string              `protobuf:"bytes,6,opt,name=status" json:"status,omitempty"`
	Error      string              `protobuf:"bytes,7,opt,name=error" json:"error,omitempty"`
}

type PlayerPool struct {
	Name    string    `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Filters []*Filter `protobuf:"bytes,2,rep,name=filters" json:"filters,omitempty"`
	Roster  *Roster   `protobuf:"bytes,3,opt,name=roster" json:"roster,omitempty"`
	Stats   *Stats    `protobuf:"bytes,4,opt,name=stats" json:"stats,omitempty"`
}

type Player_Attribute struct {
	Name  string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value int64  `protobuf:"varint,2,opt,name=value" json:"value,omitempty"`
}

type Result struct {
	Success bool   `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	Error   string `protobuf:"bytes,2,opt,name=error" json:"error,omitempty"`
}

type Roster struct {
	Name    string    `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Players []*Player `protobuf:"bytes,2,rep,name=players" json:"players,omitempty"`
}

type Stats struct {
	Count   int64   `protobuf:"varint,1,opt,name=count" json:"count,omitempty"`
	Elapsed float64 `protobuf:"fixed64,2,opt,name=elapsed" json:"elapsed,omitempty"`
}