pb

package
v0.5.1 Latest Latest
Warning

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

Go to latest
Published: May 7, 2019 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package pb is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package pb is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package pb is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package pb is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var MmfConfig_Type_name = map[int32]string{
	0: "GRPC",
	1: "REST",
}
View Source
var MmfConfig_Type_value = map[string]int32{
	"GRPC": 0,
	"REST": 1,
}

Functions

func RegisterBackendHandler added in v0.5.0

func RegisterBackendHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterBackendHandler registers the http handlers for service Backend to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterBackendHandlerClient added in v0.5.0

func RegisterBackendHandlerClient(ctx context.Context, mux *runtime.ServeMux, client BackendClient) error

RegisterBackendHandlerClient registers the http handlers for service Backend to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "BackendClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "BackendClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "BackendClient" to call the correct interceptors.

func RegisterBackendHandlerFromEndpoint added in v0.5.0

func RegisterBackendHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterBackendHandlerFromEndpoint is same as RegisterBackendHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterBackendServer

func RegisterBackendServer(s *grpc.Server, srv BackendServer)

func RegisterFrontendHandler added in v0.5.0

func RegisterFrontendHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterFrontendHandler registers the http handlers for service Frontend to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterFrontendHandlerClient added in v0.5.0

func RegisterFrontendHandlerClient(ctx context.Context, mux *runtime.ServeMux, client FrontendClient) error

RegisterFrontendHandlerClient registers the http handlers for service Frontend to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "FrontendClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "FrontendClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "FrontendClient" to call the correct interceptors.

func RegisterFrontendHandlerFromEndpoint added in v0.5.0

func RegisterFrontendHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterFrontendHandlerFromEndpoint is same as RegisterFrontendHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterFrontendServer

func RegisterFrontendServer(s *grpc.Server, srv FrontendServer)

func RegisterMatchFunctionHandler added in v0.5.0

func RegisterMatchFunctionHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterMatchFunctionHandler registers the http handlers for service MatchFunction to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterMatchFunctionHandlerClient added in v0.5.0

func RegisterMatchFunctionHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MatchFunctionClient) error

RegisterMatchFunctionHandlerClient registers the http handlers for service MatchFunction to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "MatchFunctionClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "MatchFunctionClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "MatchFunctionClient" to call the correct interceptors.

func RegisterMatchFunctionHandlerFromEndpoint added in v0.5.0

func RegisterMatchFunctionHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterMatchFunctionHandlerFromEndpoint is same as RegisterMatchFunctionHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterMatchFunctionServer added in v0.5.0

func RegisterMatchFunctionServer(s *grpc.Server, srv MatchFunctionServer)

func RegisterMmLogicHandler added in v0.5.0

func RegisterMmLogicHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterMmLogicHandler registers the http handlers for service MmLogic to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterMmLogicHandlerClient added in v0.5.0

func RegisterMmLogicHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MmLogicClient) error

RegisterMmLogicHandlerClient registers the http handlers for service MmLogic to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "MmLogicClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "MmLogicClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "MmLogicClient" to call the correct interceptors.

func RegisterMmLogicHandlerFromEndpoint added in v0.5.0

func RegisterMmLogicHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterMmLogicHandlerFromEndpoint is same as RegisterMmLogicHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterMmLogicServer

func RegisterMmLogicServer(s *grpc.Server, srv MmLogicServer)

Types

type Assignments

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

func (*Assignments) Descriptor

func (*Assignments) Descriptor() ([]byte, []int)

func (*Assignments) GetAssignment

func (m *Assignments) GetAssignment() string

func (*Assignments) GetRosters

func (m *Assignments) GetRosters() []*Roster

func (*Assignments) ProtoMessage

func (*Assignments) ProtoMessage()

func (*Assignments) Reset

func (m *Assignments) Reset()

func (*Assignments) String

func (m *Assignments) String() string

func (*Assignments) XXX_DiscardUnknown

func (m *Assignments) XXX_DiscardUnknown()

func (*Assignments) XXX_Marshal

func (m *Assignments) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Assignments) XXX_Merge

func (m *Assignments) XXX_Merge(src proto.Message)

func (*Assignments) XXX_Size

func (m *Assignments) XXX_Size() int

func (*Assignments) XXX_Unmarshal

func (m *Assignments) XXX_Unmarshal(b []byte) error

type BackendClient

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 *CreateMatchRequest, opts ...grpc.CallOption) (*CreateMatchResponse, 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 *ListMatchesRequest, 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 *DeleteMatchRequest, opts ...grpc.CallOption) (*DeleteMatchResponse, 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 *CreateAssignmentsRequest, opts ...grpc.CallOption) (*CreateAssignmentsResponse, 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 *DeleteAssignmentsRequest, opts ...grpc.CallOption) (*DeleteAssignmentsResponse, error)
}

BackendClient is the client API for Backend service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewBackendClient

func NewBackendClient(cc *grpc.ClientConn) BackendClient

type BackendServer

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, *CreateMatchRequest) (*CreateMatchResponse, error)
	// Continually run MMF and stream MatchObjects that fit this profile until
	// the backend client closes the connection.  Same inputs/outputs as CreateMatch.
	ListMatches(*ListMatchesRequest, 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, *DeleteMatchRequest) (*DeleteMatchResponse, 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, *CreateAssignmentsRequest) (*CreateAssignmentsResponse, 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, *DeleteAssignmentsRequest) (*DeleteAssignmentsResponse, error)
}

BackendServer is the server API for Backend service.

type Backend_ListMatchesClient

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

type Backend_ListMatchesServer

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

type CreateAssignmentsRequest added in v0.5.0

