pb

package
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Apr 30, 2021 License: Apache-2.0 Imports: 21 Imported by: 55

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.

Package pb is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var (
	FunctionConfig_Type_name = map[int32]string{
		0: "GRPC",
		1: "REST",
	}
	FunctionConfig_Type_value = map[string]int32{
		"GRPC": 0,
		"REST": 1,
	}
)

Enum value maps for FunctionConfig_Type.

View Source 
var (
	AssignmentFailure_Cause_name = map[int32]string{
		0: "UNKNOWN",
		1: "TICKET_NOT_FOUND",
	}
	AssignmentFailure_Cause_value = map[string]int32{
		"UNKNOWN":          0,
		"TICKET_NOT_FOUND": 1,
	}
)

Enum value maps for AssignmentFailure_Cause.

View Source 
var (
	DoubleRangeFilter_Exclude_name = map[int32]string{
		0: "NONE",
		1: "MIN",
		2: "MAX",
		3: "BOTH",
	}
	DoubleRangeFilter_Exclude_value = map[string]int32{
		"NONE": 0,
		"MIN":  1,
		"MAX":  2,
		"BOTH": 3,
	}
)

Enum value maps for DoubleRangeFilter_Exclude.

View Source 
var File_api_backend_proto protoreflect.FileDescriptor
View Source 
var File_api_evaluator_proto protoreflect.FileDescriptor
View Source 
var File_api_extensions_proto protoreflect.FileDescriptor
View Source 
var File_api_frontend_proto protoreflect.FileDescriptor
View Source 
var File_api_matchfunction_proto protoreflect.FileDescriptor
View Source 
var File_api_messages_proto protoreflect.FileDescriptor
View Source 
var File_api_query_proto protoreflect.FileDescriptor

Functions

func RegisterBackendServiceHandler added in v0.9.0 

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

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

func RegisterBackendServiceHandlerClient added in v0.9.0 

func RegisterBackendServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client BackendServiceClient) error

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

func RegisterBackendServiceHandlerFromEndpoint added in v0.9.0 

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

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

func RegisterBackendServiceHandlerServer added in v0.9.0 

func RegisterBackendServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server BackendServiceServer) error

RegisterBackendServiceHandlerServer registers the http handlers for service BackendService to "mux". UnaryRPC :call BackendServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterBackendServiceHandlerFromEndpoint instead.

func RegisterBackendServiceServer added in v0.9.0 

func RegisterBackendServiceServer(s *grpc.Server, srv BackendServiceServer)

func RegisterEvaluatorHandler 

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

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

func RegisterEvaluatorHandlerClient 

func RegisterEvaluatorHandlerClient(ctx context.Context, mux *runtime.ServeMux, client EvaluatorClient) error

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

func RegisterEvaluatorHandlerFromEndpoint 

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

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

func RegisterEvaluatorHandlerServer added in v0.8.0 

func RegisterEvaluatorHandlerServer(ctx context.Context, mux *runtime.ServeMux, server EvaluatorServer) error

RegisterEvaluatorHandlerServer registers the http handlers for service Evaluator to "mux". UnaryRPC :call EvaluatorServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterEvaluatorHandlerFromEndpoint instead.

func RegisterEvaluatorServer 

func RegisterEvaluatorServer(s *grpc.Server, srv EvaluatorServer)

func RegisterFrontendServiceHandler added in v0.9.0 

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

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

func RegisterFrontendServiceHandlerClient added in v0.9.0 

func RegisterFrontendServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client FrontendServiceClient) error

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

func RegisterFrontendServiceHandlerFromEndpoint added in v0.9.0 

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

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

func RegisterFrontendServiceHandlerServer added in v0.9.0 

func RegisterFrontendServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server FrontendServiceServer) error

RegisterFrontendServiceHandlerServer registers the http handlers for service FrontendService to "mux". UnaryRPC :call FrontendServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterFrontendServiceHandlerFromEndpoint instead.

func RegisterFrontendServiceServer added in v0.9.0 

func RegisterFrontendServiceServer(s *grpc.Server, srv FrontendServiceServer)

func RegisterMatchFunctionHandler 

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 

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 

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 RegisterMatchFunctionHandlerServer added in v0.8.0 

func RegisterMatchFunctionHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MatchFunctionServer) error

RegisterMatchFunctionHandlerServer registers the http handlers for service MatchFunction to "mux". UnaryRPC :call MatchFunctionServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterMatchFunctionHandlerFromEndpoint instead.

func RegisterMatchFunctionServer 

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

func RegisterQueryServiceHandler added in v0.9.0 

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

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

func RegisterQueryServiceHandlerClient added in v0.9.0 

func RegisterQueryServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client QueryServiceClient) error

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

func RegisterQueryServiceHandlerFromEndpoint added in v0.9.0 

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

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

func RegisterQueryServiceHandlerServer added in v0.9.0 

func RegisterQueryServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server QueryServiceServer) error

RegisterQueryServiceHandlerServer registers the http handlers for service QueryService to "mux". UnaryRPC :call QueryServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterQueryServiceHandlerFromEndpoint instead.

func RegisterQueryServiceServer added in v0.9.0 

func RegisterQueryServiceServer(s *grpc.Server, srv QueryServiceServer)

Types

type AcknowledgeBackfillRequest added in v1.2.0 

type AcknowledgeBackfillRequest struct {

	// An existing ID of Backfill to acknowledge.
	BackfillId string `protobuf:"bytes,1,opt,name=backfill_id,json=backfillId,proto3" json:"backfill_id,omitempty"`
	// An updated Assignment of the requested Backfill.
	Assignment *Assignment `protobuf:"bytes,2,opt,name=assignment,proto3" json:"assignment,omitempty"`
	// contains filtered or unexported fields
}

BETA FEATURE WARNING: This Request message is not finalized and still subject to possible change or removal.

func (*AcknowledgeBackfillRequest) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use AcknowledgeBackfillRequest.ProtoReflect.Descriptor instead.

func (*AcknowledgeBackfillRequest) GetAssignment added in v1.2.0 

func (x *AcknowledgeBackfillRequest) GetAssignment() *Assignment

func (*AcknowledgeBackfillRequest) GetBackfillId added in v1.2.0 

func (x *AcknowledgeBackfillRequest) GetBackfillId() string

func (*AcknowledgeBackfillRequest) ProtoMessage added in v1.2.0 

func (*AcknowledgeBackfillRequest) ProtoMessage()

func (*AcknowledgeBackfillRequest) ProtoReflect added in v1.2.0 

func (x *AcknowledgeBackfillRequest) ProtoReflect() protoreflect.Message

func (*AcknowledgeBackfillRequest) Reset added in v1.2.0 

func (x *AcknowledgeBackfillRequest) Reset()

func (*AcknowledgeBackfillRequest) String added in v1.2.0 

func (x *AcknowledgeBackfillRequest) String() string

type AssignTicketsRequest 

type AssignTicketsRequest struct {

	// Assignments is a list of assignment groups that contain assignment and the Tickets to which they should be applied.
	Assignments []*AssignmentGroup `protobuf:"bytes,1,rep,name=assignments,proto3" json:"assignments,omitempty"`
	// contains filtered or unexported fields
}

func (*AssignTicketsRequest) Descriptor deprecated 

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

Deprecated: Use AssignTicketsRequest.ProtoReflect.Descriptor instead.

func (*AssignTicketsRequest) GetAssignments added in v0.10.0 

func (x *AssignTicketsRequest) GetAssignments() []*AssignmentGroup

func (*AssignTicketsRequest) ProtoMessage 

func (*AssignTicketsRequest) ProtoMessage()

func (*AssignTicketsRequest) ProtoReflect added in v1.2.0 

func (x *AssignTicketsRequest) ProtoReflect() protoreflect.Message

func (*AssignTicketsRequest) Reset 

func (x *AssignTicketsRequest) Reset()

func (*AssignTicketsRequest) String 

func (x *AssignTicketsRequest) String() string

type AssignTicketsResponse 

type AssignTicketsResponse struct {

	// Failures is a list of all the Tickets that failed assignment along with the cause of failure.
	Failures []*AssignmentFailure `protobuf:"bytes,1,rep,name=failures,proto3" json:"failures,omitempty"`
	// contains filtered or unexported fields
}

func (*AssignTicketsResponse) Descriptor deprecated 

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

Deprecated: Use AssignTicketsResponse.ProtoReflect.Descriptor instead.

func (*AssignTicketsResponse) GetFailures added in v0.10.0 

func (x *AssignTicketsResponse) GetFailures() []*AssignmentFailure

func (*AssignTicketsResponse) ProtoMessage 

func (*AssignTicketsResponse) ProtoMessage()

func (*AssignTicketsResponse) ProtoReflect added in v1.2.0 

func (x *AssignTicketsResponse) ProtoReflect() protoreflect.Message

func (*AssignTicketsResponse) Reset 

func (x *AssignTicketsResponse) Reset()

func (*AssignTicketsResponse) String 

func (x *AssignTicketsResponse) String() string

type Assignment 

