pb

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Mar 12, 2025 License: Apache-2.0 Imports: 21 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.

Package pb is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	BackendService_FetchMatches_FullMethodName      = "/openmatch.BackendService/FetchMatches"
	BackendService_AssignTickets_FullMethodName     = "/openmatch.BackendService/AssignTickets"
	BackendService_ReleaseTickets_FullMethodName    = "/openmatch.BackendService/ReleaseTickets"
	BackendService_ReleaseAllTickets_FullMethodName = "/openmatch.BackendService/ReleaseAllTickets"
)
View Source
const (
	FrontendService_CreateTicket_FullMethodName        = "/openmatch.FrontendService/CreateTicket"
	FrontendService_DeleteTicket_FullMethodName        = "/openmatch.FrontendService/DeleteTicket"
	FrontendService_GetTicket_FullMethodName           = "/openmatch.FrontendService/GetTicket"
	FrontendService_WatchAssignments_FullMethodName    = "/openmatch.FrontendService/WatchAssignments"
	FrontendService_AcknowledgeBackfill_FullMethodName = "/openmatch.FrontendService/AcknowledgeBackfill"
	FrontendService_CreateBackfill_FullMethodName      = "/openmatch.FrontendService/CreateBackfill"
	FrontendService_DeleteBackfill_FullMethodName      = "/openmatch.FrontendService/DeleteBackfill"
	FrontendService_GetBackfill_FullMethodName         = "/openmatch.FrontendService/GetBackfill"
	FrontendService_UpdateBackfill_FullMethodName      = "/openmatch.FrontendService/UpdateBackfill"
)
View Source
const (
	QueryService_QueryTickets_FullMethodName   = "/openmatch.QueryService/QueryTickets"
	QueryService_QueryTicketIds_FullMethodName = "/openmatch.QueryService/QueryTicketIds"
	QueryService_QueryBackfills_FullMethodName = "/openmatch.QueryService/QueryBackfills"
)
View Source
const (
	Evaluator_Evaluate_FullMethodName = "/openmatch.Evaluator/Evaluate"
)
View Source
const (
	MatchFunction_Run_FullMethodName = "/openmatch.MatchFunction/Run"
)

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 BackendService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "openmatch.BackendService",
	HandlerType: (*BackendServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "AssignTickets",
			Handler:    _BackendService_AssignTickets_Handler,
		},
		{
			MethodName: "ReleaseTickets",
			Handler:    _BackendService_ReleaseTickets_Handler,
		},
		{
			MethodName: "ReleaseAllTickets",
			Handler:    _BackendService_ReleaseAllTickets_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "FetchMatches",
			Handler:       _BackendService_FetchMatches_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "api/backend.proto",
}

BackendService_ServiceDesc is the grpc.ServiceDesc for BackendService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var Evaluator_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "openmatch.Evaluator",
	HandlerType: (*EvaluatorServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Evaluate",
			Handler:       _Evaluator_Evaluate_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "api/evaluator.proto",
}

Evaluator_ServiceDesc is the grpc.ServiceDesc for Evaluator service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

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
View Source
var FrontendService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "openmatch.FrontendService",
	HandlerType: (*FrontendServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateTicket",
			Handler:    _FrontendService_CreateTicket_Handler,
		},
		{
			MethodName: "DeleteTicket",
			Handler:    _FrontendService_DeleteTicket_Handler,
		},
		{
			MethodName: "GetTicket",
			Handler:    _FrontendService_GetTicket_Handler,
		},
		{
			MethodName: "AcknowledgeBackfill",
			Handler:    _FrontendService_AcknowledgeBackfill_Handler,
		},
		{
			MethodName: "CreateBackfill",
			Handler:    _FrontendService_CreateBackfill_Handler,
		},
		{
			MethodName: "DeleteBackfill",
			Handler:    _FrontendService_DeleteBackfill_Handler,
		},
		{
			MethodName: "GetBackfill",
			Handler:    _FrontendService_GetBackfill_Handler,
		},
		{
			MethodName: "UpdateBackfill",
			Handler:    _FrontendService_UpdateBackfill_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "WatchAssignments",
			Handler:       _FrontendService_WatchAssignments_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "api/frontend.proto",
}