type CreateAssignmentsRequest struct {
	Assignment           *Assignments `protobuf:"bytes,1,opt,name=assignment,proto3" json:"assignment,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

func (*CreateAssignmentsRequest) Descriptor added in v0.5.0

func (*CreateAssignmentsRequest) Descriptor() ([]byte, []int)

func (*CreateAssignmentsRequest) GetAssignment added in v0.5.0

func (m *CreateAssignmentsRequest) GetAssignment() *Assignments

func (*CreateAssignmentsRequest) ProtoMessage added in v0.5.0

func (*CreateAssignmentsRequest) ProtoMessage()

func (*CreateAssignmentsRequest) Reset added in v0.5.0

func (m *CreateAssignmentsRequest) Reset()

func (*CreateAssignmentsRequest) String added in v0.5.0

func (m *CreateAssignmentsRequest) String() string

func (*CreateAssignmentsRequest) XXX_DiscardUnknown added in v0.5.0

func (m *CreateAssignmentsRequest) XXX_DiscardUnknown()

func (*CreateAssignmentsRequest) XXX_Marshal added in v0.5.0

func (m *CreateAssignmentsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateAssignmentsRequest) XXX_Merge added in v0.5.0

func (m *CreateAssignmentsRequest) XXX_Merge(src proto.Message)

func (*CreateAssignmentsRequest) XXX_Size added in v0.5.0

func (m *CreateAssignmentsRequest) XXX_Size() int

func (*CreateAssignmentsRequest) XXX_Unmarshal added in v0.5.0

func (m *CreateAssignmentsRequest) XXX_Unmarshal(b []byte) error

type CreateAssignmentsResponse added in v0.5.0

type CreateAssignmentsResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*CreateAssignmentsResponse) Descriptor added in v0.5.0

func (*CreateAssignmentsResponse) Descriptor() ([]byte, []int)

func (*CreateAssignmentsResponse) ProtoMessage added in v0.5.0

func (*CreateAssignmentsResponse) ProtoMessage()

func (*CreateAssignmentsResponse) Reset added in v0.5.0

func (m *CreateAssignmentsResponse) Reset()

func (*CreateAssignmentsResponse) String added in v0.5.0

func (m *CreateAssignmentsResponse) String() string

func (*CreateAssignmentsResponse) XXX_DiscardUnknown added in v0.5.0

func (m *CreateAssignmentsResponse) XXX_DiscardUnknown()

func (*CreateAssignmentsResponse) XXX_Marshal added in v0.5.0

func (m *CreateAssignmentsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateAssignmentsResponse) XXX_Merge added in v0.5.0

func (m *CreateAssignmentsResponse) XXX_Merge(src proto.Message)

func (*CreateAssignmentsResponse) XXX_Size added in v0.5.0

func (m *CreateAssignmentsResponse) XXX_Size() int

func (*CreateAssignmentsResponse) XXX_Unmarshal added in v0.5.0

func (m *CreateAssignmentsResponse) XXX_Unmarshal(b []byte) error

type CreateMatchRequest added in v0.5.0

type CreateMatchRequest struct {
	Match                *MatchObject `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	Mmfcfg               *MmfConfig   `protobuf:"bytes,2,opt,name=mmfcfg,proto3" json:"mmfcfg,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

func (*CreateMatchRequest) Descriptor added in v0.5.0

func (*CreateMatchRequest) Descriptor() ([]byte, []int)

func (*CreateMatchRequest) GetMatch added in v0.5.0

func (m *CreateMatchRequest) GetMatch() *MatchObject

func (*CreateMatchRequest) GetMmfcfg added in v0.5.0

func (m *CreateMatchRequest) GetMmfcfg() *MmfConfig

func (*CreateMatchRequest) ProtoMessage added in v0.5.0

func (*CreateMatchRequest) ProtoMessage()

func (*CreateMatchRequest) Reset added in v0.5.0

func (m *CreateMatchRequest) Reset()

func (*CreateMatchRequest) String added in v0.5.0

func (m *CreateMatchRequest) String() string

func (*CreateMatchRequest) XXX_DiscardUnknown added in v0.5.0

func (m *CreateMatchRequest) XXX_DiscardUnknown()

func (*CreateMatchRequest) XXX_Marshal added in v0.5.0

func (m *CreateMatchRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateMatchRequest) XXX_Merge added in v0.5.0

func (m *CreateMatchRequest) XXX_Merge(src proto.Message)

func (*CreateMatchRequest) XXX_Size added in v0.5.0

func (m *CreateMatchRequest) XXX_Size() int

func (*CreateMatchRequest) XXX_Unmarshal added in v0.5.0

func (m *CreateMatchRequest) XXX_Unmarshal(b []byte) error

type CreateMatchResponse added in v0.5.0

type CreateMatchResponse struct {
	Match                *MatchObject `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

func (*CreateMatchResponse) Descriptor added in v0.5.0

func (*CreateMatchResponse) Descriptor() ([]byte, []int)

func (*CreateMatchResponse) GetMatch added in v0.5.0

func (m *CreateMatchResponse) GetMatch() *MatchObject

func (*CreateMatchResponse) ProtoMessage added in v0.5.0

func (*CreateMatchResponse) ProtoMessage()

func (*CreateMatchResponse) Reset added in v0.5.0

func (m *CreateMatchResponse) Reset()

func (*CreateMatchResponse) String added in v0.5.0

func (m *CreateMatchResponse) String() string

func (*CreateMatchResponse) XXX_DiscardUnknown added in v0.5.0

func (m *CreateMatchResponse) XXX_DiscardUnknown()

func (*CreateMatchResponse) XXX_Marshal added in v0.5.0

func (m *CreateMatchResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateMatchResponse) XXX_Merge added in v0.5.0

func (m *CreateMatchResponse) XXX_Merge(src proto.Message)

func (*CreateMatchResponse) XXX_Size added in v0.5.0

func (m *CreateMatchResponse) XXX_Size() int

func (*CreateMatchResponse) XXX_Unmarshal added in v0.5.0

func (m *CreateMatchResponse) XXX_Unmarshal(b []byte) error

type CreatePlayerRequest added in v0.5.0

type CreatePlayerRequest struct {
	Player               *Player  `protobuf:"bytes,1,opt,name=player,proto3" json:"player,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*CreatePlayerRequest) Descriptor added in v0.5.0

func (*CreatePlayerRequest) Descriptor() ([]byte, []int)

func (*CreatePlayerRequest) GetPlayer added in v0.5.0

func (m *CreatePlayerRequest) GetPlayer() *Player

func (*CreatePlayerRequest) ProtoMessage added in v0.5.0

func (*CreatePlayerRequest) ProtoMessage()

func (*CreatePlayerRequest) Reset added in v0.5.0

func (m *CreatePlayerRequest) Reset()

func (*CreatePlayerRequest) String added in v0.5.0

func (m *CreatePlayerRequest) String() string

func (*CreatePlayerRequest) XXX_DiscardUnknown added in v0.5.0

func (m *CreatePlayerRequest) XXX_DiscardUnknown()

func (*CreatePlayerRequest) XXX_Marshal added in v0.5.0

func (m *CreatePlayerRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreatePlayerRequest) XXX_Merge added in v0.5.0

func (m *CreatePlayerRequest) XXX_Merge(src proto.Message)

func (*CreatePlayerRequest) XXX_Size added in v0.5.0

func (m *CreatePlayerRequest) XXX_Size() int

func (*CreatePlayerRequest) XXX_Unmarshal added in v0.5.0

func (m *CreatePlayerRequest) XXX_Unmarshal(b []byte) error

type CreatePlayerResponse added in v0.5.0

type CreatePlayerResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*CreatePlayerResponse) Descriptor added in v0.5.0

func (*CreatePlayerResponse) Descriptor() ([]byte, []int)

func (*CreatePlayerResponse) ProtoMessage added in v0.5.0

func (*CreatePlayerResponse) ProtoMessage()

func (*CreatePlayerResponse) Reset added in v0.5.0

func (m *CreatePlayerResponse) Reset()

func (*CreatePlayerResponse) String added in v0.5.0

func (m *CreatePlayerResponse) String() string

func (*CreatePlayerResponse) XXX_DiscardUnknown added in v0.5.0

func (m *CreatePlayerResponse) XXX_DiscardUnknown()

func (*CreatePlayerResponse) XXX_Marshal added in v0.5.0

func (m *CreatePlayerResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreatePlayerResponse) XXX_Merge added in v0.5.0

func (m *CreatePlayerResponse) XXX_Merge(src proto.Message)

func (*CreatePlayerResponse) XXX_Size added in v0.5.0

func (m *CreatePlayerResponse) XXX_Size() int

func (*CreatePlayerResponse) XXX_Unmarshal added in v0.5.0

func (m *CreatePlayerResponse) XXX_Unmarshal(b []byte) error

type CreateProposalRequest added in v0.5.0

type CreateProposalRequest struct {
	Match                *MatchObject `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

func (*CreateProposalRequest) Descriptor added in v0.5.0

func (*CreateProposalRequest) Descriptor() ([]byte, []int)

func (*CreateProposalRequest) GetMatch added in v0.5.0

func (m *CreateProposalRequest) GetMatch() *MatchObject

func (*CreateProposalRequest) ProtoMessage added in v0.5.0

func (*CreateProposalRequest) ProtoMessage()

func (*CreateProposalRequest) Reset added in v0.5.0

func (m *CreateProposalRequest) Reset()

func (*CreateProposalRequest) String added in v0.5.0

func (m *CreateProposalRequest) String() string

func (*CreateProposalRequest) XXX_DiscardUnknown added in v0.5.0

func (m *CreateProposalRequest) XXX_DiscardUnknown()

func (*CreateProposalRequest) XXX_Marshal added in v0.5.0

func (m *CreateProposalRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateProposalRequest) XXX_Merge added in v0.5.0

func (m *CreateProposalRequest) XXX_Merge(src proto.Message)

func (*CreateProposalRequest) XXX_Size added in v0.5.0

func (m *CreateProposalRequest) XXX_Size() int

func (*CreateProposalRequest) XXX_Unmarshal added in v0.5.0

func (m *CreateProposalRequest) XXX_Unmarshal(b []byte) error

type CreateProposalResponse added in v0.5.0

type CreateProposalResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*CreateProposalResponse) Descriptor added in v0.5.0

func (*CreateProposalResponse) Descriptor() ([]byte, []int)

func (*CreateProposalResponse) ProtoMessage added in v0.5.0

func (*CreateProposalResponse) ProtoMessage()

func (*CreateProposalResponse) Reset added in v0.5.0

func (m *CreateProposalResponse) Reset()

func (*CreateProposalResponse) String added in v0.5.0

func (m *CreateProposalResponse) String() string

func (*CreateProposalResponse) XXX_DiscardUnknown added in v0.5.0

func (m *CreateProposalResponse) XXX_DiscardUnknown()

func (*CreateProposalResponse) XXX_Marshal added in v0.5.0

func (m *CreateProposalResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateProposalResponse) XXX_Merge added in v0.5.0

func (m *CreateProposalResponse) XXX_Merge(src proto.Message)

func (*CreateProposalResponse) XXX_Size added in v0.5.0

func (m *CreateProposalResponse) XXX_Size() int

func (*CreateProposalResponse) XXX_Unmarshal added in v0.5.0

func (m *CreateProposalResponse) XXX_Unmarshal(b []byte) error

type DeleteAssignmentsRequest added in v0.5.0

type DeleteAssignmentsRequest struct {
	Roster               *Roster  `protobuf:"bytes,1,opt,name=roster,proto3" json:"roster,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*DeleteAssignmentsRequest) Descriptor added in v0.5.0

func (*DeleteAssignmentsRequest) Descriptor() ([]byte, []int)

func (*DeleteAssignmentsRequest) GetRoster added in v0.5.0

func (m *DeleteAssignmentsRequest) GetRoster() *Roster

func (*DeleteAssignmentsRequest) ProtoMessage added in v0.5.0

func (*DeleteAssignmentsRequest) ProtoMessage()

func (*DeleteAssignmentsRequest) Reset added in v0.5.0

func (m *DeleteAssignmentsRequest) Reset()

func (*DeleteAssignmentsRequest) String added in v0.5.0

func (m *DeleteAssignmentsRequest) String() string

func (*DeleteAssignmentsRequest) XXX_DiscardUnknown added in v0.5.0

func (m *DeleteAssignmentsRequest) XXX_DiscardUnknown()

func (*DeleteAssignmentsRequest) XXX_Marshal added in v0.5.0

func (m *DeleteAssignmentsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteAssignmentsRequest) XXX_Merge added in v0.5.0

func (m *DeleteAssignmentsRequest) XXX_Merge(src proto.Message)

func (*DeleteAssignmentsRequest) XXX_Size added in v0.5.0

func (m *DeleteAssignmentsRequest) XXX_Size() int

func (*DeleteAssignmentsRequest) XXX_Unmarshal added in v0.5.0

func (m *DeleteAssignmentsRequest) XXX_Unmarshal(b []byte) error

type DeleteAssignmentsResponse added in v0.5.0

type DeleteAssignmentsResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*DeleteAssignmentsResponse) Descriptor added in v0.5.0

func (*DeleteAssignmentsResponse) Descriptor() ([]byte, []int)

func (*DeleteAssignmentsResponse) ProtoMessage added in v0.5.0

func (*DeleteAssignmentsResponse) ProtoMessage()

func (*DeleteAssignmentsResponse) Reset added in v0.5.0

func (m *DeleteAssignmentsResponse) Reset()

func (*DeleteAssignmentsResponse) String added in v0.5.0

func (m *DeleteAssignmentsResponse) String() string

func (*DeleteAssignmentsResponse) XXX_DiscardUnknown added in v0.5.0

func (m *DeleteAssignmentsResponse) XXX_DiscardUnknown()

func (*DeleteAssignmentsResponse) XXX_Marshal added in v0.5.0

func (m *DeleteAssignmentsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteAssignmentsResponse) XXX_Merge added in v0.5.0

func (m *DeleteAssignmentsResponse) XXX_Merge(src proto.Message)

func (*DeleteAssignmentsResponse) XXX_Size added in v0.5.0

func (m *DeleteAssignmentsResponse) XXX_Size() int

func (*DeleteAssignmentsResponse) XXX_Unmarshal added in v0.5.0

func (m *DeleteAssignmentsResponse) XXX_Unmarshal(b []byte) error

type DeleteMatchRequest added in v0.5.0

type DeleteMatchRequest struct {
	Match                *MatchObject `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

func (*DeleteMatchRequest) Descriptor added in v0.5.0

func (*DeleteMatchRequest) Descriptor() ([]byte, []int)

func (*DeleteMatchRequest) GetMatch added in v0.5.0

func (m *DeleteMatchRequest) GetMatch() *MatchObject

func (*DeleteMatchRequest) ProtoMessage added in v0.5.0

func (*DeleteMatchRequest) ProtoMessage()

func (*DeleteMatchRequest) Reset added in v0.5.0

func (m *DeleteMatchRequest) Reset()

func (*DeleteMatchRequest) String added in v0.5.0

func (m *DeleteMatchRequest) String() string

func (*DeleteMatchRequest) XXX_DiscardUnknown added in v0.5.0

func (m *DeleteMatchRequest) XXX_DiscardUnknown()

func (*DeleteMatchRequest) XXX_Marshal added in v0.5.0

func (m *DeleteMatchRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteMatchRequest) XXX_Merge added in v0.5.0

func (m *DeleteMatchRequest) XXX_Merge(src proto.Message)

func (*DeleteMatchRequest) XXX_Size added in v0.5.0

func (m *DeleteMatchRequest) XXX_Size() int

func (*DeleteMatchRequest) XXX_Unmarshal added in v0.5.0

func (m *DeleteMatchRequest) XXX_Unmarshal(b []byte) error

type DeleteMatchResponse added in v0.5.0

type DeleteMatchResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*DeleteMatchResponse) Descriptor added in v0.5.0

func (*DeleteMatchResponse) Descriptor() ([]byte, []int)

func (*DeleteMatchResponse) ProtoMessage added in v0.5.0

func (*DeleteMatchResponse) ProtoMessage()

func (*DeleteMatchResponse) Reset added in v0.5.0

func (m *DeleteMatchResponse) Reset()

func (*DeleteMatchResponse) String added in v0.5.0

func (m *DeleteMatchResponse) String() string

func (*DeleteMatchResponse) XXX_DiscardUnknown added in v0.5.0

func (m *DeleteMatchResponse) XXX_DiscardUnknown()

func (*DeleteMatchResponse) XXX_Marshal added in v0.5.0

func (m *DeleteMatchResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteMatchResponse) XXX_Merge added in v0.5.0

func (m *DeleteMatchResponse) XXX_Merge(src proto.Message)

func (*DeleteMatchResponse) XXX_Size added in v0.5.0

func (m *DeleteMatchResponse) XXX_Size() int

func (*DeleteMatchResponse) XXX_Unmarshal added in v0.5.0

func (m *DeleteMatchResponse) XXX_Unmarshal(b []byte) error

type DeletePlayerRequest added in v0.5.0

type DeletePlayerRequest struct {
	Player               *Player  `protobuf:"bytes,1,opt,name=player,proto3" json:"player,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*DeletePlayerRequest) Descriptor added in v0.5.0

func (*DeletePlayerRequest) Descriptor() ([]byte, []int)

func (*DeletePlayerRequest) GetPlayer added in v0.5.0

func (m *DeletePlayerRequest) GetPlayer() *Player

func (*DeletePlayerRequest) ProtoMessage added in v0.5.0

func (*DeletePlayerRequest) ProtoMessage()

func (*DeletePlayerRequest) Reset added in v0.5.0

func (m *DeletePlayerRequest) Reset()

func (*DeletePlayerRequest) String added in v0.5.0

func (m *DeletePlayerRequest) String() string

func (*DeletePlayerRequest) XXX_DiscardUnknown added in v0.5.0

func (m *DeletePlayerRequest) XXX_DiscardUnknown()

func (*DeletePlayerRequest) XXX_Marshal added in v0.5.0

func (m *DeletePlayerRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeletePlayerRequest) XXX_Merge added in v0.5.0

func (m *DeletePlayerRequest) XXX_Merge(src proto.Message)

func (*DeletePlayerRequest) XXX_Size added in v0.5.0

func (m *DeletePlayerRequest) XXX_Size() int

func (*DeletePlayerRequest) XXX_Unmarshal added in v0.5.0

func (m *DeletePlayerRequest) XXX_Unmarshal(b []byte) error

type DeletePlayerResponse added in v0.5.0

type DeletePlayerResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*DeletePlayerResponse) Descriptor added in v0.5.0

func (*DeletePlayerResponse) Descriptor() ([]byte, []int)

func (*DeletePlayerResponse) ProtoMessage added in v0.5.0

func (*DeletePlayerResponse) ProtoMessage()

func (*DeletePlayerResponse) Reset added in v0.5.0

func (m *DeletePlayerResponse) Reset()

func (*DeletePlayerResponse) String added in v0.5.0

func (m *DeletePlayerResponse) String() string

func (*DeletePlayerResponse) XXX_DiscardUnknown added in v0.5.0

func (m *DeletePlayerResponse) XXX_DiscardUnknown()

func (*DeletePlayerResponse) XXX_Marshal added in v0.5.0

func (m *DeletePlayerResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeletePlayerResponse) XXX_Merge added in v0.5.0

func (m *DeletePlayerResponse) XXX_Merge(src proto.Message)

func (*DeletePlayerResponse) XXX_Size added in v0.5.0

func (m *DeletePlayerResponse) XXX_Size() int

func (*DeletePlayerResponse) XXX_Unmarshal added in v0.5.0

func (m *DeletePlayerResponse) XXX_Unmarshal(b []byte) error

type Filter

type Filter struct {
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Attribute            string   `protobuf:"bytes,2,opt,name=attribute,proto3" json:"attribute,omitempty"`
	Maxv                 int64    `protobuf:"varint,3,opt,name=maxv,proto3" json:"maxv,omitempty"`
	Minv                 int64    `protobuf:"varint,4,opt,name=minv,proto3" json:"minv,omitempty"`
	Stats                *Stats   `protobuf:"bytes,5,opt,name=stats,proto3" json:"stats,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A 'hard' filter to apply to the player pool.

func (*Filter) Descriptor

func (*Filter) Descriptor() ([]byte, []int)

func (*Filter) GetAttribute

func (m *Filter) GetAttribute() string

func (*Filter) GetMaxv

func (m *Filter) GetMaxv() int64

func (*Filter) GetMinv

func (m *Filter) GetMinv() int64

func (*Filter) GetName

func (m *Filter) GetName() string

func (*Filter) GetStats

func (m *Filter) GetStats() *Stats

func (*Filter) ProtoMessage

func (*Filter) ProtoMessage()

func (*Filter) Reset

func (m *Filter) Reset()

func (*Filter) String

func (m *Filter) String() string

func (*Filter) XXX_DiscardUnknown

func (m *Filter) XXX_DiscardUnknown()

func (*Filter) XXX_Marshal

func (m *Filter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Filter) XXX_Merge

func (m *Filter) XXX_Merge(src proto.Message)

func (*Filter) XXX_Size

func (m *Filter) XXX_Size() int

func (*Filter) XXX_Unmarshal

func (m *Filter) XXX_Unmarshal(b []byte) error

type FrontendClient

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 *CreatePlayerRequest, opts ...grpc.CallOption) (*CreatePlayerResponse, 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 *DeletePlayerRequest, opts ...grpc.CallOption) (*DeletePlayerResponse, 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 *GetUpdatesRequest, opts ...grpc.CallOption) (Frontend_GetUpdatesClient, error)
}