type Assignment struct {

	// Connection information for this Assignment.
	Connection string `protobuf:"bytes,1,opt,name=connection,proto3" json:"connection,omitempty"`
	// Customized information not inspected by Open Match, to be used by the match
	// making function, evaluator, and components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions map[string]*any.Any `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

An Assignment represents a game server assignment associated with a Ticket. Open Match does not require or inspect any fields on assignment.

func (*Assignment) Descriptor deprecated 

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

Deprecated: Use Assignment.ProtoReflect.Descriptor instead.

func (*Assignment) GetConnection 

func (x *Assignment) GetConnection() string

func (*Assignment) GetExtensions added in v0.8.0 

func (x *Assignment) GetExtensions() map[string]*any.Any

func (*Assignment) ProtoMessage 

func (*Assignment) ProtoMessage()

func (*Assignment) ProtoReflect added in v1.2.0 

func (x *Assignment) ProtoReflect() protoreflect.Message

func (*Assignment) Reset 

func (x *Assignment) Reset()

func (*Assignment) String 

func (x *Assignment) String() string

type AssignmentFailure added in v0.10.0 

type AssignmentFailure struct {
	TicketId string                  `protobuf:"bytes,1,opt,name=ticket_id,json=ticketId,proto3" json:"ticket_id,omitempty"`
	Cause    AssignmentFailure_Cause `protobuf:"varint,2,opt,name=cause,proto3,enum=openmatch.AssignmentFailure_Cause" json:"cause,omitempty"`
	// contains filtered or unexported fields
}

AssignmentFailure contains the id of the Ticket that failed the Assignment and the failure status.

func (*AssignmentFailure) Descriptor deprecated added in v0.10.0 

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

Deprecated: Use AssignmentFailure.ProtoReflect.Descriptor instead.

func (*AssignmentFailure) GetCause added in v0.10.0 

func (x *AssignmentFailure) GetCause() AssignmentFailure_Cause

func (*AssignmentFailure) GetTicketId added in v0.10.0 

func (x *AssignmentFailure) GetTicketId() string

func (*AssignmentFailure) ProtoMessage added in v0.10.0 

func (*AssignmentFailure) ProtoMessage()

func (*AssignmentFailure) ProtoReflect added in v1.2.0 

func (x *AssignmentFailure) ProtoReflect() protoreflect.Message

func (*AssignmentFailure) Reset added in v0.10.0 

func (x *AssignmentFailure) Reset()

func (*AssignmentFailure) String added in v0.10.0 

func (x *AssignmentFailure) String() string

type AssignmentFailure_Cause added in v0.10.0 

type AssignmentFailure_Cause int32
const (
	AssignmentFailure_UNKNOWN          AssignmentFailure_Cause = 0
	AssignmentFailure_TICKET_NOT_FOUND AssignmentFailure_Cause = 1
)

func (AssignmentFailure_Cause) Descriptor added in v1.2.0 

func (AssignmentFailure_Cause) Descriptor() protoreflect.EnumDescriptor

func (AssignmentFailure_Cause) Enum added in v1.2.0 

func (x AssignmentFailure_Cause) Enum() *AssignmentFailure_Cause

func (AssignmentFailure_Cause) EnumDescriptor deprecated added in v0.10.0 

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

Deprecated: Use AssignmentFailure_Cause.Descriptor instead.

func (AssignmentFailure_Cause) Number added in v1.2.0 

func (x AssignmentFailure_Cause) Number() protoreflect.EnumNumber

func (AssignmentFailure_Cause) String added in v0.10.0 

func (x AssignmentFailure_Cause) String() string

func (AssignmentFailure_Cause) Type added in v1.2.0 

func (AssignmentFailure_Cause) Type() protoreflect.EnumType

type AssignmentGroup added in v0.10.0 

type AssignmentGroup struct {

	// TicketIds is a list of strings representing Open Match generated Ids which apply to an Assignment.
	TicketIds []string `protobuf:"bytes,1,rep,name=ticket_ids,json=ticketIds,proto3" json:"ticket_ids,omitempty"`
	// An Assignment specifies game connection related information to be associated with the TicketIds.
	Assignment *Assignment `protobuf:"bytes,2,opt,name=assignment,proto3" json:"assignment,omitempty"`
	// contains filtered or unexported fields
}

AssignmentGroup contains an Assignment and the Tickets to which it should be applied.

func (*AssignmentGroup) Descriptor deprecated added in v0.10.0 

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

Deprecated: Use AssignmentGroup.ProtoReflect.Descriptor instead.

func (*AssignmentGroup) GetAssignment added in v0.10.0 

func (x *AssignmentGroup) GetAssignment() *Assignment

func (*AssignmentGroup) GetTicketIds added in v0.10.0 

func (x *AssignmentGroup) GetTicketIds() []string

func (*AssignmentGroup) ProtoMessage added in v0.10.0 

func (*AssignmentGroup) ProtoMessage()

func (*AssignmentGroup) ProtoReflect added in v1.2.0 

func (x *AssignmentGroup) ProtoReflect() protoreflect.Message

func (*AssignmentGroup) Reset added in v0.10.0 

func (x *AssignmentGroup) Reset()

func (*AssignmentGroup) String added in v0.10.0 

func (x *AssignmentGroup) String() string

type BackendServiceClient added in v0.9.0 

type BackendServiceClient interface {
	// FetchMatches triggers a MatchFunction with the specified MatchProfile and
	// returns a set of matches generated by the Match Making Function, and
	// accepted by the evaluator.
	// Tickets in matches returned by FetchMatches are moved from active to
	// pending, and will not be returned by query.
	FetchMatches(ctx context.Context, in *FetchMatchesRequest, opts ...grpc.CallOption) (BackendService_FetchMatchesClient, error)
	// AssignTickets overwrites the Assignment field of the input TicketIds.
	AssignTickets(ctx context.Context, in *AssignTicketsRequest, opts ...grpc.CallOption) (*AssignTicketsResponse, error)
	// ReleaseTickets moves tickets from the pending state, to the active state.
	// This enables them to be returned by query, and find different matches.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	ReleaseTickets(ctx context.Context, in *ReleaseTicketsRequest, opts ...grpc.CallOption) (*ReleaseTicketsResponse, error)
	// ReleaseAllTickets moves all tickets from the pending state, to the active
	// state. This enables them to be returned by query, and find different
	// matches.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	ReleaseAllTickets(ctx context.Context, in *ReleaseAllTicketsRequest, opts ...grpc.CallOption) (*ReleaseAllTicketsResponse, error)
}

BackendServiceClient is the client API for BackendService service.

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

func NewBackendServiceClient added in v0.9.0 

func NewBackendServiceClient(cc grpc.ClientConnInterface) BackendServiceClient

type BackendServiceServer added in v0.9.0 

type BackendServiceServer interface {
	// FetchMatches triggers a MatchFunction with the specified MatchProfile and
	// returns a set of matches generated by the Match Making Function, and
	// accepted by the evaluator.
	// Tickets in matches returned by FetchMatches are moved from active to
	// pending, and will not be returned by query.
	FetchMatches(*FetchMatchesRequest, BackendService_FetchMatchesServer) error
	// AssignTickets overwrites the Assignment field of the input TicketIds.
	AssignTickets(context.Context, *AssignTicketsRequest) (*AssignTicketsResponse, error)
	// ReleaseTickets moves tickets from the pending state, to the active state.
	// This enables them to be returned by query, and find different matches.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	ReleaseTickets(context.Context, *ReleaseTicketsRequest) (*ReleaseTicketsResponse, error)
	// ReleaseAllTickets moves all tickets from the pending state, to the active
	// state. This enables them to be returned by query, and find different
	// matches.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	ReleaseAllTickets(context.Context, *ReleaseAllTicketsRequest) (*ReleaseAllTicketsResponse, error)
}

BackendServiceServer is the server API for BackendService service.

type BackendService_FetchMatchesClient added in v0.9.0 

type BackendService_FetchMatchesClient interface {
	Recv() (*FetchMatchesResponse, error)
	grpc.ClientStream
}

type BackendService_FetchMatchesServer added in v0.9.0 

type BackendService_FetchMatchesServer interface {
	Send(*FetchMatchesResponse) error
	grpc.ServerStream
}

type Backfill added in v1.2.0 

type Backfill struct {

	// Id represents an auto-generated Id issued by Open Match.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Search fields are the fields which Open Match is aware of, and can be used
	// when specifying filters.
	SearchFields *SearchFields `protobuf:"bytes,2,opt,name=search_fields,json=searchFields,proto3" json:"search_fields,omitempty"`
	// Customized information not inspected by Open Match, to be used by
	// the Match Function, evaluator, and components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions map[string]*any.Any `` /* 161-byte string literal not displayed */
	// Create time is the time the Ticket was created. It is populated by Open
	// Match at the time of Ticket creation.
	CreateTime *timestamp.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Generation gets incremented on GameServers update operations.
	// Prevents the MMF from overriding a newer version from the game server.
	// Do NOT read or write to this field, it is for internal tracking, and changing the value will cause bugs.
	Generation int64 `protobuf:"varint,5,opt,name=generation,proto3" json:"generation,omitempty"`
	// contains filtered or unexported fields
}

Represents a backfill entity which is used to fill partially full matches.

BETA FEATURE WARNING: This call and the associated Request and Response messages are not finalized and still subject to possible change or removal.

func (*Backfill) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use Backfill.ProtoReflect.Descriptor instead.

func (*Backfill) GetCreateTime added in v1.2.0 

func (x *Backfill) GetCreateTime() *timestamp.Timestamp

func (*Backfill) GetExtensions added in v1.2.0 

func (x *Backfill) GetExtensions() map[string]*any.Any

func (*Backfill) GetGeneration added in v1.2.0 

func (x *Backfill) GetGeneration() int64

func (*Backfill) GetId added in v1.2.0 

func (x *Backfill) GetId() string

func (*Backfill) GetSearchFields added in v1.2.0 

func (x *Backfill) GetSearchFields() *SearchFields

func (*Backfill) ProtoMessage added in v1.2.0 

func (*Backfill) ProtoMessage()

func (*Backfill) ProtoReflect added in v1.2.0 

func (x *Backfill) ProtoReflect() protoreflect.Message

func (*Backfill) Reset added in v1.2.0 

func (x *Backfill) Reset()

func (*Backfill) String added in v1.2.0 

func (x *Backfill) String() string

type CreateBackfillRequest added in v1.2.0 

type CreateBackfillRequest struct {

	// An empty Backfill object.
	Backfill *Backfill `protobuf:"bytes,1,opt,name=backfill,proto3" json:"backfill,omitempty"`
	// contains filtered or unexported fields
}

BETA FEATURE WARNING: This Request message is not finalized and still subject to possible change or removal.

func (*CreateBackfillRequest) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use CreateBackfillRequest.ProtoReflect.Descriptor instead.

func (*CreateBackfillRequest) GetBackfill added in v1.2.0 

func (x *CreateBackfillRequest) GetBackfill() *Backfill

func (*CreateBackfillRequest) ProtoMessage added in v1.2.0 

func (*CreateBackfillRequest) ProtoMessage()

func (*CreateBackfillRequest) ProtoReflect added in v1.2.0 

func (x *CreateBackfillRequest) ProtoReflect() protoreflect.Message

func (*CreateBackfillRequest) Reset added in v1.2.0 

func (x *CreateBackfillRequest) Reset()

func (*CreateBackfillRequest) String added in v1.2.0 

func (x *CreateBackfillRequest) String() string

type CreateTicketRequest 

type CreateTicketRequest struct {

	// A Ticket object with SearchFields defined.
	Ticket *Ticket `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTicketRequest) Descriptor deprecated 

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

Deprecated: Use CreateTicketRequest.ProtoReflect.Descriptor instead.

func (*CreateTicketRequest) GetTicket 

func (x *CreateTicketRequest) GetTicket() *Ticket

func (*CreateTicketRequest) ProtoMessage 

func (*CreateTicketRequest) ProtoMessage()

func (*CreateTicketRequest) ProtoReflect added in v1.2.0 

func (x *CreateTicketRequest) ProtoReflect() protoreflect.Message

func (*CreateTicketRequest) Reset 

func (x *CreateTicketRequest) Reset()

func (*CreateTicketRequest) String 

func (x *CreateTicketRequest) String() string

type DefaultEvaluationCriteria added in v0.8.0 

type DefaultEvaluationCriteria struct {
	Score float64 `protobuf:"fixed64,1,opt,name=score,proto3" json:"score,omitempty"`
	// contains filtered or unexported fields
}

A DefaultEvaluationCriteria is used for a match's evaluation_input when using the default evaluator.

func (*DefaultEvaluationCriteria) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use DefaultEvaluationCriteria.ProtoReflect.Descriptor instead.

func (*DefaultEvaluationCriteria) GetScore added in v0.8.0 

func (x *DefaultEvaluationCriteria) GetScore() float64

func (*DefaultEvaluationCriteria) ProtoMessage added in v0.8.0 

func (*DefaultEvaluationCriteria) ProtoMessage()

func (*DefaultEvaluationCriteria) ProtoReflect added in v1.2.0 

func (x *DefaultEvaluationCriteria) ProtoReflect() protoreflect.Message

func (*DefaultEvaluationCriteria) Reset added in v0.8.0 

func (x *DefaultEvaluationCriteria) Reset()

func (*DefaultEvaluationCriteria) String added in v0.8.0 

func (x *DefaultEvaluationCriteria) String() string

type DeleteBackfillRequest added in v1.2.0 

type DeleteBackfillRequest struct {

	// An existing ID of Backfill to delete.
	BackfillId string `protobuf:"bytes,1,opt,name=backfill_id,json=backfillId,proto3" json:"backfill_id,omitempty"`
	// contains filtered or unexported fields
}

BETA FEATURE WARNING: This Request message is not finalized and still subject to possible change or removal.

func (*DeleteBackfillRequest) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use DeleteBackfillRequest.ProtoReflect.Descriptor instead.

func (*DeleteBackfillRequest) GetBackfillId added in v1.2.0 

func (x *DeleteBackfillRequest) GetBackfillId() string

func (*DeleteBackfillRequest) ProtoMessage added in v1.2.0 

func (*DeleteBackfillRequest) ProtoMessage()

func (*DeleteBackfillRequest) ProtoReflect added in v1.2.0 

func (x *DeleteBackfillRequest) ProtoReflect() protoreflect.Message

func (*DeleteBackfillRequest) Reset added in v1.2.0 

func (x *DeleteBackfillRequest) Reset()

func (*DeleteBackfillRequest) String added in v1.2.0 

func (x *DeleteBackfillRequest) String() string

type DeleteTicketRequest 

type DeleteTicketRequest struct {

	// A TicketId of a generated Ticket to be deleted.
	TicketId string `protobuf:"bytes,1,opt,name=ticket_id,json=ticketId,proto3" json:"ticket_id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteTicketRequest) Descriptor deprecated 

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

Deprecated: Use DeleteTicketRequest.ProtoReflect.Descriptor instead.

func (*DeleteTicketRequest) GetTicketId 

func (x *DeleteTicketRequest) GetTicketId() string

func (*DeleteTicketRequest) ProtoMessage 

func (*DeleteTicketRequest) ProtoMessage()

func (*DeleteTicketRequest) ProtoReflect added in v1.2.0 

func (x *DeleteTicketRequest) ProtoReflect() protoreflect.Message

func (*DeleteTicketRequest) Reset 

func (x *DeleteTicketRequest) Reset()

func (*DeleteTicketRequest) String 

func (x *DeleteTicketRequest) String() string

type DoubleRangeFilter added in v0.8.0 

type DoubleRangeFilter struct {

	// Name of the ticket's search_fields.double_args this Filter operates on.
	DoubleArg string `protobuf:"bytes,1,opt,name=double_arg,json=doubleArg,proto3" json:"double_arg,omitempty"`
	// Maximum value.
	Max float64 `protobuf:"fixed64,2,opt,name=max,proto3" json:"max,omitempty"`
	// Minimum value.
	Min float64 `protobuf:"fixed64,3,opt,name=min,proto3" json:"min,omitempty"`
	// Defines the bounds to apply when filtering tickets by their search_fields.double_args value.
	// BETA FEATURE WARNING: This field and the associated values are
	// not finalized and still subject to possible change or removal.
	Exclude DoubleRangeFilter_Exclude `protobuf:"varint,4,opt,name=exclude,proto3,enum=openmatch.DoubleRangeFilter_Exclude" json:"exclude,omitempty"`
	// contains filtered or unexported fields
}

Filters numerical values to only those within a range. 

double_arg: "foo"
max: 10
min: 5

matches: 

{"foo": 5}
{"foo": 7.5}
{"foo": 10}

does not match: 

{"foo": 4}
{"foo": 10.01}
{"foo": "7.5"}
{}

func (*DoubleRangeFilter) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use DoubleRangeFilter.ProtoReflect.Descriptor instead.

func (*DoubleRangeFilter) GetDoubleArg added in v0.8.0 

func (x *DoubleRangeFilter) GetDoubleArg() string

func (*DoubleRangeFilter) GetExclude added in v1.2.0 

func (x *DoubleRangeFilter) GetExclude() DoubleRangeFilter_Exclude

func (*DoubleRangeFilter) GetMax added in v0.8.0 

func (x *DoubleRangeFilter) GetMax() float64

func (*DoubleRangeFilter) GetMin added in v0.8.0 

func (x *DoubleRangeFilter) GetMin() float64

func (*DoubleRangeFilter) ProtoMessage added in v0.8.0 

func (*DoubleRangeFilter) ProtoMessage()

func (*DoubleRangeFilter) ProtoReflect added in v1.2.0 

func (x *DoubleRangeFilter) ProtoReflect() protoreflect.Message

func (*DoubleRangeFilter) Reset added in v0.8.0 

func (x *DoubleRangeFilter) Reset()

func (*DoubleRangeFilter) String added in v0.8.0 

func (x *DoubleRangeFilter) String() string

type DoubleRangeFilter_Exclude added in v1.2.0 

type DoubleRangeFilter_Exclude int32
const (
	// No bounds should be excluded when evaluating the filter, i.e.: MIN <= x <= MAX
	DoubleRangeFilter_NONE DoubleRangeFilter_Exclude = 0
	// Only the minimum bound should be excluded when evaluating the filter, i.e.: MIN < x <= MAX
	DoubleRangeFilter_MIN DoubleRangeFilter_Exclude = 1
	// Only the maximum bound should be excluded when evaluating the filter, i.e.: MIN <= x < MAX
	DoubleRangeFilter_MAX DoubleRangeFilter_Exclude = 2
	// Both bounds should be excluded when evaluating the filter, i.e.: MIN < x < MAX
	DoubleRangeFilter_BOTH DoubleRangeFilter_Exclude = 3
)

func (DoubleRangeFilter_Exclude) Descriptor added in v1.2.0 

func (DoubleRangeFilter_Exclude) Descriptor() protoreflect.EnumDescriptor

func (DoubleRangeFilter_Exclude) Enum added in v1.2.0 

func (x DoubleRangeFilter_Exclude) Enum() *DoubleRangeFilter_Exclude

func (DoubleRangeFilter_Exclude) EnumDescriptor deprecated added in v1.2.0 

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

Deprecated: Use DoubleRangeFilter_Exclude.Descriptor instead.

func (DoubleRangeFilter_Exclude) Number added in v1.2.0 

func (x DoubleRangeFilter_Exclude) Number() protoreflect.EnumNumber

func (DoubleRangeFilter_Exclude) String added in v1.2.0 

func (x DoubleRangeFilter_Exclude) String() string

func (DoubleRangeFilter_Exclude) Type added in v1.2.0 

func (DoubleRangeFilter_Exclude) Type() protoreflect.EnumType

type EvaluateRequest 

type EvaluateRequest struct {

	// A Matches proposed by the Match Function representing a candidate of the final results.
	Match *Match `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	// contains filtered or unexported fields
}

func (*EvaluateRequest) Descriptor deprecated 

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

Deprecated: Use EvaluateRequest.ProtoReflect.Descriptor instead.

func (*EvaluateRequest) GetMatch added in v0.7.0 

func (x *EvaluateRequest) GetMatch() *Match

func (*EvaluateRequest) ProtoMessage 

func (*EvaluateRequest) ProtoMessage()

func (*EvaluateRequest) ProtoReflect added in v1.2.0 

func (x *EvaluateRequest) ProtoReflect() protoreflect.Message

func (*EvaluateRequest) Reset 

func (x *EvaluateRequest) Reset()

func (*EvaluateRequest) String 

func (x *EvaluateRequest) String() string

type EvaluateResponse 

type EvaluateResponse struct {

	// A Match ID representing a shortlisted match returned by the evaluator as the final result.
	MatchId string `protobuf:"bytes,2,opt,name=match_id,json=matchId,proto3" json:"match_id,omitempty"`
	// contains filtered or unexported fields
}

func (*EvaluateResponse) Descriptor deprecated 

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

Deprecated: Use EvaluateResponse.ProtoReflect.Descriptor instead.

func (*EvaluateResponse) GetMatchId added in v0.9.0 

func (x *EvaluateResponse) GetMatchId() string

func (*EvaluateResponse) ProtoMessage 

func (*EvaluateResponse) ProtoMessage()

func (*EvaluateResponse) ProtoReflect added in v1.2.0 

func (x *EvaluateResponse) ProtoReflect() protoreflect.Message

func (*EvaluateResponse) Reset 

func (x *EvaluateResponse) Reset()

func (*EvaluateResponse) String 

func (x *EvaluateResponse) String() string

type EvaluatorClient 

type EvaluatorClient interface {
	// Evaluate evaluates a list of proposed matches based on quality, collision status, and etc, then shortlist the matches and returns the final results.
	Evaluate(ctx context.Context, opts ...grpc.CallOption) (Evaluator_EvaluateClient, error)
}

EvaluatorClient is the client API for Evaluator service.

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

func NewEvaluatorClient 

func NewEvaluatorClient(cc grpc.ClientConnInterface) EvaluatorClient

type EvaluatorServer 

type EvaluatorServer interface {
	// Evaluate evaluates a list of proposed matches based on quality, collision status, and etc, then shortlist the matches and returns the final results.
	Evaluate(Evaluator_EvaluateServer) error
}

EvaluatorServer is the server API for Evaluator service.

type Evaluator_EvaluateClient added in v0.7.0 

type Evaluator_EvaluateClient interface {
	Send(*EvaluateRequest) error
	Recv() (*EvaluateResponse, error)
	grpc.ClientStream
}

type Evaluator_EvaluateServer added in v0.7.0 

type Evaluator_EvaluateServer interface {
	Send(*EvaluateResponse) error
	Recv() (*EvaluateRequest, error)
	grpc.ServerStream
}

type FetchMatchesRequest 

type FetchMatchesRequest struct {

	// A configuration for the MatchFunction server of this FetchMatches call.
	Config *FunctionConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// A MatchProfile that will be sent to the MatchFunction server of this FetchMatches call.
	Profile *MatchProfile `protobuf:"bytes,2,opt,name=profile,proto3" json:"profile,omitempty"`
	// contains filtered or unexported fields
}

func (*FetchMatchesRequest) Descriptor deprecated 

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

Deprecated: Use FetchMatchesRequest.ProtoReflect.Descriptor instead.

func (*FetchMatchesRequest) GetConfig 

func (x *FetchMatchesRequest) GetConfig() *FunctionConfig

func (*FetchMatchesRequest) GetProfile added in v0.9.0 

func (x *FetchMatchesRequest) GetProfile() *MatchProfile

func (*FetchMatchesRequest) ProtoMessage 

func (*FetchMatchesRequest) ProtoMessage()

func (*FetchMatchesRequest) ProtoReflect added in v1.2.0 

func (x *FetchMatchesRequest) ProtoReflect() protoreflect.Message

func (*FetchMatchesRequest) Reset 

func (x *FetchMatchesRequest) Reset()

func (*FetchMatchesRequest) String 

func (x *FetchMatchesRequest) String() string

type FetchMatchesResponse 

type FetchMatchesResponse struct {

	// A Match generated by the user-defined MMF with the specified MatchProfiles.
	// A valid Match response will contain at least one ticket.
	Match *Match `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	// contains filtered or unexported fields
}

func (*FetchMatchesResponse) Descriptor deprecated 

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

Deprecated: Use FetchMatchesResponse.ProtoReflect.Descriptor instead.

func (*FetchMatchesResponse) GetMatch added in v0.7.0 

func (x *FetchMatchesResponse) GetMatch() *Match

func (*FetchMatchesResponse) ProtoMessage 

func (*FetchMatchesResponse) ProtoMessage()

func (*FetchMatchesResponse) ProtoReflect added in v1.2.0 

func (x *FetchMatchesResponse) ProtoReflect() protoreflect.Message

func (*FetchMatchesResponse) Reset 

func (x *FetchMatchesResponse) Reset()

func (*FetchMatchesResponse) String 

func (x *FetchMatchesResponse) String() string

type FrontendServiceClient added in v0.9.0 

type FrontendServiceClient interface {
	// CreateTicket assigns an unique TicketId to the input Ticket and record it in state storage.
	// A ticket is considered as ready for matchmaking once it is created.
	//   - If a TicketId exists in a Ticket request, an auto-generated TicketId will override this field.
	//   - If SearchFields exist in a Ticket, CreateTicket will also index these fields such that one can query the ticket with query.QueryTickets function.
	CreateTicket(ctx context.Context, in *CreateTicketRequest, opts ...grpc.CallOption) (*Ticket, error)
	// DeleteTicket immediately stops Open Match from using the Ticket for matchmaking and removes the Ticket from state storage.
	// The client should delete the Ticket when finished matchmaking with it.
	DeleteTicket(ctx context.Context, in *DeleteTicketRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// GetTicket get the Ticket associated with the specified TicketId.
	GetTicket(ctx context.Context, in *GetTicketRequest, opts ...grpc.CallOption) (*Ticket, error)
	// WatchAssignments stream back Assignment of the specified TicketId if it is updated.
	//   - If the Assignment is not updated, GetAssignment will retry using the configured backoff strategy.
	WatchAssignments(ctx context.Context, in *WatchAssignmentsRequest, opts ...grpc.CallOption) (FrontendService_WatchAssignmentsClient, error)
	// AcknowledgeBackfill is used to notify OpenMatch about GameServer connection info
	// This triggers an assignment process.
	// BETA FEATURE WARNING: This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	AcknowledgeBackfill(ctx context.Context, in *AcknowledgeBackfillRequest, opts ...grpc.CallOption) (*Backfill, error)
	// CreateBackfill creates a new Backfill object.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	CreateBackfill(ctx context.Context, in *CreateBackfillRequest, opts ...grpc.CallOption) (*Backfill, error)
	// DeleteBackfill receives a backfill ID and deletes its resource.
	// Any tickets waiting for this backfill will be returned to the active pool, no longer pending.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	DeleteBackfill(ctx context.Context, in *DeleteBackfillRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// GetBackfill returns a backfill object by its ID.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	GetBackfill(ctx context.Context, in *GetBackfillRequest, opts ...grpc.CallOption) (*Backfill, error)
	// UpdateBackfill updates search_fields and extensions for the backfill with the provided id.
	// Any tickets waiting for this backfill will be returned to the active pool, no longer pending.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	UpdateBackfill(ctx context.Context, in *UpdateBackfillRequest, opts ...grpc.CallOption) (*Backfill, error)
}

FrontendServiceClient is the client API for FrontendService service.

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

func NewFrontendServiceClient added in v0.9.0 

func NewFrontendServiceClient(cc grpc.ClientConnInterface) FrontendServiceClient

type FrontendServiceServer added in v0.9.0 

type FrontendServiceServer interface {
	// CreateTicket assigns an unique TicketId to the input Ticket and record it in state storage.
	// A ticket is considered as ready for matchmaking once it is created.
	//   - If a TicketId exists in a Ticket request, an auto-generated TicketId will override this field.
	//   - If SearchFields exist in a Ticket, CreateTicket will also index these fields such that one can query the ticket with query.QueryTickets function.
	CreateTicket(context.Context, *CreateTicketRequest) (*Ticket, error)
	// DeleteTicket immediately stops Open Match from using the Ticket for matchmaking and removes the Ticket from state storage.
	// The client should delete the Ticket when finished matchmaking with it.
	DeleteTicket(context.Context, *DeleteTicketRequest) (*empty.Empty, error)
	// GetTicket get the Ticket associated with the specified TicketId.
	GetTicket(context.Context, *GetTicketRequest) (*Ticket, error)
	// WatchAssignments stream back Assignment of the specified TicketId if it is updated.
	//   - If the Assignment is not updated, GetAssignment will retry using the configured backoff strategy.
	WatchAssignments(*WatchAssignmentsRequest, FrontendService_WatchAssignmentsServer) error
	// AcknowledgeBackfill is used to notify OpenMatch about GameServer connection info
	// This triggers an assignment process.
	// BETA FEATURE WARNING: This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	AcknowledgeBackfill(context.Context, *AcknowledgeBackfillRequest) (*Backfill, error)
	// CreateBackfill creates a new Backfill object.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	CreateBackfill(context.Context, *CreateBackfillRequest) (*Backfill, error)
	// DeleteBackfill receives a backfill ID and deletes its resource.
	// Any tickets waiting for this backfill will be returned to the active pool, no longer pending.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	DeleteBackfill(context.Context, *DeleteBackfillRequest) (*empty.Empty, error)
	// GetBackfill returns a backfill object by its ID.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	GetBackfill(context.Context, *GetBackfillRequest) (*Backfill, error)
	// UpdateBackfill updates search_fields and extensions for the backfill with the provided id.
	// Any tickets waiting for this backfill will be returned to the active pool, no longer pending.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	UpdateBackfill(context.Context, *UpdateBackfillRequest) (*Backfill, error)
}

FrontendServiceServer is the server API for FrontendService service.

type FrontendService_WatchAssignmentsClient added in v0.10.0 

type FrontendService_WatchAssignmentsClient interface {
	Recv() (*WatchAssignmentsResponse, error)
	grpc.ClientStream
}

type FrontendService_WatchAssignmentsServer added in v0.10.0 

type FrontendService_WatchAssignmentsServer interface {
	Send(*WatchAssignmentsResponse) error
	grpc.ServerStream
}

type FunctionConfig 

type FunctionConfig struct {
	Host string              `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`
	Port int32               `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"`
	Type FunctionConfig_Type `protobuf:"varint,3,opt,name=type,proto3,enum=openmatch.FunctionConfig_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

FunctionConfig specifies a MMF address and client type for Backend to establish connections with the MMF

func (*FunctionConfig) Descriptor deprecated 

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

Deprecated: Use FunctionConfig.ProtoReflect.Descriptor instead.

func (*FunctionConfig) GetHost 

func (x *FunctionConfig) GetHost() string

func (*FunctionConfig) GetPort 

func (x *FunctionConfig) GetPort() int32

func (*FunctionConfig) GetType 

func (x *FunctionConfig) GetType() FunctionConfig_Type

func (*FunctionConfig) ProtoMessage 

func (*FunctionConfig) ProtoMessage()

func (*FunctionConfig) ProtoReflect added in v1.2.0 

func (x *FunctionConfig) ProtoReflect() protoreflect.Message

func (*FunctionConfig) Reset 

func (x *FunctionConfig) Reset()

func (*FunctionConfig) String 

func (x *FunctionConfig) String() string

type FunctionConfig_Type 

type FunctionConfig_Type int32
const (
	FunctionConfig_GRPC FunctionConfig_Type = 0
	FunctionConfig_REST FunctionConfig_Type = 1
)

func (FunctionConfig_Type) Descriptor added in v1.2.0 

func (FunctionConfig_Type) Descriptor() protoreflect.EnumDescriptor

func (FunctionConfig_Type) Enum added in v1.2.0 

func (x FunctionConfig_Type) Enum() *FunctionConfig_Type

func (FunctionConfig_Type) EnumDescriptor deprecated 

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

Deprecated: Use FunctionConfig_Type.Descriptor instead.

func (FunctionConfig_Type) Number added in v1.2.0 

func (x FunctionConfig_Type) Number() protoreflect.EnumNumber

func (FunctionConfig_Type) String 

func (x FunctionConfig_Type) String() string

func (FunctionConfig_Type) Type added in v1.2.0 

func (FunctionConfig_Type) Type() protoreflect.EnumType

type GetBackfillRequest added in v1.2.0 

type GetBackfillRequest struct {

	// An existing ID of Backfill to retrieve.
	BackfillId string `protobuf:"bytes,1,opt,name=backfill_id,json=backfillId,proto3" json:"backfill_id,omitempty"`
	// contains filtered or unexported fields
}

BETA FEATURE WARNING: This Request message is not finalized and still subject to possible change or removal.

func (*GetBackfillRequest) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use GetBackfillRequest.ProtoReflect.Descriptor instead.

func (*GetBackfillRequest) GetBackfillId added in v1.2.0 

func (x *GetBackfillRequest) GetBackfillId() string

func (*GetBackfillRequest) ProtoMessage added in v1.2.0 

func (*GetBackfillRequest) ProtoMessage()

func (*GetBackfillRequest) ProtoReflect added in v1.2.0 

func (x *GetBackfillRequest) ProtoReflect() protoreflect.Message

func (*GetBackfillRequest) Reset added in v1.2.0 

func (x *GetBackfillRequest) Reset()

func (*GetBackfillRequest) String added in v1.2.0 

func (x *GetBackfillRequest) String() string

type GetTicketRequest 

type GetTicketRequest struct {

	// A TicketId of a generated Ticket.
	TicketId string `protobuf:"bytes,1,opt,name=ticket_id,json=ticketId,proto3" json:"ticket_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTicketRequest) Descriptor deprecated 

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

Deprecated: Use GetTicketRequest.ProtoReflect.Descriptor instead.

func (*GetTicketRequest) GetTicketId 

func (x *GetTicketRequest) GetTicketId() string

func (*GetTicketRequest) ProtoMessage 

func (*GetTicketRequest) ProtoMessage()

func (*GetTicketRequest) ProtoReflect added in v1.2.0 

func (x *GetTicketRequest) ProtoReflect() protoreflect.Message

func (*GetTicketRequest) Reset 

func (x *GetTicketRequest) Reset()

func (*GetTicketRequest) String 

func (x *GetTicketRequest) String() string

type Match 

type Match struct {

	// A Match ID that should be passed through the stack for tracing.
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId,proto3" json:"match_id,omitempty"`
	// Name of the match profile that generated this Match.
	MatchProfile string `protobuf:"bytes,2,opt,name=match_profile,json=matchProfile,proto3" json:"match_profile,omitempty"`
	// Name of the match function that generated this Match.
	MatchFunction string `protobuf:"bytes,3,opt,name=match_function,json=matchFunction,proto3" json:"match_function,omitempty"`
	// Tickets belonging to this match.
	Tickets []*Ticket `protobuf:"bytes,4,rep,name=tickets,proto3" json:"tickets,omitempty"`
	// Customized information not inspected by Open Match, to be used by the match
	// making function, evaluator, and components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions map[string]*any.Any `` /* 161-byte string literal not displayed */
	// Backfill request which contains additional information to the match
	// and contains an association to a GameServer.
	// BETA FEATURE WARNING: This field is not finalized and still subject
	// to possible change or removal.
	Backfill *Backfill `protobuf:"bytes,8,opt,name=backfill,proto3" json:"backfill,omitempty"`
	// AllocateGameServer signalise Director that Backfill is new and it should
	// allocate a GameServer, this Backfill would be assigned.
	// BETA FEATURE WARNING: This field is not finalized and still subject
	// to possible change or removal.
	AllocateGameserver bool `protobuf:"varint,9,opt,name=allocate_gameserver,json=allocateGameserver,proto3" json:"allocate_gameserver,omitempty"`
	// contains filtered or unexported fields
}

A Match is used to represent a completed match object. It can be generated by a MatchFunction as a proposal or can be returned by OpenMatch as a result in response to the FetchMatches call. When a match is returned by the FetchMatches call, it should contain at least one ticket to be considered as valid.

func (*Match) Descriptor deprecated 

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

Deprecated: Use Match.ProtoReflect.Descriptor instead.

func (*Match) GetAllocateGameserver added in v1.2.0 

func (x *Match) GetAllocateGameserver() bool

func (*Match) GetBackfill added in v1.2.0 

func (x *Match) GetBackfill() *Backfill

func (*Match) GetExtensions added in v0.8.0 

func (x *Match) GetExtensions() map[string]*any.Any

func (*Match) GetMatchFunction 

func (x *Match) GetMatchFunction() string

func (*Match) GetMatchId 

func (x *Match) GetMatchId() string

func (*Match) GetMatchProfile 

func (x *Match) GetMatchProfile() string

func (*Match) GetTickets 

func (x *Match) GetTickets() []*Ticket

func (*Match) ProtoMessage 

func (*Match) ProtoMessage()

func (*Match) ProtoReflect added in v1.2.0 

func (x *Match) ProtoReflect() protoreflect.Message

func (*Match) Reset 

func (x *Match) Reset()

func (*Match) String 

func (x *Match) String() string

type MatchFunctionClient 

type MatchFunctionClient interface {
	// DO NOT CALL THIS FUNCTION MANUALLY. USE backend.FetchMatches INSTEAD.
	// Run pulls Tickets that satisfy Profile constraints from QueryService,
	// runs matchmaking logic against them, then constructs and streams back
	// match candidates to the Backend service.
	Run(ctx context.Context, in *RunRequest, opts ...grpc.CallOption) (MatchFunction_RunClient, 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 

func NewMatchFunctionClient(cc grpc.ClientConnInterface) MatchFunctionClient

type MatchFunctionServer 

type MatchFunctionServer interface {
	// DO NOT CALL THIS FUNCTION MANUALLY. USE backend.FetchMatches INSTEAD.
	// Run pulls Tickets that satisfy Profile constraints from QueryService,
	// runs matchmaking logic against them, then constructs and streams back
	// match candidates to the Backend service.
	Run(*RunRequest, MatchFunction_RunServer) error
}

MatchFunctionServer is the server API for MatchFunction service.

type MatchFunction_RunClient added in v0.7.0 

type MatchFunction_RunClient interface {
	Recv() (*RunResponse, error)
	grpc.ClientStream
}

type MatchFunction_RunServer added in v0.7.0 

type MatchFunction_RunServer interface {
	Send(*RunResponse) error
	grpc.ServerStream
}

type MatchProfile 

type MatchProfile struct {

	// Name of this match profile.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Set of pools to be queried when generating a match for this MatchProfile.
	Pools []*Pool `protobuf:"bytes,3,rep,name=pools,proto3" json:"pools,omitempty"`
	// Customized information not inspected by Open Match, to be used by the match
	// making function, evaluator, and components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions map[string]*any.Any `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

A MatchProfile is Open Match's representation of a Match specification. It is used to indicate the criteria for selecting players for a match. A MatchProfile is the input to the API to get matches and is passed to the MatchFunction. It contains all the information required by the MatchFunction to generate match proposals.

func (*MatchProfile) Descriptor deprecated 

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

Deprecated: Use MatchProfile.ProtoReflect.Descriptor instead.

func (*MatchProfile) GetExtensions added in v0.8.0 

func (x *MatchProfile) GetExtensions() map[string]*any.Any

func (*MatchProfile) GetName 

func (x *MatchProfile) GetName() string

func (*MatchProfile) GetPools 

func (x *MatchProfile) GetPools() []*Pool

func (*MatchProfile) ProtoMessage 

func (*MatchProfile) ProtoMessage()

func (*MatchProfile) ProtoReflect added in v1.2.0 

func (x *MatchProfile) ProtoReflect() protoreflect.Message

func (*MatchProfile) Reset 

func (x *MatchProfile) Reset()

func (*MatchProfile) String 

func (x *MatchProfile) String() string

type Pool 

type Pool struct {

	// A developer-chosen human-readable name for this Pool.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Set of Filters indicating the filtering criteria. Selected tickets must
	// match every Filter.
	DoubleRangeFilters  []*DoubleRangeFilter  `protobuf:"bytes,2,rep,name=double_range_filters,json=doubleRangeFilters,proto3" json:"double_range_filters,omitempty"`
	StringEqualsFilters []*StringEqualsFilter `protobuf:"bytes,4,rep,name=string_equals_filters,json=stringEqualsFilters,proto3" json:"string_equals_filters,omitempty"`
	TagPresentFilters   []*TagPresentFilter   `protobuf:"bytes,5,rep,name=tag_present_filters,json=tagPresentFilters,proto3" json:"tag_present_filters,omitempty"`
	// If specified, only Tickets created before the specified time are selected.
	CreatedBefore *timestamp.Timestamp `protobuf:"bytes,6,opt,name=created_before,json=createdBefore,proto3" json:"created_before,omitempty"`
	// If specified, only Tickets created after the specified time are selected.
	CreatedAfter *timestamp.Timestamp `protobuf:"bytes,7,opt,name=created_after,json=createdAfter,proto3" json:"created_after,omitempty"`
	// contains filtered or unexported fields
}

Pool specfies a set of criteria that are used to select a subset of Tickets that meet all the criteria.

func (*Pool) Descriptor deprecated 

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

Deprecated: Use Pool.ProtoReflect.Descriptor instead.

func (*Pool) GetCreatedAfter added in v0.10.0 

func (x *Pool) GetCreatedAfter() *timestamp.Timestamp

func (*Pool) GetCreatedBefore added in v0.10.0 

func (x *Pool) GetCreatedBefore() *timestamp.Timestamp

func (*Pool) GetDoubleRangeFilters added in v0.8.0 

func (x *Pool) GetDoubleRangeFilters() []*DoubleRangeFilter

func (*Pool) GetName 

func (x *Pool) GetName() string

func (*Pool) GetStringEqualsFilters added in v0.7.0 

func (x *Pool) GetStringEqualsFilters() []*StringEqualsFilter

func (*Pool) GetTagPresentFilters added in v0.8.0 

func (x *Pool) GetTagPresentFilters() []*TagPresentFilter

func (*Pool) ProtoMessage 

func (*Pool) ProtoMessage()

func (*Pool) ProtoReflect added in v1.2.0 

func (x *Pool) ProtoReflect() protoreflect.Message

func (*Pool) Reset 

func (x *Pool) Reset()

func (*Pool) String 

func (x *Pool) String() string

type QueryBackfillsRequest added in v1.2.0 

type QueryBackfillsRequest struct {

	// The Pool representing the set of Filters to be queried.
	Pool *Pool `protobuf:"bytes,1,opt,name=pool,proto3" json:"pool,omitempty"`
	// contains filtered or unexported fields
}

BETA FEATURE WARNING: This Request messages are not finalized and still subject to possible change or removal.

func (*QueryBackfillsRequest) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use QueryBackfillsRequest.ProtoReflect.Descriptor instead.

func (*QueryBackfillsRequest) GetPool added in v1.2.0 

func (x *QueryBackfillsRequest) GetPool() *Pool

func (*QueryBackfillsRequest) ProtoMessage added in v1.2.0 

func (*QueryBackfillsRequest) ProtoMessage()

func (*QueryBackfillsRequest) ProtoReflect added in v1.2.0 

func (x *QueryBackfillsRequest) ProtoReflect() protoreflect.Message

func (*QueryBackfillsRequest) Reset added in v1.2.0 

func (x *QueryBackfillsRequest) Reset()

func (*QueryBackfillsRequest) String added in v1.2.0 

func (x *QueryBackfillsRequest) String() string

type QueryBackfillsResponse added in v1.2.0 

type QueryBackfillsResponse struct {

	// Backfills that meet all the filtering criteria requested by the pool.
	Backfills []*Backfill `protobuf:"bytes,1,rep,name=backfills,proto3" json:"backfills,omitempty"`
	// contains filtered or unexported fields
}

BETA FEATURE WARNING: This Request messages are not finalized and still subject to possible change or removal.

func (*QueryBackfillsResponse) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use QueryBackfillsResponse.ProtoReflect.Descriptor instead.

func (*QueryBackfillsResponse) GetBackfills added in v1.2.0 

func (x *QueryBackfillsResponse) GetBackfills() []*Backfill

func (*QueryBackfillsResponse) ProtoMessage added in v1.2.0 

func (*QueryBackfillsResponse) ProtoMessage()

func (*QueryBackfillsResponse) ProtoReflect added in v1.2.0 

func (x *QueryBackfillsResponse) ProtoReflect() protoreflect.Message

func (*QueryBackfillsResponse) Reset added in v1.2.0 

func (x *QueryBackfillsResponse) Reset()

func (*QueryBackfillsResponse) String added in v1.2.0 

func (x *QueryBackfillsResponse) String() string

type QueryServiceClient added in v0.9.0 

type QueryServiceClient interface {
	// QueryTickets gets a list of Tickets that match all Filters of the input Pool.
	//   - If the Pool contains no Filters, QueryTickets will return all Tickets in the state storage.
	// QueryTickets pages the Tickets by `queryPageSize` and stream back responses.
	//   - queryPageSize is default to 1000 if not set, and has a minimum of 10 and maximum of 10000.
	QueryTickets(ctx context.Context, in *QueryTicketsRequest, opts ...grpc.CallOption) (QueryService_QueryTicketsClient, error)
	// QueryTicketIds gets the list of TicketIDs that meet all the filtering criteria requested by the pool.
	//   - If the Pool contains no Filters, QueryTicketIds will return all TicketIDs in the state storage.
	// QueryTicketIds pages the TicketIDs by `queryPageSize` and stream back responses.
	//   - queryPageSize is default to 1000 if not set, and has a minimum of 10 and maximum of 10000.
	QueryTicketIds(ctx context.Context, in *QueryTicketIdsRequest, opts ...grpc.CallOption) (QueryService_QueryTicketIdsClient, error)
	// QueryBackfills gets a list of Backfills.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	QueryBackfills(ctx context.Context, in *QueryBackfillsRequest, opts ...grpc.CallOption) (QueryService_QueryBackfillsClient, error)
}

QueryServiceClient is the client API for QueryService service.

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

func NewQueryServiceClient added in v0.9.0 

func NewQueryServiceClient(cc grpc.ClientConnInterface) QueryServiceClient

type QueryServiceServer added in v0.9.0 

type QueryServiceServer interface {
	// QueryTickets gets a list of Tickets that match all Filters of the input Pool.
	//   - If the Pool contains no Filters, QueryTickets will return all Tickets in the state storage.
	// QueryTickets pages the Tickets by `queryPageSize` and stream back responses.
	//   - queryPageSize is default to 1000 if not set, and has a minimum of 10 and maximum of 10000.
	QueryTickets(*QueryTicketsRequest, QueryService_QueryTicketsServer) error
	// QueryTicketIds gets the list of TicketIDs that meet all the filtering criteria requested by the pool.
	//   - If the Pool contains no Filters, QueryTicketIds will return all TicketIDs in the state storage.
	// QueryTicketIds pages the TicketIDs by `queryPageSize` and stream back responses.
	//   - queryPageSize is default to 1000 if not set, and has a minimum of 10 and maximum of 10000.
	QueryTicketIds(*QueryTicketIdsRequest, QueryService_QueryTicketIdsServer) error
	// QueryBackfills gets a list of Backfills.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	QueryBackfills(*QueryBackfillsRequest, QueryService_QueryBackfillsServer) error
}

QueryServiceServer is the server API for QueryService service.

type QueryService_QueryBackfillsClient added in v1.2.0 

type QueryService_QueryBackfillsClient interface {
	Recv() (*QueryBackfillsResponse, error)
	grpc.ClientStream
}

type QueryService_QueryBackfillsServer added in v1.2.0 

type QueryService_QueryBackfillsServer interface {
	Send(*QueryBackfillsResponse) error
	grpc.ServerStream
}

type QueryService_QueryTicketIdsClient added in v0.10.0 

type QueryService_QueryTicketIdsClient interface {
	Recv() (*QueryTicketIdsResponse, error)
	grpc.ClientStream
}

type QueryService_QueryTicketIdsServer added in v0.10.0 

type QueryService_QueryTicketIdsServer interface {
	Send(*QueryTicketIdsResponse) error
	grpc.ServerStream
}

type QueryService_QueryTicketsClient added in v0.9.0 

type QueryService_QueryTicketsClient interface {
	Recv() (*QueryTicketsResponse, error)
	grpc.ClientStream
}

type QueryService_QueryTicketsServer added in v0.9.0 

type QueryService_QueryTicketsServer interface {
	Send(*QueryTicketsResponse) error
	grpc.ServerStream
}

type QueryTicketIdsRequest added in v0.10.0 

type QueryTicketIdsRequest struct {

	// The Pool representing the set of Filters to be queried.
	Pool *Pool `protobuf:"bytes,1,opt,name=pool,proto3" json:"pool,omitempty"`
	// contains filtered or unexported fields
}

func (*QueryTicketIdsRequest) Descriptor deprecated added in v0.10.0 

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

Deprecated: Use QueryTicketIdsRequest.ProtoReflect.Descriptor instead.

func (*QueryTicketIdsRequest) GetPool added in v0.10.0 

func (x *QueryTicketIdsRequest) GetPool() *Pool

func (*QueryTicketIdsRequest) ProtoMessage added in v0.10.0 

func (*QueryTicketIdsRequest) ProtoMessage()

func (*QueryTicketIdsRequest) ProtoReflect added in v1.2.0 

func (x *QueryTicketIdsRequest) ProtoReflect() protoreflect.Message

func (*QueryTicketIdsRequest) Reset added in v0.10.0 

func (x *QueryTicketIdsRequest) Reset()

func (*QueryTicketIdsRequest) String added in v0.10.0 

func (x *QueryTicketIdsRequest) String() string

type QueryTicketIdsResponse added in v0.10.0 

type QueryTicketIdsResponse struct {

	// TicketIDs that meet all the filtering criteria requested by the pool.
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

func (*QueryTicketIdsResponse) Descriptor deprecated added in v0.10.0 

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

Deprecated: Use QueryTicketIdsResponse.ProtoReflect.Descriptor instead.

func (*QueryTicketIdsResponse) GetIds added in v0.10.0 

func (x *QueryTicketIdsResponse) GetIds() []string

func (*QueryTicketIdsResponse) ProtoMessage added in v0.10.0 

func (*QueryTicketIdsResponse) ProtoMessage()

func (*QueryTicketIdsResponse) ProtoReflect added in v1.2.0 

func (x *QueryTicketIdsResponse) ProtoReflect() protoreflect.Message

func (*QueryTicketIdsResponse) Reset added in v0.10.0 

func (x *QueryTicketIdsResponse) Reset()

func (*QueryTicketIdsResponse) String added in v0.10.0 

func (x *QueryTicketIdsResponse) String() string

type QueryTicketsRequest 

type QueryTicketsRequest struct {

	// The Pool representing the set of Filters to be queried.
	Pool *Pool `protobuf:"bytes,1,opt,name=pool,proto3" json:"pool,omitempty"`
	// contains filtered or unexported fields
}

func (*QueryTicketsRequest) Descriptor deprecated 

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

Deprecated: Use QueryTicketsRequest.ProtoReflect.Descriptor instead.

func (*QueryTicketsRequest) GetPool 

func (x *QueryTicketsRequest) GetPool() *Pool

func (*QueryTicketsRequest) ProtoMessage 

func (*QueryTicketsRequest) ProtoMessage()

func (*QueryTicketsRequest) ProtoReflect added in v1.2.0 

func (x *QueryTicketsRequest) ProtoReflect() protoreflect.Message

func (*QueryTicketsRequest) Reset 

func (x *QueryTicketsRequest) Reset()

func (*QueryTicketsRequest) String 

func (x *QueryTicketsRequest) String() string

type QueryTicketsResponse 

type QueryTicketsResponse struct {

	// Tickets that meet all the filtering criteria requested by the pool.
	Tickets []*Ticket `protobuf:"bytes,1,rep,name=tickets,proto3" json:"tickets,omitempty"`
	// contains filtered or unexported fields
}

func (*QueryTicketsResponse) Descriptor deprecated 

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

Deprecated: Use QueryTicketsResponse.ProtoReflect.Descriptor instead.

func (*QueryTicketsResponse) GetTickets 

func (x *QueryTicketsResponse) GetTickets() []*Ticket

func (*QueryTicketsResponse) ProtoMessage 

func (*QueryTicketsResponse) ProtoMessage()

func (*QueryTicketsResponse) ProtoReflect added in v1.2.0 

func (x *QueryTicketsResponse) ProtoReflect() protoreflect.Message

func (*QueryTicketsResponse) Reset 

func (x *QueryTicketsResponse) Reset()

func (*QueryTicketsResponse) String 

func (x *QueryTicketsResponse) String() string

type ReleaseAllTicketsRequest added in v1.0.0 

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

func (*ReleaseAllTicketsRequest) Descriptor deprecated added in v1.0.0 

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

Deprecated: Use ReleaseAllTicketsRequest.ProtoReflect.Descriptor instead.

func (*ReleaseAllTicketsRequest) ProtoMessage added in v1.0.0 

func (*ReleaseAllTicketsRequest) ProtoMessage()

func (*ReleaseAllTicketsRequest) ProtoReflect added in v1.2.0 

func (x *ReleaseAllTicketsRequest) ProtoReflect() protoreflect.Message

func (*ReleaseAllTicketsRequest) Reset added in v1.0.0 

func (x *ReleaseAllTicketsRequest) Reset()

func (*ReleaseAllTicketsRequest) String added in v1.0.0 

func (x *ReleaseAllTicketsRequest) String() string

type ReleaseAllTicketsResponse added in v1.0.0 

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

func (*ReleaseAllTicketsResponse) Descriptor deprecated added in v1.0.0 

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

Deprecated: Use ReleaseAllTicketsResponse.ProtoReflect.Descriptor instead.

func (*ReleaseAllTicketsResponse) ProtoMessage added in v1.0.0 

func (*ReleaseAllTicketsResponse) ProtoMessage()

func (*ReleaseAllTicketsResponse) ProtoReflect added in v1.2.0 

func (x *ReleaseAllTicketsResponse) ProtoReflect() protoreflect.Message

func (*ReleaseAllTicketsResponse) Reset added in v1.0.0 

func (x *ReleaseAllTicketsResponse) Reset()

func (*ReleaseAllTicketsResponse) String added in v1.0.0 

func (x *ReleaseAllTicketsResponse) String() string

type ReleaseTicketsRequest added in v0.9.0 

type ReleaseTicketsRequest struct {

	// TicketIds is a list of string representing Open Match generated Ids to be re-enabled for MMF querying
	// because they are no longer awaiting assignment from a previous match result
	TicketIds []string `protobuf:"bytes,1,rep,name=ticket_ids,json=ticketIds,proto3" json:"ticket_ids,omitempty"`
	// contains filtered or unexported fields
}

func (*ReleaseTicketsRequest) Descriptor deprecated added in v0.9.0 

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

Deprecated: Use ReleaseTicketsRequest.ProtoReflect.Descriptor instead.

func (*ReleaseTicketsRequest) GetTicketIds added in v0.9.0 

func (x *ReleaseTicketsRequest) GetTicketIds() []string

func (*ReleaseTicketsRequest) ProtoMessage added in v0.9.0 

func (*ReleaseTicketsRequest) ProtoMessage()

func (*ReleaseTicketsRequest) ProtoReflect added in v1.2.0 

func (x *ReleaseTicketsRequest) ProtoReflect() protoreflect.Message

func (*ReleaseTicketsRequest) Reset added in v0.9.0 

func (x *ReleaseTicketsRequest) Reset()

func (*ReleaseTicketsRequest) String added in v0.9.0 

func (x *ReleaseTicketsRequest) String() string

type ReleaseTicketsResponse added in v0.9.0 

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

func (*ReleaseTicketsResponse) Descriptor deprecated added in v0.9.0 

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

Deprecated: Use ReleaseTicketsResponse.ProtoReflect.Descriptor instead.

func (*ReleaseTicketsResponse) ProtoMessage added in v0.9.0 

func (*ReleaseTicketsResponse) ProtoMessage()

func (*ReleaseTicketsResponse) ProtoReflect added in v1.2.0 

func (x *ReleaseTicketsResponse) ProtoReflect() protoreflect.Message

func (*ReleaseTicketsResponse) Reset added in v0.9.0 

func (x *ReleaseTicketsResponse) Reset()

func (*ReleaseTicketsResponse) String added in v0.9.0 

func (x *ReleaseTicketsResponse) String() string

type RunRequest 

type RunRequest struct {

	// A MatchProfile defines constraints of Tickets in a Match and shapes the Match proposed by the MatchFunction.
	Profile *MatchProfile `protobuf:"bytes,1,opt,name=profile,proto3" json:"profile,omitempty"`
	// contains filtered or unexported fields
}

func (*RunRequest) Descriptor deprecated 

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

Deprecated: Use RunRequest.ProtoReflect.Descriptor instead.

func (*RunRequest) GetProfile 

func (x *RunRequest) GetProfile() *MatchProfile

func (*RunRequest) ProtoMessage 

func (*RunRequest) ProtoMessage()

func (*RunRequest) ProtoReflect added in v1.2.0 

func (x *RunRequest) ProtoReflect() protoreflect.Message

func (*RunRequest) Reset 

func (x *RunRequest) Reset()

func (*RunRequest) String 

func (x *RunRequest) String() string

type RunResponse 

type RunResponse struct {

	// A Proposal represents a Match candidate that satifies the constraints defined in the input Profile.
	// A valid Proposal response will contain at least one ticket.
	Proposal *Match `protobuf:"bytes,1,opt,name=proposal,proto3" json:"proposal,omitempty"`
	// contains filtered or unexported fields
}

func (*RunResponse) Descriptor deprecated 

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

Deprecated: Use RunResponse.ProtoReflect.Descriptor instead.

func (*RunResponse) GetProposal added in v0.7.0 

func (x *RunResponse) GetProposal() *Match

func (*RunResponse) ProtoMessage 

func (*RunResponse) ProtoMessage()

func (*RunResponse) ProtoReflect added in v1.2.0 

func (x *RunResponse) ProtoReflect() protoreflect.Message

func (*RunResponse) Reset 

func (x *RunResponse) Reset()

func (*RunResponse) String 

func (x *RunResponse) String() string

type SearchFields added in v0.8.0 

type SearchFields struct {

	// Float arguments.  Filterable on ranges.
	DoubleArgs map[string]float64 `` /* 181-byte string literal not displayed */
	// String arguments.  Filterable on equality.
	StringArgs map[string]string `` /* 179-byte string literal not displayed */
	// Filterable on presence or absence of given value.
	Tags []string `protobuf:"bytes,3,rep,name=tags,proto3" json:"tags,omitempty"`
	// contains filtered or unexported fields
}

Search fields are the fields which Open Match is aware of, and can be used when specifying filters.

func (*SearchFields) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use SearchFields.ProtoReflect.Descriptor instead.

func (*SearchFields) GetDoubleArgs added in v0.8.0 

func (x *SearchFields) GetDoubleArgs() map[string]float64

func (*SearchFields) GetStringArgs added in v0.8.0 

func (x *SearchFields) GetStringArgs() map[string]string

func (*SearchFields) GetTags added in v0.8.0 

func (x *SearchFields) GetTags() []string

func (*SearchFields) ProtoMessage added in v0.8.0 

func (*SearchFields) ProtoMessage()

func (*SearchFields) ProtoReflect added in v1.2.0 

func (x *SearchFields) ProtoReflect() protoreflect.Message

func (*SearchFields) Reset added in v0.8.0 

func (x *SearchFields) Reset()

func (*SearchFields) String added in v0.8.0 

func (x *SearchFields) String() string

type StringEqualsFilter added in v0.7.0 

type StringEqualsFilter struct {

	// Name of the ticket's search_fields.string_args this Filter operates on.
	StringArg string `protobuf:"bytes,1,opt,name=string_arg,json=stringArg,proto3" json:"string_arg,omitempty"`
	Value     string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Filters strings exactly equaling a value. 

string_arg: "foo"
value: "bar"

matches: 

{"foo": "bar"}

does not match: 

{"foo": "baz"}
{"bar": "foo"}
{}

func (*StringEqualsFilter) Descriptor deprecated added in v0.7.0 

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

Deprecated: Use StringEqualsFilter.ProtoReflect.Descriptor instead.

func (*StringEqualsFilter) GetStringArg added in v0.8.0 

func (x *StringEqualsFilter) GetStringArg() string

func (*StringEqualsFilter) GetValue added in v0.7.0 

func (x *StringEqualsFilter) GetValue() string

func (*StringEqualsFilter) ProtoMessage added in v0.7.0 

func (*StringEqualsFilter) ProtoMessage()

func (*StringEqualsFilter) ProtoReflect added in v1.2.0 

func (x *StringEqualsFilter) ProtoReflect() protoreflect.Message

func (*StringEqualsFilter) Reset added in v0.7.0 

func (x *StringEqualsFilter) Reset()

func (*StringEqualsFilter) String added in v0.7.0 

func (x *StringEqualsFilter) String() string

type TagPresentFilter added in v0.8.0 

type TagPresentFilter struct {
	Tag string `protobuf:"bytes,1,opt,name=tag,proto3" json:"tag,omitempty"`
	// contains filtered or unexported fields
}

Filters to the tag being present on the search_fields. 

tag: "foo"

matches: 

["foo"]
["bar","foo"]

does not match: 

["bar"]
[]

func (*TagPresentFilter) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use TagPresentFilter.ProtoReflect.Descriptor instead.

func (*TagPresentFilter) GetTag added in v0.8.0 

func (x *TagPresentFilter) GetTag() string

func (*TagPresentFilter) ProtoMessage added in v0.8.0 

func (*TagPresentFilter) ProtoMessage()

func (*TagPresentFilter) ProtoReflect added in v1.2.0 

func (x *TagPresentFilter) ProtoReflect() protoreflect.Message

func (*TagPresentFilter) Reset added in v0.8.0 

func (x *TagPresentFilter) Reset()

func (*TagPresentFilter) String added in v0.8.0 

func (x *TagPresentFilter) String() string

type Ticket 

type Ticket struct {

	// Id represents an auto-generated Id issued by Open Match.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// An Assignment represents a game server assignment associated with a Ticket,
	// or whatever finalized matched state means for your use case.
	// Open Match does not require or inspect any fields on Assignment.
	Assignment *Assignment `protobuf:"bytes,3,opt,name=assignment,proto3" json:"assignment,omitempty"`
	// Search fields are the fields which Open Match is aware of, and can be used
	// when specifying filters.
	SearchFields *SearchFields `protobuf:"bytes,4,opt,name=search_fields,json=searchFields,proto3" json:"search_fields,omitempty"`
	// Customized information not inspected by Open Match, to be used by the match
	// making function, evaluator, and components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions map[string]*any.Any `` /* 161-byte string literal not displayed */
	// Create time is the time the Ticket was created. It is populated by Open
	// Match at the time of Ticket creation.
	CreateTime *timestamp.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

A Ticket is a basic matchmaking entity in Open Match. A Ticket may represent an individual 'Player', a 'Group' of players, or any other concepts unique to your use case. Open Match will not interpret what the Ticket represents but just treat it as a matchmaking unit with a set of SearchFields. Open Match stores the Ticket in state storage and enables an Assignment to be set on the Ticket.

func (*Ticket) Descriptor deprecated 

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

Deprecated: Use Ticket.ProtoReflect.Descriptor instead.

func (*Ticket) GetAssignment 

func (x *Ticket) GetAssignment() *Assignment

func (*Ticket) GetCreateTime added in v0.10.0 

func (x *Ticket) GetCreateTime() *timestamp.Timestamp

func (*Ticket) GetExtensions added in v0.8.0 

func (x *Ticket) GetExtensions() map[string]*any.Any

func (*Ticket) GetId 

func (x *Ticket) GetId() string

func (*Ticket) GetSearchFields added in v0.8.0 

func (x *Ticket) GetSearchFields() *SearchFields

func (*Ticket) ProtoMessage 

func (*Ticket) ProtoMessage()

func (*Ticket) ProtoReflect added in v1.2.0 

func (x *Ticket) ProtoReflect() protoreflect.Message

func (*Ticket) Reset 

func (x *Ticket) Reset()

func (*Ticket) String 

func (x *Ticket) String() string

type UnimplementedBackendServiceServer added in v0.9.0 

type UnimplementedBackendServiceServer struct {
}

UnimplementedBackendServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedBackendServiceServer) AssignTickets added in v0.9.0 

func (*UnimplementedBackendServiceServer) AssignTickets(context.Context, *AssignTicketsRequest) (*AssignTicketsResponse, error)

func (*UnimplementedBackendServiceServer) FetchMatches added in v0.9.0 

func (*UnimplementedBackendServiceServer) FetchMatches(*FetchMatchesRequest, BackendService_FetchMatchesServer) error

func (*UnimplementedBackendServiceServer) ReleaseAllTickets added in v1.0.0 

func (*UnimplementedBackendServiceServer) ReleaseAllTickets(context.Context, *ReleaseAllTicketsRequest) (*ReleaseAllTicketsResponse, error)

func (*UnimplementedBackendServiceServer) ReleaseTickets added in v0.9.0 

func (*UnimplementedBackendServiceServer) ReleaseTickets(context.Context, *ReleaseTicketsRequest) (*ReleaseTicketsResponse, error)

type UnimplementedEvaluatorServer added in v0.7.0 

type UnimplementedEvaluatorServer struct {
}

UnimplementedEvaluatorServer can be embedded to have forward compatible implementations.

func (*UnimplementedEvaluatorServer) Evaluate added in v0.7.0 

func (*UnimplementedEvaluatorServer) Evaluate(Evaluator_EvaluateServer) error

type UnimplementedFrontendServiceServer added in v0.9.0 

type UnimplementedFrontendServiceServer struct {
}

UnimplementedFrontendServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedFrontendServiceServer) AcknowledgeBackfill added in v1.2.0 

func (*UnimplementedFrontendServiceServer) AcknowledgeBackfill(context.Context, *AcknowledgeBackfillRequest) (*Backfill, error)

func (*UnimplementedFrontendServiceServer) CreateBackfill added in v1.2.0 

func (*UnimplementedFrontendServiceServer) CreateBackfill(context.Context, *CreateBackfillRequest) (*Backfill, error)

func (*UnimplementedFrontendServiceServer) CreateTicket added in v0.9.0 

func (*UnimplementedFrontendServiceServer) CreateTicket(context.Context, *CreateTicketRequest) (*Ticket, error)

func (*UnimplementedFrontendServiceServer) DeleteBackfill added in v1.2.0 

func (*UnimplementedFrontendServiceServer) DeleteBackfill(context.Context, *DeleteBackfillRequest) (*empty.Empty, error)

func (*UnimplementedFrontendServiceServer) DeleteTicket added in v0.9.0 

func (*UnimplementedFrontendServiceServer) DeleteTicket(context.Context, *DeleteTicketRequest) (*empty.Empty, error)

func (*UnimplementedFrontendServiceServer) GetBackfill added in v1.2.0 

func (*UnimplementedFrontendServiceServer) GetBackfill(context.Context, *GetBackfillRequest) (*Backfill, error)

func (*UnimplementedFrontendServiceServer) GetTicket added in v0.9.0 

func (*UnimplementedFrontendServiceServer) GetTicket(context.Context, *GetTicketRequest) (*Ticket, error)

func (*UnimplementedFrontendServiceServer) UpdateBackfill added in v1.2.0 

func (*UnimplementedFrontendServiceServer) UpdateBackfill(context.Context, *UpdateBackfillRequest) (*Backfill, error)

func (*UnimplementedFrontendServiceServer) WatchAssignments added in v0.10.0 

func (*UnimplementedFrontendServiceServer) WatchAssignments(*WatchAssignmentsRequest, FrontendService_WatchAssignmentsServer) error

type UnimplementedMatchFunctionServer added in v0.7.0 

type UnimplementedMatchFunctionServer struct {
}

UnimplementedMatchFunctionServer can be embedded to have forward compatible implementations.

func (*UnimplementedMatchFunctionServer) Run added in v0.7.0 

func (*UnimplementedMatchFunctionServer) Run(*RunRequest, MatchFunction_RunServer) error

type UnimplementedQueryServiceServer added in v0.9.0 

type UnimplementedQueryServiceServer struct {
}

UnimplementedQueryServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedQueryServiceServer) QueryBackfills added in v1.2.0 

func (*UnimplementedQueryServiceServer) QueryBackfills(*QueryBackfillsRequest, QueryService_QueryBackfillsServer) error

func (*UnimplementedQueryServiceServer) QueryTicketIds added in v0.10.0 

func (*UnimplementedQueryServiceServer) QueryTicketIds(*QueryTicketIdsRequest, QueryService_QueryTicketIdsServer) error

func (*UnimplementedQueryServiceServer) QueryTickets added in v0.9.0 

func (*UnimplementedQueryServiceServer) QueryTickets(*QueryTicketsRequest, QueryService_QueryTicketsServer) error

type UpdateBackfillRequest added in v1.2.0 

type UpdateBackfillRequest struct {

	// A Backfill object with ID set and fields to update.
	Backfill *Backfill `protobuf:"bytes,1,opt,name=backfill,proto3" json:"backfill,omitempty"`
	// contains filtered or unexported fields
}

UpdateBackfillRequest - update searchFields, extensions and set assignment.

BETA FEATURE WARNING: This Request message is not finalized and still subject to possible change or removal.

func (*UpdateBackfillRequest) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use UpdateBackfillRequest.ProtoReflect.Descriptor instead.

func (*UpdateBackfillRequest) GetBackfill added in v1.2.0 

func (x *UpdateBackfillRequest) GetBackfill() *Backfill

func (*UpdateBackfillRequest) ProtoMessage added in v1.2.0 

func (*UpdateBackfillRequest) ProtoMessage()

func (*UpdateBackfillRequest) ProtoReflect added in v1.2.0 

func (x *UpdateBackfillRequest) ProtoReflect() protoreflect.Message

func (*UpdateBackfillRequest) Reset added in v1.2.0 

func (x *UpdateBackfillRequest) Reset()

func (*UpdateBackfillRequest) String added in v1.2.0 

func (x *UpdateBackfillRequest) String() string

type WatchAssignmentsRequest added in v0.10.0 

type WatchAssignmentsRequest struct {

	// A TicketId of a generated Ticket to get updates on.
	TicketId string `protobuf:"bytes,1,opt,name=ticket_id,json=ticketId,proto3" json:"ticket_id,omitempty"`
	// contains filtered or unexported fields
}

func (*WatchAssignmentsRequest) Descriptor deprecated added in v0.10.0 

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

Deprecated: Use WatchAssignmentsRequest.ProtoReflect.Descriptor instead.

func (*WatchAssignmentsRequest) GetTicketId added in v0.10.0 

func (x *WatchAssignmentsRequest) GetTicketId() string

func (*WatchAssignmentsRequest) ProtoMessage added in v0.10.0 

func (*WatchAssignmentsRequest) ProtoMessage()

func (*WatchAssignmentsRequest) ProtoReflect added in v1.2.0 

func (x *WatchAssignmentsRequest) ProtoReflect() protoreflect.Message

func (*WatchAssignmentsRequest) Reset added in v0.10.0 

func (x *WatchAssignmentsRequest) Reset()

func (*WatchAssignmentsRequest) String added in v0.10.0 

func (x *WatchAssignmentsRequest) String() string

type WatchAssignmentsResponse added in v0.10.0 

type WatchAssignmentsResponse struct {

	// An updated Assignment of the requested Ticket.
	Assignment *Assignment `protobuf:"bytes,1,opt,name=assignment,proto3" json:"assignment,omitempty"`
	// contains filtered or unexported fields
}

func (*WatchAssignmentsResponse) Descriptor deprecated added in v0.10.0 

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

Deprecated: Use WatchAssignmentsResponse.ProtoReflect.Descriptor instead.

func (*WatchAssignmentsResponse) GetAssignment added in v0.10.0 

func (x *WatchAssignmentsResponse) GetAssignment() *Assignment

func (*WatchAssignmentsResponse) ProtoMessage added in v0.10.0 

func (*WatchAssignmentsResponse) ProtoMessage()

func (*WatchAssignmentsResponse) ProtoReflect added in v1.2.0 

func (x *WatchAssignmentsResponse) ProtoReflect() protoreflect.Message

func (*WatchAssignmentsResponse) Reset added in v0.10.0 

func (x *WatchAssignmentsResponse) Reset()

func (*WatchAssignmentsResponse) String added in v0.10.0 

func (x *WatchAssignmentsResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

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