FrontendService_ServiceDesc is the grpc.ServiceDesc for FrontendService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var MatchFunction_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "openmatch.MatchFunction",
	HandlerType: (*MatchFunctionServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Run",
			Handler:       _MatchFunction_Run_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "api/matchfunction.proto",
}

MatchFunction_ServiceDesc is the grpc.ServiceDesc for MatchFunction service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var QueryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "openmatch.QueryService",
	HandlerType: (*QueryServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "QueryTickets",
			Handler:       _QueryService_QueryTickets_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "QueryTicketIds",
			Handler:       _QueryService_QueryTicketIds_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "QueryBackfills",
			Handler:       _QueryService_QueryBackfills_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "api/query.proto",
}

QueryService_ServiceDesc is the grpc.ServiceDesc for QueryService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterBackendServiceHandler

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

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

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

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

func RegisterBackendServiceServer(s grpc.ServiceRegistrar, 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

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.ServiceRegistrar, srv EvaluatorServer)

func RegisterFrontendServiceHandler

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

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

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

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

func RegisterFrontendServiceServer(s grpc.ServiceRegistrar, 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

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.ServiceRegistrar, srv MatchFunctionServer)

func RegisterQueryServiceHandler

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

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

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

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

func RegisterQueryServiceServer(s grpc.ServiceRegistrar, srv QueryServiceServer)

Types

type AcknowledgeBackfillRequest

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

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

Deprecated: Use AcknowledgeBackfillRequest.ProtoReflect.Descriptor instead.

func (*AcknowledgeBackfillRequest) GetAssignment

func (x *AcknowledgeBackfillRequest) GetAssignment() *Assignment

func (*AcknowledgeBackfillRequest) GetBackfillId

func (x *AcknowledgeBackfillRequest) GetBackfillId() string

func (*AcknowledgeBackfillRequest) ProtoMessage

func (*AcknowledgeBackfillRequest) ProtoMessage()

func (*AcknowledgeBackfillRequest) ProtoReflect

func (*AcknowledgeBackfillRequest) Reset

func (x *AcknowledgeBackfillRequest) Reset()

func (*AcknowledgeBackfillRequest) String

func (x *AcknowledgeBackfillRequest) String() string

type AcknowledgeBackfillResponse

type AcknowledgeBackfillResponse struct {

	// The Backfill that was acknowledged.
	Backfill *Backfill `protobuf:"bytes,1,opt,name=backfill,proto3" json:"backfill,omitempty"`
	// All of the Tickets that were successfully assigned
	Tickets []*Ticket `protobuf:"bytes,2,rep,name=tickets,proto3" json:"tickets,omitempty"`
	// contains filtered or unexported fields
}

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

func (*AcknowledgeBackfillResponse) Descriptor deprecated

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

Deprecated: Use AcknowledgeBackfillResponse.ProtoReflect.Descriptor instead.

func (*AcknowledgeBackfillResponse) GetBackfill

func (x *AcknowledgeBackfillResponse) GetBackfill() *Backfill

func (*AcknowledgeBackfillResponse) GetTickets

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

func (*AcknowledgeBackfillResponse) ProtoMessage

func (*AcknowledgeBackfillResponse) ProtoMessage()

func (*AcknowledgeBackfillResponse) ProtoReflect

func (*AcknowledgeBackfillResponse) Reset

func (x *AcknowledgeBackfillResponse) Reset()

func (*AcknowledgeBackfillResponse) String

func (x *AcknowledgeBackfillResponse) 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

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

func (*AssignTicketsRequest) ProtoMessage

func (*AssignTicketsRequest) ProtoMessage()

func (*AssignTicketsRequest) ProtoReflect

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

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

func (*AssignTicketsResponse) ProtoMessage