FrontendClient is the client API for Frontend service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewFrontendClient

func NewFrontendClient(cc *grpc.ClientConn) FrontendClient

type FrontendServer

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, *CreatePlayerRequest) (*CreatePlayerResponse, 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, *DeletePlayerRequest) (*DeletePlayerResponse, 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(*GetUpdatesRequest, Frontend_GetUpdatesServer) error
}

FrontendServer is the server API for Frontend service.

type Frontend_GetUpdatesClient

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

type Frontend_GetUpdatesServer

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

type GetAllIgnoredPlayersRequest added in v0.5.0

type GetAllIgnoredPlayersRequest struct {
	IgnorePlayer         *IlInput `protobuf:"bytes,1,opt,name=ignore_player,json=ignorePlayer,proto3" json:"ignore_player,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetAllIgnoredPlayersRequest) Descriptor added in v0.5.0

func (*GetAllIgnoredPlayersRequest) Descriptor() ([]byte, []int)

func (*GetAllIgnoredPlayersRequest) GetIgnorePlayer added in v0.5.0

func (m *GetAllIgnoredPlayersRequest) GetIgnorePlayer() *IlInput

func (*GetAllIgnoredPlayersRequest) ProtoMessage added in v0.5.0

func (*GetAllIgnoredPlayersRequest) ProtoMessage()

func (*GetAllIgnoredPlayersRequest) Reset added in v0.5.0

func (m *GetAllIgnoredPlayersRequest) Reset()

func (*GetAllIgnoredPlayersRequest) String added in v0.5.0

func (m *GetAllIgnoredPlayersRequest) String() string

func (*GetAllIgnoredPlayersRequest) XXX_DiscardUnknown added in v0.5.0

func (m *GetAllIgnoredPlayersRequest) XXX_DiscardUnknown()

func (*GetAllIgnoredPlayersRequest) XXX_Marshal added in v0.5.0

func (m *GetAllIgnoredPlayersRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetAllIgnoredPlayersRequest) XXX_Merge added in v0.5.0

func (m *GetAllIgnoredPlayersRequest) XXX_Merge(src proto.Message)

func (*GetAllIgnoredPlayersRequest) XXX_Size added in v0.5.0

func (m *GetAllIgnoredPlayersRequest) XXX_Size() int

func (*GetAllIgnoredPlayersRequest) XXX_Unmarshal added in v0.5.0

func (m *GetAllIgnoredPlayersRequest) XXX_Unmarshal(b []byte) error

type GetAllIgnoredPlayersResponse added in v0.5.0

type GetAllIgnoredPlayersResponse struct {
	Roster               *Roster  `protobuf:"bytes,1,opt,name=roster,proto3" json:"roster,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetAllIgnoredPlayersResponse) Descriptor added in v0.5.0

func (*GetAllIgnoredPlayersResponse) Descriptor() ([]byte, []int)

func (*GetAllIgnoredPlayersResponse) GetRoster added in v0.5.0

func (m *GetAllIgnoredPlayersResponse) GetRoster() *Roster

func (*GetAllIgnoredPlayersResponse) ProtoMessage added in v0.5.0

func (*GetAllIgnoredPlayersResponse) ProtoMessage()

func (*GetAllIgnoredPlayersResponse) Reset added in v0.5.0

func (m *GetAllIgnoredPlayersResponse) Reset()

func (*GetAllIgnoredPlayersResponse) String added in v0.5.0

func (*GetAllIgnoredPlayersResponse) XXX_DiscardUnknown added in v0.5.0

func (m *GetAllIgnoredPlayersResponse) XXX_DiscardUnknown()

func (*GetAllIgnoredPlayersResponse) XXX_Marshal added in v0.5.0

func (m *GetAllIgnoredPlayersResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetAllIgnoredPlayersResponse) XXX_Merge added in v0.5.0

func (m *GetAllIgnoredPlayersResponse) XXX_Merge(src proto.Message)

func (*GetAllIgnoredPlayersResponse) XXX_Size added in v0.5.0

func (m *GetAllIgnoredPlayersResponse) XXX_Size() int

func (*GetAllIgnoredPlayersResponse) XXX_Unmarshal added in v0.5.0

func (m *GetAllIgnoredPlayersResponse) XXX_Unmarshal(b []byte) error

type GetPlayerPoolRequest added in v0.5.0

type GetPlayerPoolRequest struct {
	PlayerPool           *PlayerPool `protobuf:"bytes,1,opt,name=player_pool,json=playerPool,proto3" json:"player_pool,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

func (*GetPlayerPoolRequest) Descriptor added in v0.5.0

func (*GetPlayerPoolRequest) Descriptor() ([]byte, []int)

func (*GetPlayerPoolRequest) GetPlayerPool added in v0.5.0

func (m *GetPlayerPoolRequest) GetPlayerPool() *PlayerPool

func (*GetPlayerPoolRequest) ProtoMessage added in v0.5.0

func (*GetPlayerPoolRequest) ProtoMessage()

func (*GetPlayerPoolRequest) Reset added in v0.5.0

func (m *GetPlayerPoolRequest) Reset()

func (*GetPlayerPoolRequest) String added in v0.5.0

func (m *GetPlayerPoolRequest) String() string

func (*GetPlayerPoolRequest) XXX_DiscardUnknown added in v0.5.0

func (m *GetPlayerPoolRequest) XXX_DiscardUnknown()

func (*GetPlayerPoolRequest) XXX_Marshal added in v0.5.0

func (m *GetPlayerPoolRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetPlayerPoolRequest) XXX_Merge added in v0.5.0

func (m *GetPlayerPoolRequest) XXX_Merge(src proto.Message)

func (*GetPlayerPoolRequest) XXX_Size added in v0.5.0

func (m *GetPlayerPoolRequest) XXX_Size() int

func (*GetPlayerPoolRequest) XXX_Unmarshal added in v0.5.0

func (m *GetPlayerPoolRequest) XXX_Unmarshal(b []byte) error

type GetPlayerPoolResponse added in v0.5.0

type GetPlayerPoolResponse struct {
	PlayerPool           *PlayerPool `protobuf:"bytes,1,opt,name=player_pool,json=playerPool,proto3" json:"player_pool,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

func (*GetPlayerPoolResponse) Descriptor added in v0.5.0

func (*GetPlayerPoolResponse) Descriptor() ([]byte, []int)

func (*GetPlayerPoolResponse) GetPlayerPool added in v0.5.0

func (m *GetPlayerPoolResponse) GetPlayerPool() *PlayerPool

func (*GetPlayerPoolResponse) ProtoMessage added in v0.5.0

func (*GetPlayerPoolResponse) ProtoMessage()

func (*GetPlayerPoolResponse) Reset added in v0.5.0

func (m *GetPlayerPoolResponse) Reset()

func (*GetPlayerPoolResponse) String added in v0.5.0

func (m *GetPlayerPoolResponse) String() string

func (*GetPlayerPoolResponse) XXX_DiscardUnknown added in v0.5.0

func (m *GetPlayerPoolResponse) XXX_DiscardUnknown()

func (*GetPlayerPoolResponse) XXX_Marshal added in v0.5.0

func (m *GetPlayerPoolResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetPlayerPoolResponse) XXX_Merge added in v0.5.0

func (m *GetPlayerPoolResponse) XXX_Merge(src proto.Message)

func (*GetPlayerPoolResponse) XXX_Size added in v0.5.0

func (m *GetPlayerPoolResponse) XXX_Size() int

func (*GetPlayerPoolResponse) XXX_Unmarshal added in v0.5.0

func (m *GetPlayerPoolResponse) XXX_Unmarshal(b []byte) error

type GetProfileRequest added in v0.5.0

type GetProfileRequest struct {
	Match                *MatchObject `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

func (*GetProfileRequest) Descriptor added in v0.5.0

func (*GetProfileRequest) Descriptor() ([]byte, []int)

func (*GetProfileRequest) GetMatch added in v0.5.0

func (m *GetProfileRequest) GetMatch() *MatchObject

func (*GetProfileRequest) ProtoMessage added in v0.5.0

func (*GetProfileRequest) ProtoMessage()

func (*GetProfileRequest) Reset added in v0.5.0

func (m *GetProfileRequest) Reset()

func (*GetProfileRequest) String added in v0.5.0

func (m *GetProfileRequest) String() string

func (*GetProfileRequest) XXX_DiscardUnknown added in v0.5.0

func (m *GetProfileRequest) XXX_DiscardUnknown()

func (*GetProfileRequest) XXX_Marshal added in v0.5.0

func (m *GetProfileRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetProfileRequest) XXX_Merge added in v0.5.0

func (m *GetProfileRequest) XXX_Merge(src proto.Message)

func (*GetProfileRequest) XXX_Size added in v0.5.0

func (m *GetProfileRequest) XXX_Size() int

func (*GetProfileRequest) XXX_Unmarshal added in v0.5.0

func (m *GetProfileRequest) XXX_Unmarshal(b []byte) error

type GetProfileResponse added in v0.5.0

type GetProfileResponse struct {
	Match                *MatchObject `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

func (*GetProfileResponse) Descriptor added in v0.5.0

func (*GetProfileResponse) Descriptor() ([]byte, []int)

func (*GetProfileResponse) GetMatch added in v0.5.0

func (m *GetProfileResponse) GetMatch() *MatchObject

func (*GetProfileResponse) ProtoMessage added in v0.5.0

func (*GetProfileResponse) ProtoMessage()

func (*GetProfileResponse) Reset added in v0.5.0

func (m *GetProfileResponse) Reset()

func (*GetProfileResponse) String added in v0.5.0

func (m *GetProfileResponse) String() string

func (*GetProfileResponse) XXX_DiscardUnknown added in v0.5.0

func (m *GetProfileResponse) XXX_DiscardUnknown()

func (*GetProfileResponse) XXX_Marshal added in v0.5.0

func (m *GetProfileResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetProfileResponse) XXX_Merge added in v0.5.0

func (m *GetProfileResponse) XXX_Merge(src proto.Message)

func (*GetProfileResponse) XXX_Size added in v0.5.0

func (m *GetProfileResponse) XXX_Size() int

func (*GetProfileResponse) XXX_Unmarshal added in v0.5.0

func (m *GetProfileResponse) XXX_Unmarshal(b []byte) error

type GetUpdatesRequest added in v0.5.0

type GetUpdatesRequest struct {
	Player               *Player  `protobuf:"bytes,1,opt,name=player,proto3" json:"player,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetUpdatesRequest) Descriptor added in v0.5.0

func (*GetUpdatesRequest) Descriptor() ([]byte, []int)

func (*GetUpdatesRequest) GetPlayer added in v0.5.0

func (m *GetUpdatesRequest) GetPlayer() *Player

func (*GetUpdatesRequest) ProtoMessage added in v0.5.0

func (*GetUpdatesRequest) ProtoMessage()

func (*GetUpdatesRequest) Reset added in v0.5.0

func (m *GetUpdatesRequest) Reset()

func (*GetUpdatesRequest) String added in v0.5.0

func (m *GetUpdatesRequest) String() string

func (*GetUpdatesRequest) XXX_DiscardUnknown added in v0.5.0

func (m *GetUpdatesRequest) XXX_DiscardUnknown()

func (*GetUpdatesRequest) XXX_Marshal added in v0.5.0

func (m *GetUpdatesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetUpdatesRequest) XXX_Merge added in v0.5.0

func (m *GetUpdatesRequest) XXX_Merge(src proto.Message)

func (*GetUpdatesRequest) XXX_Size added in v0.5.0

func (m *GetUpdatesRequest) XXX_Size() int

func (*GetUpdatesRequest) XXX_Unmarshal added in v0.5.0

func (m *GetUpdatesRequest) XXX_Unmarshal(b []byte) error

type GetUpdatesResponse added in v0.5.0

type GetUpdatesResponse struct {
	Player               *Player  `protobuf:"bytes,1,opt,name=player,proto3" json:"player,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetUpdatesResponse) Descriptor added in v0.5.0

func (*GetUpdatesResponse) Descriptor() ([]byte, []int)

func (*GetUpdatesResponse) GetPlayer added in v0.5.0

func (m *GetUpdatesResponse) GetPlayer() *Player

func (*GetUpdatesResponse) ProtoMessage added in v0.5.0

func (*GetUpdatesResponse) ProtoMessage()

func (*GetUpdatesResponse) Reset added in v0.5.0

func (m *GetUpdatesResponse) Reset()

func (*GetUpdatesResponse) String added in v0.5.0

func (m *GetUpdatesResponse) String() string

func (*GetUpdatesResponse) XXX_DiscardUnknown added in v0.5.0

func (m *GetUpdatesResponse) XXX_DiscardUnknown()

func (*GetUpdatesResponse) XXX_Marshal added in v0.5.0

func (m *GetUpdatesResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetUpdatesResponse) XXX_Merge added in v0.5.0

func (m *GetUpdatesResponse) XXX_Merge(src proto.Message)

func (*GetUpdatesResponse) XXX_Size added in v0.5.0

func (m *GetUpdatesResponse) XXX_Size() int

func (*GetUpdatesResponse) XXX_Unmarshal added in v0.5.0

func (m *GetUpdatesResponse) XXX_Unmarshal(b []byte) error

type IlInput

type IlInput struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

IlInput is an empty message reserved for future use.

func (*IlInput) Descriptor

func (*IlInput) Descriptor() ([]byte, []int)

func (*IlInput) ProtoMessage

func (*IlInput) ProtoMessage()

func (*IlInput) Reset

func (m *IlInput) Reset()

func (*IlInput) String

func (m *IlInput) String() string

func (*IlInput) XXX_DiscardUnknown

func (m *IlInput) XXX_DiscardUnknown()

func (*IlInput) XXX_Marshal

func (m *IlInput) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*IlInput) XXX_Merge

func (m *IlInput) XXX_Merge(src proto.Message)

func (*IlInput) XXX_Size

func (m *IlInput) XXX_Size() int

func (*IlInput) XXX_Unmarshal

func (m *IlInput) XXX_Unmarshal(b []byte) error

type ListIgnoredPlayersRequest added in v0.5.0

type ListIgnoredPlayersRequest struct {
	IgnorePlayer         *IlInput `protobuf:"bytes,1,opt,name=ignore_player,json=ignorePlayer,proto3" json:"ignore_player,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ListIgnoredPlayersRequest) Descriptor added in v0.5.0

func (*ListIgnoredPlayersRequest) Descriptor() ([]byte, []int)

func (*ListIgnoredPlayersRequest) GetIgnorePlayer added in v0.5.0

func (m *ListIgnoredPlayersRequest) GetIgnorePlayer() *IlInput

func (*ListIgnoredPlayersRequest) ProtoMessage added in v0.5.0

func (*ListIgnoredPlayersRequest) ProtoMessage()

func (*ListIgnoredPlayersRequest) Reset added in v0.5.0

func (m *ListIgnoredPlayersRequest) Reset()

func (*ListIgnoredPlayersRequest) String added in v0.5.0

func (m *ListIgnoredPlayersRequest) String() string

func (*ListIgnoredPlayersRequest) XXX_DiscardUnknown added in v0.5.0

func (m *ListIgnoredPlayersRequest) XXX_DiscardUnknown()

func (*ListIgnoredPlayersRequest) XXX_Marshal added in v0.5.0

func (m *ListIgnoredPlayersRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListIgnoredPlayersRequest) XXX_Merge added in v0.5.0

func (m *ListIgnoredPlayersRequest) XXX_Merge(src proto.Message)

func (*ListIgnoredPlayersRequest) XXX_Size added in v0.5.0

func (m *ListIgnoredPlayersRequest) XXX_Size() int

func (*ListIgnoredPlayersRequest) XXX_Unmarshal added in v0.5.0

func (m *ListIgnoredPlayersRequest) XXX_Unmarshal(b []byte) error

type ListIgnoredPlayersResponse added in v0.5.0

type ListIgnoredPlayersResponse struct {
	Roster               *Roster  `protobuf:"bytes,1,opt,name=roster,proto3" json:"roster,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ListIgnoredPlayersResponse) Descriptor added in v0.5.0

func (*ListIgnoredPlayersResponse) Descriptor() ([]byte, []int)

func (*ListIgnoredPlayersResponse) GetRoster added in v0.5.0

func (m *ListIgnoredPlayersResponse) GetRoster() *Roster

func (*ListIgnoredPlayersResponse) ProtoMessage added in v0.5.0

func (*ListIgnoredPlayersResponse) ProtoMessage()

func (*ListIgnoredPlayersResponse) Reset added in v0.5.0

func (m *ListIgnoredPlayersResponse) Reset()

func (*ListIgnoredPlayersResponse) String added in v0.5.0

func (m *ListIgnoredPlayersResponse) String() string

func (*ListIgnoredPlayersResponse) XXX_DiscardUnknown added in v0.5.0

func (m *ListIgnoredPlayersResponse) XXX_DiscardUnknown()

func (*ListIgnoredPlayersResponse) XXX_Marshal added in v0.5.0

func (m *ListIgnoredPlayersResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListIgnoredPlayersResponse) XXX_Merge added in v0.5.0

func (m *ListIgnoredPlayersResponse) XXX_Merge(src proto.Message)

func (*ListIgnoredPlayersResponse) XXX_Size added in v0.5.0

func (m *ListIgnoredPlayersResponse) XXX_Size() int

func (*ListIgnoredPlayersResponse) XXX_Unmarshal added in v0.5.0

func (m *ListIgnoredPlayersResponse) XXX_Unmarshal(b []byte) error

type ListMatchesRequest added in v0.5.0

type ListMatchesRequest struct {
	Match                *MatchObject `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	Mmfcfg               *MmfConfig   `protobuf:"bytes,2,opt,name=mmfcfg,proto3" json:"mmfcfg,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

func (*ListMatchesRequest) Descriptor added in v0.5.0

func (*ListMatchesRequest) Descriptor() ([]byte, []int)

func (*ListMatchesRequest) GetMatch added in v0.5.0

func (m *ListMatchesRequest) GetMatch() *MatchObject

func (*ListMatchesRequest) GetMmfcfg added in v0.5.0

func (m *ListMatchesRequest) GetMmfcfg() *MmfConfig

func (*ListMatchesRequest) ProtoMessage added in v0.5.0

func (*ListMatchesRequest) ProtoMessage()

func (*ListMatchesRequest) Reset added in v0.5.0

func (m *ListMatchesRequest) Reset()

func (*ListMatchesRequest) String added in v0.5.0

func (m *ListMatchesRequest) String() string

func (*ListMatchesRequest) XXX_DiscardUnknown added in v0.5.0

func (m *ListMatchesRequest) XXX_DiscardUnknown()

func (*ListMatchesRequest) XXX_Marshal added in v0.5.0

func (m *ListMatchesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListMatchesRequest) XXX_Merge added in v0.5.0

func (m *ListMatchesRequest) XXX_Merge(src proto.Message)

func (*ListMatchesRequest) XXX_Size added in v0.5.0

func (m *ListMatchesRequest) XXX_Size() int

func (*ListMatchesRequest) XXX_Unmarshal added in v0.5.0

func (m *ListMatchesRequest) XXX_Unmarshal(b []byte) error

type ListMatchesResponse added in v0.5.0

type ListMatchesResponse struct {
	Match                *MatchObject `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

func (*ListMatchesResponse) Descriptor added in v0.5.0

func (*ListMatchesResponse) Descriptor() ([]byte, []int)

func (*ListMatchesResponse) GetMatch added in v0.5.0

func (m *ListMatchesResponse) GetMatch() *MatchObject

func (*ListMatchesResponse) ProtoMessage added in v0.5.0

func (*ListMatchesResponse) ProtoMessage()

func (*ListMatchesResponse) Reset added in v0.5.0

func (m *ListMatchesResponse) Reset()

func (*ListMatchesResponse) String added in v0.5.0

func (m *ListMatchesResponse) String() string

func (*ListMatchesResponse) XXX_DiscardUnknown added in v0.5.0

func (m *ListMatchesResponse) XXX_DiscardUnknown()

func (*ListMatchesResponse) XXX_Marshal added in v0.5.0

func (m *ListMatchesResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListMatchesResponse) XXX_Merge added in v0.5.0

func (m *ListMatchesResponse) XXX_Merge(src proto.Message)

func (*ListMatchesResponse) XXX_Size added in v0.5.0

func (m *ListMatchesResponse) XXX_Size() int

func (*ListMatchesResponse) XXX_Unmarshal added in v0.5.0

func (m *ListMatchesResponse) XXX_Unmarshal(b []byte) error

type MatchFunctionClient added in v0.5.0

type MatchFunctionClient interface {
	// The assumption is that there will be one service for each MMF that is
	// being served.  Build your MMF in the appropriate serving harness, deploy it
	// to the K8s cluster with a unique service name, then connect to that service
	// and call 'Run()' to execute the fuction.
	Run(ctx context.Context, in *RunRequest, opts ...grpc.CallOption) (*RunResponse, error)
}

MatchFunctionClient is the client API for MatchFunction service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewMatchFunctionClient added in v0.5.0

func NewMatchFunctionClient(cc *grpc.ClientConn) MatchFunctionClient

type MatchFunctionServer added in v0.5.0

type MatchFunctionServer interface {
	// The assumption is that there will be one service for each MMF that is
	// being served.  Build your MMF in the appropriate serving harness, deploy it
	// to the K8s cluster with a unique service name, then connect to that service
	// and call 'Run()' to execute the fuction.
	Run(context.Context, *RunRequest) (*RunResponse, error)
}

MatchFunctionServer is the server API for MatchFunction service.

type MatchObject

type MatchObject struct {
	Id                   string        `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Properties           string        `protobuf:"bytes,2,opt,name=properties,proto3" json:"properties,omitempty"`
	Error                string        `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	Rosters              []*Roster     `protobuf:"bytes,4,rep,name=rosters,proto3" json:"rosters,omitempty"`
	Pools                []*PlayerPool `protobuf:"bytes,5,rep,name=pools,proto3" json:"pools,omitempty"`
	Status               string        `protobuf:"bytes,6,opt,name=status,proto3" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

Open Match's internal representation and wire protocol format for "MatchObjects". In order to request a match using the Backend API, your backend code should generate a new MatchObject with an ID and properties filled in (for more details about valid values for these fields, see the documentation). Open Match then sends the Match Object through to your matchmaking function, where you add players to 'rosters' and store any schemaless data you wish in the 'properties' field. The MatchObject is then sent, populated, out through the Backend API to your backend code.

MatchObjects contain a number of fields, but many gRPC calls that take a MatchObject as input only require a few of them to be filled in. Check the gRPC function in question for more details.

func (*MatchObject) Descriptor

func (*MatchObject) Descriptor() ([]byte, []int)

func (*MatchObject) GetError

func (m *MatchObject) GetError() string

func (*MatchObject) GetId

func (m *MatchObject) GetId() string

func (*MatchObject) GetPools

func (m *MatchObject) GetPools() []*PlayerPool

func (*MatchObject) GetProperties

func (m *MatchObject) GetProperties() string

func (*MatchObject) GetRosters

func (m *MatchObject) GetRosters() []*Roster

func (*MatchObject) GetStatus

func (m *MatchObject) GetStatus() string

func (*MatchObject) ProtoMessage

func (*MatchObject) ProtoMessage()

func (*MatchObject) Reset

func (m *MatchObject) Reset()

func (*MatchObject) String

func (m *MatchObject) String() string

func (*MatchObject) XXX_DiscardUnknown

func (m *MatchObject) XXX_DiscardUnknown()

func (*MatchObject) XXX_Marshal

func (m *MatchObject) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MatchObject) XXX_Merge

func (m *MatchObject) XXX_Merge(src proto.Message)

func (*MatchObject) XXX_Size

func (m *MatchObject) XXX_Size() int

func (*MatchObject) XXX_Unmarshal

func (m *MatchObject) XXX_Unmarshal(b []byte) error

type MmLogicClient

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 *GetProfileRequest, opts ...grpc.CallOption) (*GetProfileResponse, 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 *CreateProposalRequest, opts ...grpc.CallOption) (*CreateProposalResponse, 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 *GetPlayerPoolRequest, opts ...grpc.CallOption) (MmLogic_GetPlayerPoolClient, error)
	// Ignore List functions
	//
	// IlInput is an empty message reserved for future use.
	GetAllIgnoredPlayers(ctx context.Context, in *GetAllIgnoredPlayersRequest, opts ...grpc.CallOption) (*GetAllIgnoredPlayersResponse, error)
	// ListIgnoredPlayers retrieves players from the ignore list specified in the
	// config file under 'ignoreLists.proposed.name'.
	ListIgnoredPlayers(ctx context.Context, in *ListIgnoredPlayersRequest, opts ...grpc.CallOption) (*ListIgnoredPlayersResponse, error)
}

MmLogicClient is the client API for MmLogic service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewMmLogicClient

func NewMmLogicClient(cc *grpc.ClientConn) MmLogicClient

type MmLogicServer

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, *GetProfileRequest) (*GetProfileResponse, 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, *CreateProposalRequest) (*CreateProposalResponse, 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(*GetPlayerPoolRequest, MmLogic_GetPlayerPoolServer) error
	// Ignore List functions
	//
	// IlInput is an empty message reserved for future use.
	GetAllIgnoredPlayers(context.Context, *GetAllIgnoredPlayersRequest) (*GetAllIgnoredPlayersResponse, error)
	// ListIgnoredPlayers retrieves players from the ignore list specified in the
	// config file under 'ignoreLists.proposed.name'.
	ListIgnoredPlayers(context.Context, *ListIgnoredPlayersRequest) (*ListIgnoredPlayersResponse, error)
}

MmLogicServer is the server API for MmLogic service.

type MmLogic_GetPlayerPoolClient

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

type MmLogic_GetPlayerPoolServer

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

type MmfConfig added in v0.5.0

type MmfConfig struct {
	Name                 string         `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Host                 string         `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"`
	Port                 int32          `protobuf:"varint,3,opt,name=port,proto3" json:"port,omitempty"`
	Type                 MmfConfig_Type `protobuf:"varint,4,opt,name=type,proto3,enum=api.MmfConfig_Type" json:"type,omitempty"`
	XXX_NoUnkeyedLiteral struct{}       `json:"-"`
	XXX_unrecognized     []byte         `json:"-"`
	XXX_sizecache        int32          `json:"-"`
}

func (*MmfConfig) Descriptor added in v0.5.0

func (*MmfConfig) Descriptor() ([]byte, []int)

func (*MmfConfig) GetHost added in v0.5.0

func (m *MmfConfig) GetHost() string

func (*MmfConfig) GetName added in v0.5.0

func (m *MmfConfig) GetName() string

func (*MmfConfig) GetPort added in v0.5.0

func (m *MmfConfig) GetPort() int32

func (*MmfConfig) GetType added in v0.5.0

func (m *MmfConfig) GetType() MmfConfig_Type

func (*MmfConfig) ProtoMessage added in v0.5.0

func (*MmfConfig) ProtoMessage()

func (*MmfConfig) Reset added in v0.5.0

func (m *MmfConfig) Reset()

func (*MmfConfig) String added in v0.5.0

func (m *MmfConfig) String() string

func (*MmfConfig) XXX_DiscardUnknown added in v0.5.0

func (m *MmfConfig) XXX_DiscardUnknown()

func (*MmfConfig) XXX_Marshal added in v0.5.0

func (m *MmfConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MmfConfig) XXX_Merge added in v0.5.0

func (m *MmfConfig) XXX_Merge(src proto.Message)

func (*MmfConfig) XXX_Size added in v0.5.0

func (m *MmfConfig) XXX_Size() int

func (*MmfConfig) XXX_Unmarshal added in v0.5.0

func (m *MmfConfig) XXX_Unmarshal(b []byte) error

type MmfConfig_Type added in v0.5.0

type MmfConfig_Type int32
const (
	MmfConfig_GRPC MmfConfig_Type = 0
	MmfConfig_REST MmfConfig_Type = 1
)

func (MmfConfig_Type) EnumDescriptor added in v0.5.0

func (MmfConfig_Type) EnumDescriptor() ([]byte, []int)

func (MmfConfig_Type) String added in v0.5.0

func (x MmfConfig_Type) String() string

type Player

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

Open Match's internal representation and wire protocol format for "Players". In order to enter matchmaking using the Frontend API, your client code should generate a consistent (same result for each client every time they launch) with an ID and properties filled in (for more details about valid values for these fields, see the documentation). Players contain a number of fields, but the gRPC calls that take a Player as input only require a few of them to be filled in. Check the gRPC function in question for more details.

func (*Player) Descriptor

func (*Player) Descriptor() ([]byte, []int)

func (*Player) GetAssignment

func (m *Player) GetAssignment() string

func (*Player) GetAttributes

func (m *Player) GetAttributes() []*Player_Attribute

func (*Player) GetError

func (m *Player) GetError() string

func (*Player) GetId

func (m *Player) GetId() string

func (*Player) GetPool

func (m *Player) GetPool() string

func (*Player) GetProperties

func (m *Player) GetProperties() string

func (*Player) GetStatus

func (m *Player) GetStatus() string

func (*Player) ProtoMessage

func (*Player) ProtoMessage()

func (*Player) Reset

func (m *Player) Reset()

func (*Player) String

func (m *Player) String() string

func (*Player) XXX_DiscardUnknown

func (m *Player) XXX_DiscardUnknown()

func (*Player) XXX_Marshal

func (m *Player) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Player) XXX_Merge

func (m *Player) XXX_Merge(src proto.Message)

func (*Player) XXX_Size

func (m *Player) XXX_Size() int

func (*Player) XXX_Unmarshal

func (m *Player) XXX_Unmarshal(b []byte) error

type PlayerPool

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

PlayerPools are defined by a set of 'hard' filters, and can be filled in with the players that match those filters.

PlayerPools contain a number of fields, but many gRPC calls that take a PlayerPool as input only require a few of them to be filled in. Check the gRPC function in question for more details.

func (*PlayerPool) Descriptor

func (*PlayerPool) Descriptor() ([]byte, []int)

func (*PlayerPool) GetFilters

func (m *PlayerPool) GetFilters() []*Filter

func (*PlayerPool) GetName

func (m *PlayerPool) GetName() string

func (*PlayerPool) GetRoster

func (m *PlayerPool) GetRoster() *Roster

func (*PlayerPool) GetStats

func (m *PlayerPool) GetStats() *Stats

func (*PlayerPool) ProtoMessage

func (*PlayerPool) ProtoMessage()

func (*PlayerPool) Reset

func (m *PlayerPool) Reset()

func (*PlayerPool) String

func (m *PlayerPool) String() string

func (*PlayerPool) XXX_DiscardUnknown

func (m *PlayerPool) XXX_DiscardUnknown()

func (*PlayerPool) XXX_Marshal

func (m *PlayerPool) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PlayerPool) XXX_Merge

func (m *PlayerPool) XXX_Merge(src proto.Message)

func (*PlayerPool) XXX_Size

func (m *PlayerPool) XXX_Size() int

func (*PlayerPool) XXX_Unmarshal

func (m *PlayerPool) XXX_Unmarshal(b []byte) error

type Player_Attribute

type Player_Attribute struct {
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value                int64    `protobuf:"varint,2,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*Player_Attribute) Descriptor

func (*Player_Attribute) Descriptor() ([]byte, []int)

func (*Player_Attribute) GetName

func (m *Player_Attribute) GetName() string

func (*Player_Attribute) GetValue

func (m *Player_Attribute) GetValue() int64

func (*Player_Attribute) ProtoMessage

func (*Player_Attribute) ProtoMessage()

func (*Player_Attribute) Reset

func (m *Player_Attribute) Reset()

func (*Player_Attribute) String

func (m *Player_Attribute) String() string

func (*Player_Attribute) XXX_DiscardUnknown

func (m *Player_Attribute) XXX_DiscardUnknown()

func (*Player_Attribute) XXX_Marshal

func (m *Player_Attribute) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Player_Attribute) XXX_Merge

func (m *Player_Attribute) XXX_Merge(src proto.Message)

func (*Player_Attribute) XXX_Size

func (m *Player_Attribute) XXX_Size() int

func (*Player_Attribute) XXX_Unmarshal

func (m *Player_Attribute) XXX_Unmarshal(b []byte) error

type Roster

type Roster struct {
	Name                 string    `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Players              []*Player `protobuf:"bytes,2,rep,name=players,proto3" json:"players,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

Data structure to hold a list of players in a match.

func (*Roster) Descriptor

func (*Roster) Descriptor() ([]byte, []int)

func (*Roster) GetName

func (m *Roster) GetName() string

func (*Roster) GetPlayers

func (m *Roster) GetPlayers() []*Player

func (*Roster) ProtoMessage

func (*Roster) ProtoMessage()

func (*Roster) Reset

func (m *Roster) Reset()

func (*Roster) String

func (m *Roster) String() string

func (*Roster) XXX_DiscardUnknown

func (m *Roster) XXX_DiscardUnknown()

func (*Roster) XXX_Marshal

func (m *Roster) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Roster) XXX_Merge

func (m *Roster) XXX_Merge(src proto.Message)

func (*Roster) XXX_Size

func (m *Roster) XXX_Size() int

func (*Roster) XXX_Unmarshal

func (m *Roster) XXX_Unmarshal(b []byte) error

type RunRequest added in v0.5.0

type RunRequest struct {
	ProfileId            string       `protobuf:"bytes,1,opt,name=profile_id,json=profileId,proto3" json:"profile_id,omitempty"`
	ProposalId           string       `protobuf:"bytes,2,opt,name=proposal_id,json=proposalId,proto3" json:"proposal_id,omitempty"`
	ResultId             string       `protobuf:"bytes,3,opt,name=result_id,json=resultId,proto3" json:"result_id,omitempty"`
	MatchObject          *MatchObject `protobuf:"bytes,4,opt,name=match_object,json=matchObject,proto3" json:"match_object,omitempty"`
	Timestamp            string       `protobuf:"bytes,5,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

Request message sent to the MMF.

func (*RunRequest) Descriptor added in v0.5.0

func (*RunRequest) Descriptor() ([]byte, []int)

func (*RunRequest) GetMatchObject added in v0.5.0

func (m *RunRequest) GetMatchObject() *MatchObject

func (*RunRequest) GetProfileId added in v0.5.0

func (m *RunRequest) GetProfileId() string

func (*RunRequest) GetProposalId added in v0.5.0

func (m *RunRequest) GetProposalId() string

func (*RunRequest) GetResultId added in v0.5.0

func (m *RunRequest) GetResultId() string

func (*RunRequest) GetTimestamp added in v0.5.0

func (m *RunRequest) GetTimestamp() string

func (*RunRequest) ProtoMessage added in v0.5.0

func (*RunRequest) ProtoMessage()

func (*RunRequest) Reset added in v0.5.0

func (m *RunRequest) Reset()

func (*RunRequest) String added in v0.5.0

func (m *RunRequest) String() string

func (*RunRequest) XXX_DiscardUnknown added in v0.5.0

func (m *RunRequest) XXX_DiscardUnknown()

func (*RunRequest) XXX_Marshal added in v0.5.0

func (m *RunRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RunRequest) XXX_Merge added in v0.5.0

func (m *RunRequest) XXX_Merge(src proto.Message)

func (*RunRequest) XXX_Size added in v0.5.0

func (m *RunRequest) XXX_Size() int

func (*RunRequest) XXX_Unmarshal added in v0.5.0

func (m *RunRequest) XXX_Unmarshal(b []byte) error

type RunResponse added in v0.5.0

type RunResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*RunResponse) Descriptor added in v0.5.0