func (*AssignTicketsResponse) ProtoMessage()

func (*AssignTicketsResponse) ProtoReflect

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]*anypb.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

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

func (*Assignment) ProtoMessage

func (*Assignment) ProtoMessage()

func (*Assignment) ProtoReflect

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

func (*Assignment) Reset

func (x *Assignment) Reset()

func (*Assignment) String

func (x *Assignment) String() string

type AssignmentFailure

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

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

Deprecated: Use AssignmentFailure.ProtoReflect.Descriptor instead.

func (*AssignmentFailure) GetCause

func (*AssignmentFailure) GetTicketId

func (x *AssignmentFailure) GetTicketId() string

func (*AssignmentFailure) ProtoMessage

func (*AssignmentFailure) ProtoMessage()

func (*AssignmentFailure) ProtoReflect

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

func (*AssignmentFailure) Reset

func (x *AssignmentFailure) Reset()

func (*AssignmentFailure) String

func (x *AssignmentFailure) String() string

type AssignmentFailure_Cause

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

func (AssignmentFailure_Cause) Descriptor

func (AssignmentFailure_Cause) Enum

func (AssignmentFailure_Cause) EnumDescriptor deprecated

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

Deprecated: Use AssignmentFailure_Cause.Descriptor instead.

func (AssignmentFailure_Cause) Number

func (AssignmentFailure_Cause) String

func (x AssignmentFailure_Cause) String() string

func (AssignmentFailure_Cause) Type

type AssignmentGroup

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

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

Deprecated: Use AssignmentGroup.ProtoReflect.Descriptor instead.

func (*AssignmentGroup) GetAssignment

func (x *AssignmentGroup) GetAssignment() *Assignment

func (*AssignmentGroup) GetTicketIds

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

func (*AssignmentGroup) ProtoMessage

func (*AssignmentGroup) ProtoMessage()

func (*AssignmentGroup) ProtoReflect

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

func (*AssignmentGroup) Reset

func (x *AssignmentGroup) Reset()

func (*AssignmentGroup) String

func (x *AssignmentGroup) String() string

type BackendServiceClient

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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type BackendServiceServer

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. All implementations should embed UnimplementedBackendServiceServer for forward compatibility

type BackendService_FetchMatchesClient

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

type BackendService_FetchMatchesServer

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

type Backfill

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]*anypb.Any `` /* 161-byte string literal not displayed */
	// Customized information not inspected by Open Match, to be kept persistent
	// throughout the life-cycle of a backfill.
	// Optional, depending on the requirements of the connected systems.
	PersistentField map[string]*anypb.Any `` /* 194-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 *timestamppb.Timestamp `protobuf:"bytes,5,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,6,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

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

Deprecated: Use Backfill.ProtoReflect.Descriptor instead.

func (*Backfill) GetCreateTime

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

func (*Backfill) GetExtensions

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

func (*Backfill) GetGeneration

func (x *Backfill) GetGeneration() int64

func (*Backfill) GetId

func (x *Backfill) GetId() string

func (*Backfill) GetPersistentField

func (x *Backfill) GetPersistentField() map[string]*anypb.Any

func (*Backfill) GetSearchFields

func (x *Backfill) GetSearchFields() *SearchFields

func (*Backfill) ProtoMessage

func (*Backfill) ProtoMessage()

func (*Backfill) ProtoReflect

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

func (*Backfill) Reset

func (x *Backfill) Reset()

func (*Backfill) String

func (x *Backfill) String() string

type CreateBackfillRequest

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

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

Deprecated: Use CreateBackfillRequest.ProtoReflect.Descriptor instead.

func (*CreateBackfillRequest) GetBackfill

func (x *CreateBackfillRequest) GetBackfill() *Backfill

func (*CreateBackfillRequest) ProtoMessage

func (*CreateBackfillRequest) ProtoMessage()

func (*CreateBackfillRequest) ProtoReflect

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

func (*CreateBackfillRequest) Reset

func (x *CreateBackfillRequest) Reset()

func (*CreateBackfillRequest) String

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

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

func (*CreateTicketRequest) Reset

func (x *CreateTicketRequest) Reset()

func (*CreateTicketRequest) String

func (x *CreateTicketRequest) String() string

type DefaultEvaluationCriteria

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

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

Deprecated: Use DefaultEvaluationCriteria.ProtoReflect.Descriptor instead.

func (*DefaultEvaluationCriteria) GetScore

func (x *DefaultEvaluationCriteria) GetScore() float64

func (*DefaultEvaluationCriteria) ProtoMessage

func (*DefaultEvaluationCriteria) ProtoMessage()

func (*DefaultEvaluationCriteria) ProtoReflect

func (*DefaultEvaluationCriteria) Reset

func (x *DefaultEvaluationCriteria) Reset()

func (*DefaultEvaluationCriteria) String

func (x *DefaultEvaluationCriteria) String() string

type DeleteBackfillRequest

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

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

Deprecated: Use DeleteBackfillRequest.ProtoReflect.Descriptor instead.

func (*DeleteBackfillRequest) GetBackfillId

func (x *DeleteBackfillRequest) GetBackfillId() string

func (*DeleteBackfillRequest) ProtoMessage

func (*DeleteBackfillRequest) ProtoMessage()

func (*DeleteBackfillRequest) ProtoReflect

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

func (*DeleteBackfillRequest) Reset

func (x *DeleteBackfillRequest) Reset()

func (*DeleteBackfillRequest) String

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

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

func (*DeleteTicketRequest) Reset

func (x *DeleteTicketRequest) Reset()

func (*DeleteTicketRequest) String

func (x *DeleteTicketRequest) String() string

type DoubleRangeFilter

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

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

Deprecated: Use DoubleRangeFilter.ProtoReflect.Descriptor instead.

func (*DoubleRangeFilter) GetDoubleArg

func (x *DoubleRangeFilter) GetDoubleArg() string

func (*DoubleRangeFilter) GetExclude

func (*DoubleRangeFilter) GetMax

func (x *DoubleRangeFilter) GetMax() float64

func (*DoubleRangeFilter) GetMin

func (x *DoubleRangeFilter) GetMin() float64

func (*DoubleRangeFilter) ProtoMessage

func (*DoubleRangeFilter) ProtoMessage()

func (*DoubleRangeFilter) ProtoReflect

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

func (*DoubleRangeFilter) Reset

func (x *DoubleRangeFilter) Reset()

func (*DoubleRangeFilter) String

func (x *DoubleRangeFilter) String() string

type DoubleRangeFilter_Exclude

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

func (DoubleRangeFilter_Exclude) Enum

func (DoubleRangeFilter_Exclude) EnumDescriptor deprecated

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

Deprecated: Use DoubleRangeFilter_Exclude.Descriptor instead.

func (DoubleRangeFilter_Exclude) Number

func (DoubleRangeFilter_Exclude) String

func (x DoubleRangeFilter_Exclude) String() string

func (DoubleRangeFilter_Exclude) Type

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

func (x *EvaluateRequest) GetMatch() *Match

func (*EvaluateRequest) ProtoMessage

func (*EvaluateRequest) ProtoMessage()

func (*EvaluateRequest) ProtoReflect

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

func (x *EvaluateResponse) GetMatchId() string

func (*EvaluateResponse) ProtoMessage

func (*EvaluateResponse) ProtoMessage()

func (*EvaluateResponse) ProtoReflect

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://pkg.go.dev/google.golang.org/grpc/?tab=doc#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. All implementations should embed UnimplementedEvaluatorServer for forward compatibility

type Evaluator_EvaluateClient

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

type Evaluator_EvaluateServer

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

func (x *FetchMatchesRequest) GetProfile() *MatchProfile

func (*FetchMatchesRequest) ProtoMessage

func (*FetchMatchesRequest) ProtoMessage()

func (*FetchMatchesRequest) ProtoReflect

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

func (x *FetchMatchesResponse) GetMatch() *Match

func (*FetchMatchesResponse) ProtoMessage

func (*FetchMatchesResponse) ProtoMessage()

func (*FetchMatchesResponse) ProtoReflect

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

func (*FetchMatchesResponse) Reset

func (x *FetchMatchesResponse) Reset()

func (*FetchMatchesResponse) String

func (x *FetchMatchesResponse) String() string

type FrontendServiceClient

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) (*emptypb.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) (*AcknowledgeBackfillResponse, 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) (*emptypb.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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type FrontendServiceServer

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) (*emptypb.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) (*AcknowledgeBackfillResponse, 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) (*emptypb.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. All implementations should embed UnimplementedFrontendServiceServer for forward compatibility

type FrontendService_WatchAssignmentsClient

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

type FrontendService_WatchAssignmentsServer

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

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

func (FunctionConfig_Type) Enum

func (FunctionConfig_Type) EnumDescriptor deprecated

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

Deprecated: Use FunctionConfig_Type.Descriptor instead.

func (FunctionConfig_Type) Number

func (FunctionConfig_Type) String

func (x FunctionConfig_Type) String() string

func (FunctionConfig_Type) Type

type GetBackfillRequest

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

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

Deprecated: Use GetBackfillRequest.ProtoReflect.Descriptor instead.

func (*GetBackfillRequest) GetBackfillId

func (x *GetBackfillRequest) GetBackfillId() string

func (*GetBackfillRequest) ProtoMessage

func (*GetBackfillRequest) ProtoMessage()

func (*GetBackfillRequest) ProtoReflect

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

func (*GetBackfillRequest) Reset

func (x *GetBackfillRequest) Reset()

func (*GetBackfillRequest) String

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

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]*anypb.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

func (x *Match) GetAllocateGameserver() bool

func (*Match) GetBackfill

func (x *Match) GetBackfill() *Backfill

func (*Match) GetExtensions

func (x *Match) GetExtensions() map[string]*anypb.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

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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

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. All implementations should embed UnimplementedMatchFunctionServer for forward compatibility

type MatchFunction_RunClient

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

type MatchFunction_RunServer

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]*anypb.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

func (x *MatchProfile) GetExtensions() map[string]*anypb.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

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 *timestamppb.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 *timestamppb.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

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

func (*Pool) GetCreatedBefore

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

func (*Pool) GetDoubleRangeFilters

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

func (*Pool) GetName

func (x *Pool) GetName() string

func (*Pool) GetStringEqualsFilters

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

func (*Pool) GetTagPresentFilters

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

func (*Pool) ProtoMessage

func (*Pool) ProtoMessage()

func (*Pool) ProtoReflect

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

func (*Pool) Reset

func (x *Pool) Reset()

func (*Pool) String

func (x *Pool) String() string

type QueryBackfillsRequest

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

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

Deprecated: Use QueryBackfillsRequest.ProtoReflect.Descriptor instead.

func (*QueryBackfillsRequest) GetPool

func (x *QueryBackfillsRequest) GetPool() *Pool

func (*QueryBackfillsRequest) ProtoMessage

func (*QueryBackfillsRequest) ProtoMessage()

func (*QueryBackfillsRequest) ProtoReflect

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

func (*QueryBackfillsRequest) Reset

func (x *QueryBackfillsRequest) Reset()

func (*QueryBackfillsRequest) String

func (x *QueryBackfillsRequest) String() string

type QueryBackfillsResponse

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

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

Deprecated: Use QueryBackfillsResponse.ProtoReflect.Descriptor instead.

func (*QueryBackfillsResponse) GetBackfills

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

func (*QueryBackfillsResponse) ProtoMessage

func (*QueryBackfillsResponse) ProtoMessage()

func (*QueryBackfillsResponse) ProtoReflect

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

func (*QueryBackfillsResponse) Reset

func (x *QueryBackfillsResponse) Reset()

func (*QueryBackfillsResponse) String

func (x *QueryBackfillsResponse) String() string

type QueryServiceClient

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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type QueryServiceServer

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. All implementations should embed UnimplementedQueryServiceServer for forward compatibility

type QueryService_QueryBackfillsClient

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

type QueryService_QueryBackfillsServer

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

type QueryService_QueryTicketIdsClient

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

type QueryService_QueryTicketIdsServer

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

type QueryService_QueryTicketsClient

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

type QueryService_QueryTicketsServer

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

type QueryTicketIdsRequest

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

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

Deprecated: Use QueryTicketIdsRequest.ProtoReflect.Descriptor instead.

func (*QueryTicketIdsRequest) GetPool

func (x *QueryTicketIdsRequest) GetPool() *Pool

func (*QueryTicketIdsRequest) ProtoMessage

func (*QueryTicketIdsRequest) ProtoMessage()

func (*QueryTicketIdsRequest) ProtoReflect

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

func (*QueryTicketIdsRequest) Reset

func (x *QueryTicketIdsRequest) Reset()

func (*QueryTicketIdsRequest) String

func (x *QueryTicketIdsRequest) String() string

type QueryTicketIdsResponse

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

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

Deprecated: Use QueryTicketIdsResponse.ProtoReflect.Descriptor instead.

func (*QueryTicketIdsResponse) GetIds

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

func (*QueryTicketIdsResponse) ProtoMessage

func (*QueryTicketIdsResponse) ProtoMessage()

func (*QueryTicketIdsResponse) ProtoReflect

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

func (*QueryTicketIdsResponse) Reset

func (x *QueryTicketIdsResponse) Reset()

func (*QueryTicketIdsResponse) String

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

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

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

func (*QueryTicketsResponse) Reset

func (x *QueryTicketsResponse) Reset()

func (*QueryTicketsResponse) String

func (x *QueryTicketsResponse) String() string

type ReleaseAllTicketsRequest

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

func (*ReleaseAllTicketsRequest) Descriptor deprecated

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

Deprecated: Use ReleaseAllTicketsRequest.ProtoReflect.Descriptor instead.

func (*ReleaseAllTicketsRequest) ProtoMessage

func (*ReleaseAllTicketsRequest) ProtoMessage()

func (*ReleaseAllTicketsRequest) ProtoReflect

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

func (*ReleaseAllTicketsRequest) Reset

func (x *ReleaseAllTicketsRequest) Reset()

func (*ReleaseAllTicketsRequest) String

func (x *ReleaseAllTicketsRequest) String() string

type ReleaseAllTicketsResponse

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

func (*ReleaseAllTicketsResponse) Descriptor deprecated

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

Deprecated: Use ReleaseAllTicketsResponse.ProtoReflect.Descriptor instead.

func (*ReleaseAllTicketsResponse) ProtoMessage

func (*ReleaseAllTicketsResponse) ProtoMessage()

func (*ReleaseAllTicketsResponse) ProtoReflect

func (*ReleaseAllTicketsResponse) Reset

func (x *ReleaseAllTicketsResponse) Reset()

func (*ReleaseAllTicketsResponse) String

func (x *ReleaseAllTicketsResponse) String() string

type ReleaseTicketsRequest

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

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

Deprecated: Use ReleaseTicketsRequest.ProtoReflect.Descriptor instead.

func (*ReleaseTicketsRequest) GetTicketIds

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

func (*ReleaseTicketsRequest) ProtoMessage

func (*ReleaseTicketsRequest) ProtoMessage()

func (*ReleaseTicketsRequest) ProtoReflect

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

func (*ReleaseTicketsRequest) Reset

func (x *ReleaseTicketsRequest) Reset()

func (*ReleaseTicketsRequest) String

func (x *ReleaseTicketsRequest) String() string

type ReleaseTicketsResponse

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

func (*ReleaseTicketsResponse) Descriptor deprecated

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

Deprecated: Use ReleaseTicketsResponse.ProtoReflect.Descriptor instead.

func (*ReleaseTicketsResponse) ProtoMessage

func (*ReleaseTicketsResponse) ProtoMessage()

func (*ReleaseTicketsResponse) ProtoReflect

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

func (*ReleaseTicketsResponse) Reset

func (x *ReleaseTicketsResponse) Reset()

func (*ReleaseTicketsResponse) String

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

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

func (x *RunResponse) GetProposal() *Match

func (*RunResponse) ProtoMessage

func (*RunResponse) ProtoMessage()

func (*RunResponse) ProtoReflect

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

func (*RunResponse) Reset

func (x *RunResponse) Reset()

func (*RunResponse) String

func (x *RunResponse) String() string

type SearchFields

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

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

Deprecated: Use SearchFields.ProtoReflect.Descriptor instead.

func (*SearchFields) GetDoubleArgs

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

func (*SearchFields) GetStringArgs

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

func (*SearchFields) GetTags

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

func (*SearchFields) ProtoMessage

func (*SearchFields) ProtoMessage()

func (*SearchFields) ProtoReflect

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

func (*SearchFields) Reset

func (x *SearchFields) Reset()

func (*SearchFields) String

func (x *SearchFields) String() string

type StringEqualsFilter

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

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

Deprecated: Use StringEqualsFilter.ProtoReflect.Descriptor instead.

func (*StringEqualsFilter) GetStringArg

func (x *StringEqualsFilter) GetStringArg() string

func (*StringEqualsFilter) GetValue

func (x *StringEqualsFilter) GetValue() string

func (*StringEqualsFilter) ProtoMessage

func (*StringEqualsFilter) ProtoMessage()

func (*StringEqualsFilter) ProtoReflect

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

func (*StringEqualsFilter) Reset

func (x *StringEqualsFilter) Reset()

func (*StringEqualsFilter) String

func (x *StringEqualsFilter) String() string

type TagPresentFilter

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

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

Deprecated: Use TagPresentFilter.ProtoReflect.Descriptor instead.

func (*TagPresentFilter) GetTag

func (x *TagPresentFilter) GetTag() string

func (*TagPresentFilter) ProtoMessage

func (*TagPresentFilter) ProtoMessage()

func (*TagPresentFilter) ProtoReflect

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

func (*TagPresentFilter) Reset

func (x *TagPresentFilter) Reset()

func (*TagPresentFilter) String

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]*anypb.Any `` /* 161-byte string literal not displayed */
	// Customized information not inspected by Open Match, to be kept persistent
	// throughout the life-cycle of a ticket.
	// Optional, depending on the requirements of the connected systems.
	PersistentField map[string]*anypb.Any `` /* 194-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 *timestamppb.Timestamp `protobuf:"bytes,7,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

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

func (*Ticket) GetExtensions

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

func (*Ticket) GetId

func (x *Ticket) GetId() string

func (*Ticket) GetPersistentField

func (x *Ticket) GetPersistentField() map[string]*anypb.Any

func (*Ticket) GetSearchFields

func (x *Ticket) GetSearchFields() *SearchFields

func (*Ticket) ProtoMessage

func (*Ticket) ProtoMessage()

func (*Ticket) ProtoReflect

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

func (*Ticket) Reset

func (x *Ticket) Reset()

func (*Ticket) String

func (x *Ticket) String() string

type UnimplementedBackendServiceServer

type UnimplementedBackendServiceServer struct {
}

UnimplementedBackendServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedBackendServiceServer) AssignTickets

func (UnimplementedBackendServiceServer) FetchMatches

func (UnimplementedBackendServiceServer) ReleaseAllTickets

func (UnimplementedBackendServiceServer) ReleaseTickets

type UnimplementedEvaluatorServer

type UnimplementedEvaluatorServer struct {
}

UnimplementedEvaluatorServer should be embedded to have forward compatible implementations.

func (UnimplementedEvaluatorServer) Evaluate

type UnimplementedFrontendServiceServer

type UnimplementedFrontendServiceServer struct {
}

UnimplementedFrontendServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedFrontendServiceServer) AcknowledgeBackfill

func (UnimplementedFrontendServiceServer) CreateBackfill

func (UnimplementedFrontendServiceServer) CreateTicket

func (UnimplementedFrontendServiceServer) DeleteBackfill

func (UnimplementedFrontendServiceServer) DeleteTicket

func (UnimplementedFrontendServiceServer) GetBackfill

func (UnimplementedFrontendServiceServer) GetTicket

func (UnimplementedFrontendServiceServer) UpdateBackfill

type UnimplementedMatchFunctionServer

type UnimplementedMatchFunctionServer struct {
}

UnimplementedMatchFunctionServer should be embedded to have forward compatible implementations.

func (UnimplementedMatchFunctionServer) Run

type UnimplementedQueryServiceServer

type UnimplementedQueryServiceServer struct {
}

UnimplementedQueryServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedQueryServiceServer) QueryBackfills

func (UnimplementedQueryServiceServer) QueryTicketIds

func (UnimplementedQueryServiceServer) QueryTickets

type UnsafeBackendServiceServer

type UnsafeBackendServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeBackendServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to BackendServiceServer will result in compilation errors.

type UnsafeEvaluatorServer

type UnsafeEvaluatorServer interface {
	// contains filtered or unexported methods
}

UnsafeEvaluatorServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EvaluatorServer will result in compilation errors.

type UnsafeFrontendServiceServer

type UnsafeFrontendServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeFrontendServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to FrontendServiceServer will result in compilation errors.

type UnsafeMatchFunctionServer

type UnsafeMatchFunctionServer interface {
	// contains filtered or unexported methods
}

UnsafeMatchFunctionServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to MatchFunctionServer will result in compilation errors.

type UnsafeQueryServiceServer

type UnsafeQueryServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeQueryServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to QueryServiceServer will result in compilation errors.

type UpdateBackfillRequest

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

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

Deprecated: Use UpdateBackfillRequest.ProtoReflect.Descriptor instead.

func (*UpdateBackfillRequest) GetBackfill

func (x *UpdateBackfillRequest) GetBackfill() *Backfill

func (*UpdateBackfillRequest) ProtoMessage

func (*UpdateBackfillRequest) ProtoMessage()

func (*UpdateBackfillRequest) ProtoReflect

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

func (*UpdateBackfillRequest) Reset

func (x *UpdateBackfillRequest) Reset()

func (*UpdateBackfillRequest) String

func (x *UpdateBackfillRequest) String() string

type WatchAssignmentsRequest

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

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

Deprecated: Use WatchAssignmentsRequest.ProtoReflect.Descriptor instead.

func (*WatchAssignmentsRequest) GetTicketId

func (x *WatchAssignmentsRequest) GetTicketId() string

func (*WatchAssignmentsRequest) ProtoMessage

func (*WatchAssignmentsRequest) ProtoMessage()

func (*WatchAssignmentsRequest) ProtoReflect

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

func (*WatchAssignmentsRequest) Reset

func (x *WatchAssignmentsRequest) Reset()

func (*WatchAssignmentsRequest) String

func (x *WatchAssignmentsRequest) String() string

type WatchAssignmentsResponse

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

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

Deprecated: Use WatchAssignmentsResponse.ProtoReflect.Descriptor instead.

func (*WatchAssignmentsResponse) GetAssignment

func (x *WatchAssignmentsResponse) GetAssignment() *Assignment

func (*WatchAssignmentsResponse) ProtoMessage

func (*WatchAssignmentsResponse) ProtoMessage()

func (*WatchAssignmentsResponse) ProtoReflect

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

func (*WatchAssignmentsResponse) Reset

func (x *WatchAssignmentsResponse) Reset()

func (*WatchAssignmentsResponse) String

func (x *WatchAssignmentsResponse) String() string

Jump to

Keyboard shortcuts

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