func (*RunResponse) Descriptor() ([]byte, []int)

func (*RunResponse) ProtoMessage added in v0.5.0

func (*RunResponse) ProtoMessage()

func (*RunResponse) Reset added in v0.5.0

func (m *RunResponse) Reset()

func (*RunResponse) String added in v0.5.0

func (m *RunResponse) String() string

func (*RunResponse) XXX_DiscardUnknown added in v0.5.0

func (m *RunResponse) XXX_DiscardUnknown()

func (*RunResponse) XXX_Marshal added in v0.5.0

func (m *RunResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RunResponse) XXX_Merge added in v0.5.0

func (m *RunResponse) XXX_Merge(src proto.Message)

func (*RunResponse) XXX_Size added in v0.5.0

func (m *RunResponse) XXX_Size() int

func (*RunResponse) XXX_Unmarshal added in v0.5.0

func (m *RunResponse) XXX_Unmarshal(b []byte) error

type Stats

type Stats struct {
	Count                int64    `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"`
	Elapsed              float64  `protobuf:"fixed64,2,opt,name=elapsed,proto3" json:"elapsed,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Holds statistics

func (*Stats) Descriptor

func (*Stats) Descriptor() ([]byte, []int)

func (*Stats) GetCount

func (m *Stats) GetCount() int64

func (*Stats) GetElapsed

func (m *Stats) GetElapsed() float64

func (*Stats) ProtoMessage

func (*Stats) ProtoMessage()

func (*Stats) Reset

func (m *Stats) Reset()

func (*Stats) String

func (m *Stats) String() string

func (*Stats) XXX_DiscardUnknown

func (m *Stats) XXX_DiscardUnknown()

func (*Stats) XXX_Marshal

func (m *Stats) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Stats) XXX_Merge

func (m *Stats) XXX_Merge(src proto.Message)

func (*Stats) XXX_Size

func (m *Stats) XXX_Size() int

func (*Stats) XXX_Unmarshal

func (m *Stats) XXX_Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL