pb

package
v2.0.2 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	OpenMatchService_CreateTicket_FullMethodName               = "/open_match2.OpenMatchService/CreateTicket"
	OpenMatchService_DeactivateTickets_FullMethodName          = "/open_match2.OpenMatchService/DeactivateTickets"
	OpenMatchService_ActivateTickets_FullMethodName            = "/open_match2.OpenMatchService/ActivateTickets"
	OpenMatchService_InvokeMatchmakingFunctions_FullMethodName = "/open_match2.OpenMatchService/InvokeMatchmakingFunctions"
	OpenMatchService_CreateAssignments_FullMethodName          = "/open_match2.OpenMatchService/CreateAssignments"
	OpenMatchService_WatchAssignments_FullMethodName           = "/open_match2.OpenMatchService/WatchAssignments"
)
View Source 
const (
	MatchMakingFunctionService_Run_FullMethodName = "/open_match2.MatchMakingFunctionService/Run"
)

Variables

View Source 
var (
	Pool_FilterBounds_name = map[int32]string{
		0: "EXCLUDE_NONE",

		1: "EXCLUDE_MIN",

		2: "EXCLUDE_MAX",

		3: "EXCLUDE_BOTH",
	}
	Pool_FilterBounds_value = map[string]int32{
		"EXCLUDE_NONE":     0,
		"INCLUDE_BOTH":     0,
		"EXCLUDE_MIN":      1,
		"EXCLUDE_START":    1,
		"INCLUDE_MAX_ONLY": 1,
		"EXCLUDE_MAX":      2,
		"EXCLUDE_END":      2,
		"INCLUDE_MIN_ONLY": 2,
		"EXCLUDE_BOTH":     3,
		"INCLUDE_NONE":     3,
	}
)

Enum value maps for Pool_FilterBounds.

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

Enum value maps for MatchmakingFunctionSpec_Type.

View Source 
var File_api_proto protoreflect.FileDescriptor
View Source 
var File_messages_proto protoreflect.FileDescriptor
View Source 
var File_mmf_proto protoreflect.FileDescriptor
View Source 
var MatchMakingFunctionService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "open_match2.MatchMakingFunctionService",
	HandlerType: (*MatchMakingFunctionServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Run",
			Handler:       _MatchMakingFunctionService_Run_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "mmf.proto",
}

MatchMakingFunctionService_ServiceDesc is the grpc.ServiceDesc for MatchMakingFunctionService 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 OpenMatchService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "open_match2.OpenMatchService",
	HandlerType: (*OpenMatchServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateTicket",
			Handler:    _OpenMatchService_CreateTicket_Handler,
		},
		{
			MethodName: "DeactivateTickets",
			Handler:    _OpenMatchService_DeactivateTickets_Handler,
		},
		{
			MethodName: "ActivateTickets",
			Handler:    _OpenMatchService_ActivateTickets_Handler,
		},
		{
			MethodName: "CreateAssignments",
			Handler:    _OpenMatchService_CreateAssignments_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "InvokeMatchmakingFunctions",
			Handler:       _OpenMatchService_InvokeMatchmakingFunctions_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "WatchAssignments",
			Handler:       _OpenMatchService_WatchAssignments_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "api.proto",
}

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

Functions

func RegisterMatchMakingFunctionServiceServer 

func RegisterMatchMakingFunctionServiceServer(s grpc.ServiceRegistrar, srv MatchMakingFunctionServiceServer)

func RegisterOpenMatchServiceServer 

func RegisterOpenMatchServiceServer(s grpc.ServiceRegistrar, srv OpenMatchServiceServer)

Types

type ActivateTicketsRequest 

type ActivateTicketsRequest struct {
	TicketIds []string `protobuf:"bytes,1,rep,name=ticket_ids,json=ticketIds,proto3" json:"ticket_ids,omitempty"`
	// contains filtered or unexported fields
}

ActivateTickets moves tickets from the inactive state back to the active state (will show up in pools).

func (*ActivateTicketsRequest) Descriptor deprecated 

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

Deprecated: Use ActivateTicketsRequest.ProtoReflect.Descriptor instead.

func (*ActivateTicketsRequest) GetTicketIds 

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

func (*ActivateTicketsRequest) ProtoMessage 

func (*ActivateTicketsRequest) ProtoMessage()

func (*ActivateTicketsRequest) ProtoReflect 

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

func (*ActivateTicketsRequest) Reset 

func (x *ActivateTicketsRequest) Reset()

func (*ActivateTicketsRequest) String 

func (x *ActivateTicketsRequest) String() string

type ActivateTicketsResponse 

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

func (*ActivateTicketsResponse) Descriptor deprecated 

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

Deprecated: Use ActivateTicketsResponse.ProtoReflect.Descriptor instead.

func (*ActivateTicketsResponse) ProtoMessage 

func (*ActivateTicketsResponse) ProtoMessage()

func (*ActivateTicketsResponse) ProtoReflect 

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

func (*ActivateTicketsResponse) Reset 

func (x *ActivateTicketsResponse) Reset()

func (*ActivateTicketsResponse) String 

func (x *ActivateTicketsResponse) String() string

type Assignment 

type Assignment struct {
	Connection string `protobuf:"bytes,1,opt,name=connection,proto3" json:"connection,omitempty"` // Connection information for this Assignment.
	// Optional, user-customized information (ignored by Open Match)
	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.

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 ChunkedMmfRunRequest 

type ChunkedMmfRunRequest struct {

	// Part of a profile chunked to fit in max gRPC message size
	Profile *Profile `protobuf:"bytes,1,opt,name=profile,proto3" json:"profile,omitempty"`
	// How many chunks this profile is broken into
	NumChunks int32 `protobuf:"varint,2,opt,name=num_chunks,json=numChunks,proto3" json:"num_chunks,omitempty"`
	// contains filtered or unexported fields
}

API reponse/request messages, used by api.proto and mmf.proto -------------------------------------------------------------- Arguments sent to your MMF can be more than the maximum gRPC message size of 4mb if you are sending a lot of tickets to your MMF. Your MMF should read the stream of PagedMmfRunRequests until it is complete, and concatinate pool participants based on pool name in order to reconstruct the full, unpaginated ticket pools.

func (*ChunkedMmfRunRequest) Descriptor deprecated 

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

Deprecated: Use ChunkedMmfRunRequest.ProtoReflect.Descriptor instead.

func (*ChunkedMmfRunRequest) GetNumChunks 

func (x *ChunkedMmfRunRequest) GetNumChunks() int32

func (*ChunkedMmfRunRequest) GetProfile 

func (x *ChunkedMmfRunRequest) GetProfile() *Profile

func (*ChunkedMmfRunRequest) ProtoMessage 

func (*ChunkedMmfRunRequest) ProtoMessage()

func (*ChunkedMmfRunRequest) ProtoReflect 

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

func (*ChunkedMmfRunRequest) Reset 

func (x *ChunkedMmfRunRequest) Reset()

func (*ChunkedMmfRunRequest) String 

func (x *ChunkedMmfRunRequest) String() string

type CreateAssignmentsRequest 

type CreateAssignmentsRequest struct {
	AssignmentRoster *Roster `protobuf:"bytes,1,opt,name=assignment_roster,json=assignmentRoster,proto3" json:"assignment_roster,omitempty"`
	// contains filtered or unexported fields
}

DEV/TEST ONLY - DO NOT USE IN PRODUCTION CreateAssignments creates an assignment for all Tickets in this Roster. These assignments can be retrieved with the Ticket ID using the WatchAssignments rpc.

func (*CreateAssignmentsRequest) Descriptor deprecated 

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

Deprecated: Use CreateAssignmentsRequest.ProtoReflect.Descriptor instead.

func (*CreateAssignmentsRequest) GetAssignmentRoster 

func (x *CreateAssignmentsRequest) GetAssignmentRoster() *Roster

func (*CreateAssignmentsRequest) ProtoMessage 

func (*CreateAssignmentsRequest) ProtoMessage()

func (*CreateAssignmentsRequest) ProtoReflect 

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

func (*CreateAssignmentsRequest) Reset 

func (x *CreateAssignmentsRequest) Reset()

func (*CreateAssignmentsRequest) String 

func (x *CreateAssignmentsRequest) String() string

type CreateAssignmentsResponse 

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

func (*CreateAssignmentsResponse) Descriptor deprecated 

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

Deprecated: Use CreateAssignmentsResponse.ProtoReflect.Descriptor instead.

func (*CreateAssignmentsResponse) ProtoMessage 

func (*CreateAssignmentsResponse) ProtoMessage()

func (*CreateAssignmentsResponse) ProtoReflect 

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

func (*CreateAssignmentsResponse) Reset 

func (x *CreateAssignmentsResponse) Reset()

func (*CreateAssignmentsResponse) String 

func (x *CreateAssignmentsResponse) String() string

type CreateTicketRequest 

type CreateTicketRequest struct {
	Ticket *Ticket `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// contains filtered or unexported fields
}

CreateTicket forcably assigns an unique TicketId and puts the ticket into state storage.

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 CreateTicketResponse 

type CreateTicketResponse struct {
	TicketId string `protobuf:"bytes,1,opt,name=ticket_id,json=ticketId,proto3" json:"ticket_id,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTicketResponse) Descriptor deprecated 

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

Deprecated: Use CreateTicketResponse.ProtoReflect.Descriptor instead.

func (*CreateTicketResponse) GetTicketId 

func (x *CreateTicketResponse) GetTicketId() string

func (*CreateTicketResponse) ProtoMessage 

func (*CreateTicketResponse) ProtoMessage()

func (*CreateTicketResponse) ProtoReflect 

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

func (*CreateTicketResponse) Reset 

func (x *CreateTicketResponse) Reset()

func (*CreateTicketResponse) String 

func (x *CreateTicketResponse) String() string

type DeactivateTicketsRequest 

type DeactivateTicketsRequest struct {
	TicketIds []string `protobuf:"bytes,1,rep,name=ticket_ids,json=ticketIds,proto3" json:"ticket_ids,omitempty"`
	// contains filtered or unexported fields
}

DeactivateTicket removes the Ticket from state storage asynchronously.

func (*DeactivateTicketsRequest) Descriptor deprecated 

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

Deprecated: Use DeactivateTicketsRequest.ProtoReflect.Descriptor instead.

func (*DeactivateTicketsRequest) GetTicketIds 

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

func (*DeactivateTicketsRequest) ProtoMessage 

func (*DeactivateTicketsRequest) ProtoMessage()

func (*DeactivateTicketsRequest) ProtoReflect 

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

func (*DeactivateTicketsRequest) Reset 

func (x *DeactivateTicketsRequest) Reset()

func (*DeactivateTicketsRequest) String 

func (x *DeactivateTicketsRequest) String() string

type DeactivateTicketsResponse 

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

func (*DeactivateTicketsResponse) Descriptor deprecated 

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

Deprecated: Use DeactivateTicketsResponse.ProtoReflect.Descriptor instead.

func (*DeactivateTicketsResponse) ProtoMessage 

func (*DeactivateTicketsResponse) ProtoMessage()

func (*DeactivateTicketsResponse) ProtoReflect 

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

func (*DeactivateTicketsResponse) Reset 

func (x *DeactivateTicketsResponse) Reset()

func (*DeactivateTicketsResponse) String 

func (x *DeactivateTicketsResponse) String() string

type Match 

type Match struct {
	Id      string             `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // User-defined Match ID added to telemetry. Used to correlate matches to logs and traces.
	Rosters map[string]*Roster ``                                                          // Tickets belonging to this match.
	/* 155-byte string literal not displayed */
	// Optional, user-customized information (ignored by Open Match)
	Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Match) Descriptor deprecated 

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

Deprecated: Use Match.ProtoReflect.Descriptor instead.

func (*Match) GetExtensions 

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

func (*Match) GetId 

func (x *Match) GetId() string

func (*Match) GetRosters 

func (x *Match) GetRosters() map[string]*Roster

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 MatchMakingFunctionServiceClient 

type MatchMakingFunctionServiceClient interface {
	// INTERNAL USE ONLY This is the specification open match uses to call your
	// matchmaking function on your behalf. Your MMF must handle this endpoint,
	// but your matchmaker should never call this directly, instead using
	// om-core's InvokeMatchmakingFunctions() API.
	Run(ctx context.Context, opts ...grpc.CallOption) (MatchMakingFunctionService_RunClient, error)
}

MatchMakingFunctionServiceClient is the client API for MatchMakingFunctionService 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 NewMatchMakingFunctionServiceClient 

func NewMatchMakingFunctionServiceClient(cc grpc.ClientConnInterface) MatchMakingFunctionServiceClient

type MatchMakingFunctionServiceServer 

type MatchMakingFunctionServiceServer interface {
	// INTERNAL USE ONLY This is the specification open match uses to call your
	// matchmaking function on your behalf. Your MMF must handle this endpoint,
	// but your matchmaker should never call this directly, instead using
	// om-core's InvokeMatchmakingFunctions() API.
	Run(MatchMakingFunctionService_RunServer) error
	// contains filtered or unexported methods
}

MatchMakingFunctionServiceServer is the server API for MatchMakingFunctionService service. All implementations must embed UnimplementedMatchMakingFunctionServiceServer for forward compatibility

type MatchMakingFunctionService_RunClient 

type MatchMakingFunctionService_RunClient interface {
	Send(*ChunkedMmfRunRequest) error
	Recv() (*StreamedMmfResponse, error)
	grpc.ClientStream
}

type MatchMakingFunctionService_RunServer 

type MatchMakingFunctionService_RunServer interface {
	Send(*StreamedMmfResponse) error
	Recv() (*ChunkedMmfRunRequest, error)
	grpc.ServerStream
}

type MatchmakingFunctionSpec 

type MatchmakingFunctionSpec struct {

	// User-defined name.
	//
	// Note: The MatchmakingFunctionSpec name is populated in log and telemetry
	// attributes.  Telemetry can be overwhelmed by too many unique mmf names
	// (google 'cardinality explosion' for more details), so as a general
	// guidance, try to keep the total number of mmf names you use to a few dozen
	// at most
	Name string                       `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Host string                       `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"`
	Port int32                        `protobuf:"varint,3,opt,name=port,proto3" json:"port,omitempty"`
	Type MatchmakingFunctionSpec_Type `protobuf:"varint,4,opt,name=type,proto3,enum=open_match2.MatchmakingFunctionSpec_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

specify MMF address and client type

func (*MatchmakingFunctionSpec) Descriptor deprecated 

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

Deprecated: Use MatchmakingFunctionSpec.ProtoReflect.Descriptor instead.

func (*MatchmakingFunctionSpec) GetHost 

func (x *MatchmakingFunctionSpec) GetHost() string

func (*MatchmakingFunctionSpec) GetName 

func (x *MatchmakingFunctionSpec) GetName() string

func (*MatchmakingFunctionSpec) GetPort 

func (x *MatchmakingFunctionSpec) GetPort() int32

func (*MatchmakingFunctionSpec) GetType 

func (x *MatchmakingFunctionSpec) GetType() MatchmakingFunctionSpec_Type

func (*MatchmakingFunctionSpec) ProtoMessage 

func (*MatchmakingFunctionSpec) ProtoMessage()

func (*MatchmakingFunctionSpec) ProtoReflect 

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

func (*MatchmakingFunctionSpec) Reset 

func (x *MatchmakingFunctionSpec) Reset()

func (*MatchmakingFunctionSpec) String 

func (x *MatchmakingFunctionSpec) String() string

type MatchmakingFunctionSpec_Type 

type MatchmakingFunctionSpec_Type int32
const (
	MatchmakingFunctionSpec_REST MatchmakingFunctionSpec_Type = 0
	MatchmakingFunctionSpec_GRPC MatchmakingFunctionSpec_Type = 1
)

func (MatchmakingFunctionSpec_Type) Descriptor 

func (MatchmakingFunctionSpec_Type) Descriptor() protoreflect.EnumDescriptor

func (MatchmakingFunctionSpec_Type) Enum 

func (x MatchmakingFunctionSpec_Type) Enum() *MatchmakingFunctionSpec_Type

func (MatchmakingFunctionSpec_Type) EnumDescriptor deprecated 

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

Deprecated: Use MatchmakingFunctionSpec_Type.Descriptor instead.

func (MatchmakingFunctionSpec_Type) Number 

func (x MatchmakingFunctionSpec_Type) Number() protoreflect.EnumNumber

func (MatchmakingFunctionSpec_Type) String 

func (x MatchmakingFunctionSpec_Type) String() string

func (MatchmakingFunctionSpec_Type) Type 

func (MatchmakingFunctionSpec_Type) Type() protoreflect.EnumType

type MmfRequest 

type MmfRequest struct {

	// A Profile to send to the MatchMakingFunction(s)
	Profile *Profile `protobuf:"bytes,1,opt,name=profile,proto3" json:"profile,omitempty"`
	// List of MatchMakingfunctions to invoke.
	Mmfs []*MatchmakingFunctionSpec `protobuf:"bytes,2,rep,name=mmfs,proto3" json:"mmfs,omitempty"`
	// contains filtered or unexported fields
}

MmfRequest is sent to the InvokeMatchmakingFunction() rpc call to define how to call your mmf, and what arguments to send it.

func (*MmfRequest) Descriptor deprecated 

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

Deprecated: Use MmfRequest.ProtoReflect.Descriptor instead.

func (*MmfRequest) GetMmfs 

func (x *MmfRequest) GetMmfs() []*MatchmakingFunctionSpec

func (*MmfRequest) GetProfile 

func (x *MmfRequest) GetProfile() *Profile

func (*MmfRequest) ProtoMessage 

func (*MmfRequest) ProtoMessage()

func (*MmfRequest) ProtoReflect 

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

func (*MmfRequest) Reset 

func (x *MmfRequest) Reset()

func (*MmfRequest) String 

func (x *MmfRequest) String() string

type OpenMatchServiceClient 

type OpenMatchServiceClient interface {
	// CreateTicket puts an immutable ticket into state storage, and returns it's Ticket Id.
	// Tickets will be actively expired after the configured OM_TICKET_TTL_SECS has passed.
	// Tickets are placed in the 'inactive' state when created (they will not show up in
	//
	//	pools sent to your matchmaking functions).  Use the ActivateTickets() RPC to move
	//	them to the 'active' state.
	CreateTicket(ctx context.Context, in *CreateTicketRequest, opts ...grpc.CallOption) (*CreateTicketResponse, error)
	// Deactivate tickets takes a list of ticket ids which it will move to the 'inactive'
	// state and returns the (estimated) completion time, after which the tickets will no
	// longer appear in pools sent to new matchmaking function invocations.
	DeactivateTickets(ctx context.Context, in *DeactivateTicketsRequest, opts ...grpc.CallOption) (*DeactivateTicketsResponse, error)
	// Activate tickets takes a list of ticket ids which it will move to the 'active'
	// state and returns the (estimated) completion time, after which the ticket will
	// appear in pools sent to new matchmaking function invocations.
	ActivateTickets(ctx context.Context, in *ActivateTicketsRequest, opts ...grpc.CallOption) (*ActivateTicketsResponse, error)
	// InvokeMatchmakingFunctions is the core of open match. As input, it receives:
	// - A Match Profile, consisting of:
	//   - A list of empty ticket pools, with filters defining how to find all
	//     players that belong to that pool.
	//   - A list of empty rosters, representing groups of tickets to assign to the resulting
	//     match. This is an optional construct but often used to represent teams (see
	//     the example matchmaking functions and the docs for more details)
	//
	// - A list of matchmaking function (aka MMF) endpoints
	// The RPC first looks at the pools in the request profile, and evaluates all the filters
	// in each to fill the pools with eligible tickets. Once all pools in the profile are
	// filled with all eligible tickets, a copy of the profile is sent to each matchmaking
	// function endpoint specified in the request. MMF calls are defined by a separate gRPC
	// service defined in proto/v2/mmf.proto, please reference it for details as to the input
	// and output of matchmaking functions.
	// All matches returned from all MMFs before the context deadline are then sent back
	// to OM's InvokeMatchmakingFunctions handler, which does the following:
	//   - Reads all rosters of all matches returned, and moves every ticket it finds in those
	//     rosters to the 'inactive' state.
	//   - Records statistics/telemetry for the results.
	//   - Sends those results out the output stream as a StreamedMmfResponse
	//
	// Note: cancelling the context (by, for example, closing the connection) does NOT
	//
	//	cancel the invoked MMFs, by design. They will run, make matches, and exit
	//	when they finish.
	InvokeMatchmakingFunctions(ctx context.Context, in *MmfRequest, opts ...grpc.CallOption) (OpenMatchService_InvokeMatchmakingFunctionsClient, error)
	// CreateAssignments creates an assignment for each ticket in the request's AssignmentRoster
	// field. Assignments are only guaranteed to exist until the ticket expires, although they MAY
	// continue to exist afterwords. This RPC is considered deprecated and should not be used in production.
	CreateAssignments(ctx context.Context, in *CreateAssignmentsRequest, opts ...grpc.CallOption) (*CreateAssignmentsResponse, error)
	// WatchAssignments streams back one assignment of each ticketID requested, if it exists before the
	// timeout is reached. This RPC is considered deprecated and should not be used in production.
	WatchAssignments(ctx context.Context, in *WatchAssignmentsRequest, opts ...grpc.CallOption) (OpenMatchService_WatchAssignmentsClient, error)
}

OpenMatchServiceClient is the client API for OpenMatchService 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 NewOpenMatchServiceClient 

func NewOpenMatchServiceClient(cc grpc.ClientConnInterface) OpenMatchServiceClient

type OpenMatchServiceServer 

type OpenMatchServiceServer interface {
	// CreateTicket puts an immutable ticket into state storage, and returns it's Ticket Id.
	// Tickets will be actively expired after the configured OM_TICKET_TTL_SECS has passed.
	// Tickets are placed in the 'inactive' state when created (they will not show up in
	//
	//	pools sent to your matchmaking functions).  Use the ActivateTickets() RPC to move
	//	them to the 'active' state.
	CreateTicket(context.Context, *CreateTicketRequest) (*CreateTicketResponse, error)
	// Deactivate tickets takes a list of ticket ids which it will move to the 'inactive'
	// state and returns the (estimated) completion time, after which the tickets will no
	// longer appear in pools sent to new matchmaking function invocations.
	DeactivateTickets(context.Context, *DeactivateTicketsRequest) (*DeactivateTicketsResponse, error)
	// Activate tickets takes a list of ticket ids which it will move to the 'active'
	// state and returns the (estimated) completion time, after which the ticket will
	// appear in pools sent to new matchmaking function invocations.
	ActivateTickets(context.Context, *ActivateTicketsRequest) (*ActivateTicketsResponse, error)
	// InvokeMatchmakingFunctions is the core of open match. As input, it receives:
	// - A Match Profile, consisting of:
	//   - A list of empty ticket pools, with filters defining how to find all
	//     players that belong to that pool.
	//   - A list of empty rosters, representing groups of tickets to assign to the resulting
	//     match. This is an optional construct but often used to represent teams (see
	//     the example matchmaking functions and the docs for more details)
	//
	// - A list of matchmaking function (aka MMF) endpoints
	// The RPC first looks at the pools in the request profile, and evaluates all the filters
	// in each to fill the pools with eligible tickets. Once all pools in the profile are
	// filled with all eligible tickets, a copy of the profile is sent to each matchmaking
	// function endpoint specified in the request. MMF calls are defined by a separate gRPC
	// service defined in proto/v2/mmf.proto, please reference it for details as to the input
	// and output of matchmaking functions.
	// All matches returned from all MMFs before the context deadline are then sent back
	// to OM's InvokeMatchmakingFunctions handler, which does the following:
	//   - Reads all rosters of all matches returned, and moves every ticket it finds in those
	//     rosters to the 'inactive' state.
	//   - Records statistics/telemetry for the results.
	//   - Sends those results out the output stream as a StreamedMmfResponse
	//
	// Note: cancelling the context (by, for example, closing the connection) does NOT
	//
	//	cancel the invoked MMFs, by design. They will run, make matches, and exit
	//	when they finish.
	InvokeMatchmakingFunctions(*MmfRequest, OpenMatchService_InvokeMatchmakingFunctionsServer) error
	// CreateAssignments creates an assignment for each ticket in the request's AssignmentRoster
	// field. Assignments are only guaranteed to exist until the ticket expires, although they MAY
	// continue to exist afterwords. This RPC is considered deprecated and should not be used in production.
	CreateAssignments(context.Context, *CreateAssignmentsRequest) (*CreateAssignmentsResponse, error)
	// WatchAssignments streams back one assignment of each ticketID requested, if it exists before the
	// timeout is reached. This RPC is considered deprecated and should not be used in production.
	WatchAssignments(*WatchAssignmentsRequest, OpenMatchService_WatchAssignmentsServer) error
	// contains filtered or unexported methods
}

OpenMatchServiceServer is the server API for OpenMatchService service. All implementations must embed UnimplementedOpenMatchServiceServer for forward compatibility

type OpenMatchService_InvokeMatchmakingFunctionsClient 

type OpenMatchService_InvokeMatchmakingFunctionsClient interface {
	Recv() (*StreamedMmfResponse, error)
	grpc.ClientStream
}

type OpenMatchService_InvokeMatchmakingFunctionsServer 

type OpenMatchService_InvokeMatchmakingFunctionsServer interface {
	Send(*StreamedMmfResponse) error
	grpc.ServerStream
}

type OpenMatchService_WatchAssignmentsClient 

type OpenMatchService_WatchAssignmentsClient interface {
	Recv() (*StreamedWatchAssignmentsResponse, error)
	grpc.ClientStream
}

type OpenMatchService_WatchAssignmentsServer 

type OpenMatchService_WatchAssignmentsServer interface {
	Send(*StreamedWatchAssignmentsResponse) error
	grpc.ServerStream
}

type Pool 

type Pool struct {
	Name                    string                        `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // User-defined name. Used to correlate logs, traces, and telemetry.
	TagPresentFilters       []*Pool_TagPresentFilter      `protobuf:"bytes,2,rep,name=tag_present_filters,json=tagPresentFilters,proto3" json:"tag_present_filters,omitempty"`
	StringEqualsFilters     []*Pool_StringEqualsFilter    `protobuf:"bytes,3,rep,name=string_equals_filters,json=stringEqualsFilters,proto3" json:"string_equals_filters,omitempty"`
	DoubleRangeFilters      []*Pool_DoubleRangeFilter     `protobuf:"bytes,4,rep,name=double_range_filters,json=doubleRangeFilters,proto3" json:"double_range_filters,omitempty"`
	CreationTimeRangeFilter *Pool_CreationTimeRangeFilter `` /* 134-byte string literal not displayed */
	// Output_only Participants are populated by the open match InvokeMatchMakingFunction RPC.
	Participants *Roster `protobuf:"bytes,6,opt,name=participants,proto3" json:"participants,omitempty"` // The tickets in open match that match all the filters of this Pool.
	// Optional, user-customized information (ignored by Open Match)
	Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */
	// 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) GetCreationTimeRangeFilter 

func (x *Pool) GetCreationTimeRangeFilter() *Pool_CreationTimeRangeFilter

func (*Pool) GetDoubleRangeFilters 

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

func (*Pool) GetExtensions 

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

func (*Pool) GetName 

func (x *Pool) GetName() string

func (*Pool) GetParticipants 

func (x *Pool) GetParticipants() *Roster

func (*Pool) GetStringEqualsFilters 

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

func (*Pool) GetTagPresentFilters 

func (x *Pool) GetTagPresentFilters() []*Pool_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 Pool_CreationTimeRangeFilter 

type Pool_CreationTimeRangeFilter struct {

	// Compares against the 'creation_time' field of the Ticket 'attributes'.
	Start  *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=start,proto3" json:"start,omitempty"`
	End    *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=end,proto3" json:"end,omitempty"`
	Bounds Pool_FilterBounds      `protobuf:"varint,4,opt,name=bounds,proto3,enum=open_match2.Pool_FilterBounds" json:"bounds,omitempty"` // Defines the bounds to apply when filtering tickets
	// contains filtered or unexported fields
}

func (*Pool_CreationTimeRangeFilter) Descriptor deprecated 

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

Deprecated: Use Pool_CreationTimeRangeFilter.ProtoReflect.Descriptor instead.

func (*Pool_CreationTimeRangeFilter) GetBounds 

func (x *Pool_CreationTimeRangeFilter) GetBounds() Pool_FilterBounds

func (*Pool_CreationTimeRangeFilter) GetEnd 

func (x *Pool_CreationTimeRangeFilter) GetEnd() *timestamppb.Timestamp

func (*Pool_CreationTimeRangeFilter) GetStart 

func (x *Pool_CreationTimeRangeFilter) GetStart() *timestamppb.Timestamp

func (*Pool_CreationTimeRangeFilter) ProtoMessage 

func (*Pool_CreationTimeRangeFilter) ProtoMessage()

func (*Pool_CreationTimeRangeFilter) ProtoReflect 

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

func (*Pool_CreationTimeRangeFilter) Reset 

func (x *Pool_CreationTimeRangeFilter) Reset()

func (*Pool_CreationTimeRangeFilter) String 

func (x *Pool_CreationTimeRangeFilter) String() string

type Pool_DoubleRangeFilter 

type Pool_DoubleRangeFilter struct {
	DoubleArg string            `protobuf:"bytes,1,opt,name=double_arg,json=doubleArg,proto3" json:"double_arg,omitempty"` // Which map key of the ticket's search_fields.double_args to filter
	Minimum   float64           `protobuf:"fixed64,2,opt,name=minimum,proto3" json:"minimum,omitempty"`
	Maximum   float64           `protobuf:"fixed64,3,opt,name=maximum,proto3" json:"maximum,omitempty"`
	Bounds    Pool_FilterBounds `protobuf:"varint,4,opt,name=bounds,proto3,enum=open_match2.Pool_FilterBounds" json:"bounds,omitempty"` // Defines the bounds to apply when filtering tickets
	// contains filtered or unexported fields
}

func (*Pool_DoubleRangeFilter) Descriptor deprecated 

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

Deprecated: Use Pool_DoubleRangeFilter.ProtoReflect.Descriptor instead.

func (*Pool_DoubleRangeFilter) GetBounds 

func (x *Pool_DoubleRangeFilter) GetBounds() Pool_FilterBounds

func (*Pool_DoubleRangeFilter) GetDoubleArg 

func (x *Pool_DoubleRangeFilter) GetDoubleArg() string

func (*Pool_DoubleRangeFilter) GetMaximum 

func (x *Pool_DoubleRangeFilter) GetMaximum() float64

func (*Pool_DoubleRangeFilter) GetMinimum 

func (x *Pool_DoubleRangeFilter) GetMinimum() float64

func (*Pool_DoubleRangeFilter) ProtoMessage 

func (*Pool_DoubleRangeFilter) ProtoMessage()

func (*Pool_DoubleRangeFilter) ProtoReflect 

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

func (*Pool_DoubleRangeFilter) Reset 

func (x *Pool_DoubleRangeFilter) Reset()

func (*Pool_DoubleRangeFilter) String 

func (x *Pool_DoubleRangeFilter) String() string

type Pool_FilterBounds 

type Pool_FilterBounds int32

enum used in filters to determine if they are inclusive or exclusive of min/max values. 

const (
	Pool_EXCLUDE_NONE     Pool_FilterBounds = 0 // MIN <= x <= MAX, i.e. Both bounds are included in results
	Pool_INCLUDE_BOTH     Pool_FilterBounds = 0
	Pool_EXCLUDE_MIN      Pool_FilterBounds = 1 // MIN <  x <= MAX, i.e. The minimum bound is excluded from results
	Pool_EXCLUDE_START    Pool_FilterBounds = 1
	Pool_INCLUDE_MAX_ONLY Pool_FilterBounds = 1
	Pool_EXCLUDE_MAX      Pool_FilterBounds = 2 // MIN <= x <  MAX, i.e. The maximum bound is excluded from results
	Pool_EXCLUDE_END      Pool_FilterBounds = 2
	Pool_INCLUDE_MIN_ONLY Pool_FilterBounds = 2
	Pool_EXCLUDE_BOTH     Pool_FilterBounds = 3 // MIN <  x <  MAX, i.e. Both bounds are excluded from results
	Pool_INCLUDE_NONE     Pool_FilterBounds = 3
)

func (Pool_FilterBounds) Descriptor 

func (Pool_FilterBounds) Descriptor() protoreflect.EnumDescriptor

func (Pool_FilterBounds) Enum 

func (x Pool_FilterBounds) Enum() *Pool_FilterBounds

func (Pool_FilterBounds) EnumDescriptor deprecated 

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

Deprecated: Use Pool_FilterBounds.Descriptor instead.

func (Pool_FilterBounds) Number 

func (x Pool_FilterBounds) Number() protoreflect.EnumNumber

func (Pool_FilterBounds) String 

func (x Pool_FilterBounds) String() string

func (Pool_FilterBounds) Type 

func (Pool_FilterBounds) Type() protoreflect.EnumType

type Pool_StringEqualsFilter 

type Pool_StringEqualsFilter struct {
	StringArg string `protobuf:"bytes,1,opt,name=string_arg,json=stringArg,proto3" json:"string_arg,omitempty"` // Which map key of the ticket's search_fields.string_args to filter
	Value     string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*Pool_StringEqualsFilter) Descriptor deprecated 

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

Deprecated: Use Pool_StringEqualsFilter.ProtoReflect.Descriptor instead.

func (*Pool_StringEqualsFilter) GetStringArg 

func (x *Pool_StringEqualsFilter) GetStringArg() string

func (*Pool_StringEqualsFilter) GetValue 

func (x *Pool_StringEqualsFilter) GetValue() string

func (*Pool_StringEqualsFilter) ProtoMessage 

func (*Pool_StringEqualsFilter) ProtoMessage()

func (*Pool_StringEqualsFilter) ProtoReflect 

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

func (*Pool_StringEqualsFilter) Reset 

func (x *Pool_StringEqualsFilter) Reset()

func (*Pool_StringEqualsFilter) String 

func (x *Pool_StringEqualsFilter) String() string

type Pool_TagPresentFilter 

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

Set of Filters. Tickets in this pool match all filters below. Filters only access data in the Ticket's "attributes" field. 

(A Pool is an 'intersection', in mathematical set terms)

func (*Pool_TagPresentFilter) Descriptor deprecated 

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

Deprecated: Use Pool_TagPresentFilter.ProtoReflect.Descriptor instead.

func (*Pool_TagPresentFilter) GetTag 

func (x *Pool_TagPresentFilter) GetTag() string

func (*Pool_TagPresentFilter) ProtoMessage 

func (*Pool_TagPresentFilter) ProtoMessage()

func (*Pool_TagPresentFilter) ProtoReflect 

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

func (*Pool_TagPresentFilter) Reset 

func (x *Pool_TagPresentFilter) Reset()

func (*Pool_TagPresentFilter) String 

func (x *Pool_TagPresentFilter) String() string

type Profile 

type Profile struct {

	// User-defined name.
	// By convention, name your profiles using reverse-dns notation, since the
	// profile name is populated in log and telemetry attributes.  Telemetry can
	// be overwhelmed by too many unique profile names (google 'cardinality
	// explosion' for more details), so Open Match strips out everything after
	// the last '.' in a profile name. As a general guidance, try to keep the
	// total number of resulting profile names that will be passed on to the
	// telemetry in the low dozens at most.  For example:
	// name = 'teamshooter.asia.2024-03-01-00:00:00'
	// and
	// name = 'teamshooter.asia.rev113148-8'
	// would both truncated when included in logs and telemetry as 'teamshooter.asia'
	Name  string           `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Pools map[string]*Pool `` // Set of pools to be queried and sent to the matchfunction
	/* 151-byte string literal not displayed */
	// Optional, user-customized information (ignored by Open Match)
	Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Profile) Descriptor deprecated 

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

Deprecated: Use Profile.ProtoReflect.Descriptor instead.

func (*Profile) GetExtensions 

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

func (*Profile) GetName 

func (x *Profile) GetName() string

func (*Profile) GetPools 

func (x *Profile) GetPools() map[string]*Pool

func (*Profile) ProtoMessage 

func (*Profile) ProtoMessage()

func (*Profile) ProtoReflect 

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

func (*Profile) Reset 

func (x *Profile) Reset()

func (*Profile) String 

func (x *Profile) String() string

type Roster 

type Roster struct {
	Name       string      `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Assignment *Assignment `protobuf:"bytes,2,opt,name=assignment,proto3" json:"assignment,omitempty"`
	Tickets    []*Ticket   `protobuf:"bytes,3,rep,name=tickets,proto3" json:"tickets,omitempty"`
	// Optional, user-customized information (ignored by Open Match)
	Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

A Roster is a group of Tickets that share an assignment.

func (*Roster) Descriptor deprecated 

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

Deprecated: Use Roster.ProtoReflect.Descriptor instead.

func (*Roster) GetAssignment 

func (x *Roster) GetAssignment() *Assignment

func (*Roster) GetExtensions 

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

func (*Roster) GetName 

func (x *Roster) GetName() string

func (*Roster) GetTickets 

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

func (*Roster) ProtoMessage 

func (*Roster) ProtoMessage()

func (*Roster) ProtoReflect 

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

func (*Roster) Reset 

func (x *Roster) Reset()

func (*Roster) String 

func (x *Roster) String() string

type StreamedMmfResponse 

type StreamedMmfResponse struct {
	Match *Match `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	// contains filtered or unexported fields
}

A stream of matches. This is sent from your MMF to om-core, and om-core in turn sends this back to your matchmaker. Max message size is default 4MB, and om-core does not try to increase it; as a result you should return matches that are less than 4mb each or you'll get RPC errors. Although typical best pratice recommends defining separate reponse types for the mmf.Run() and om-core.InvokeMmfs() RPCs, here we've intentionally made them share a response message so it's completely clear that your mmf response to om-core will be exactly what om-core returns to your matchmaker.

func (*StreamedMmfResponse) Descriptor deprecated 

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

Deprecated: Use StreamedMmfResponse.ProtoReflect.Descriptor instead.

func (*StreamedMmfResponse) GetMatch 

func (x *StreamedMmfResponse) GetMatch() *Match

func (*StreamedMmfResponse) ProtoMessage 

func (*StreamedMmfResponse) ProtoMessage()

func (*StreamedMmfResponse) ProtoReflect 

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

func (*StreamedMmfResponse) Reset 

func (x *StreamedMmfResponse) Reset()

func (*StreamedMmfResponse) String 

func (x *StreamedMmfResponse) String() string

type StreamedWatchAssignmentsResponse 

type StreamedWatchAssignmentsResponse struct {
	Assignment *Assignment `protobuf:"bytes,1,opt,name=assignment,proto3" json:"assignment,omitempty"`
	Id         string      `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*StreamedWatchAssignmentsResponse) Descriptor deprecated 

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

Deprecated: Use StreamedWatchAssignmentsResponse.ProtoReflect.Descriptor instead.

func (*StreamedWatchAssignmentsResponse) GetAssignment 

func (x *StreamedWatchAssignmentsResponse) GetAssignment() *Assignment

func (*StreamedWatchAssignmentsResponse) GetId 

func (x *StreamedWatchAssignmentsResponse) GetId() string

func (*StreamedWatchAssignmentsResponse) ProtoMessage 

func (*StreamedWatchAssignmentsResponse) ProtoMessage()

func (*StreamedWatchAssignmentsResponse) ProtoReflect 

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

func (*StreamedWatchAssignmentsResponse) Reset 

func (x *StreamedWatchAssignmentsResponse) Reset()

func (*StreamedWatchAssignmentsResponse) String 

func (x *StreamedWatchAssignmentsResponse) String() string

type Ticket 

type Ticket struct {

	// auto-generated Id populated by Open Match.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Open Match populates to (the current time + OM_TICKET_TTL_SECS)
	ExpirationTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=expiration_time,json=expirationTime,proto3" json:"expiration_time,omitempty"`
	Attributes     *Ticket_FilterableData `protobuf:"bytes,3,opt,name=attributes,proto3" json:"attributes,omitempty"` // fields which Open Match filters can access
	// Optional, user-customized information (ignored by Open Match)
	Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */
	// 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.

func (*Ticket) Descriptor deprecated 

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

Deprecated: Use Ticket.ProtoReflect.Descriptor instead.

func (*Ticket) GetAttributes 

func (x *Ticket) GetAttributes() *Ticket_FilterableData

func (*Ticket) GetExpirationTime 

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

func (*Ticket) GetExtensions 

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

func (*Ticket) GetId 

func (x *Ticket) GetId() string

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 Ticket_FilterableData 

type Ticket_FilterableData struct {
	Tags       []string          `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty"` // Strings, filterable on presence of tag.
	StringArgs map[string]string ``                                                              // key+value pairs, string values filterable on equality.
	/* 179-byte string literal not displayed */
	DoubleArgs map[string]float64 `` // key+value pairs, float values filterable on ranges.
	/* 181-byte string literal not displayed */
	// Override-able timestamp.
	// Open Match will populate this with the current time
	// if you don't specify a value at ticket creation.
	CreationTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=creation_time,json=creationTime,proto3" json:"creation_time,omitempty"`
	// contains filtered or unexported fields
}

Fields indexed by Open Match which can be used when specifying filters. NOTE: Every field that you populate in this data structure consumes significant Open Match core CPU & memory! Be frugal and only use this data structure for fields you will use to construct Ticket Pools; if you just want to access some ticket-specific data in your matchmaker or MMF, put it in the Ticket's more efficient 'extensions' field instead, which Open Match just stores and forwards to your code without additional parsing, indexing, or processing.

func (*Ticket_FilterableData) Descriptor deprecated 

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

Deprecated: Use Ticket_FilterableData.ProtoReflect.Descriptor instead.

func (*Ticket_FilterableData) GetCreationTime 

func (x *Ticket_FilterableData) GetCreationTime() *timestamppb.Timestamp

func (*Ticket_FilterableData) GetDoubleArgs 

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

func (*Ticket_FilterableData) GetStringArgs 

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

func (*Ticket_FilterableData) GetTags 

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

func (*Ticket_FilterableData) ProtoMessage 

func (*Ticket_FilterableData) ProtoMessage()

func (*Ticket_FilterableData) ProtoReflect 

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

func (*Ticket_FilterableData) Reset 

func (x *Ticket_FilterableData) Reset()

func (*Ticket_FilterableData) String 

func (x *Ticket_FilterableData) String() string

type UnimplementedMatchMakingFunctionServiceServer 

type UnimplementedMatchMakingFunctionServiceServer struct {
}

UnimplementedMatchMakingFunctionServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedMatchMakingFunctionServiceServer) Run 

func (UnimplementedMatchMakingFunctionServiceServer) Run(MatchMakingFunctionService_RunServer) error

type UnimplementedOpenMatchServiceServer 

type UnimplementedOpenMatchServiceServer struct {
}

UnimplementedOpenMatchServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedOpenMatchServiceServer) ActivateTickets 

func (UnimplementedOpenMatchServiceServer) ActivateTickets(context.Context, *ActivateTicketsRequest) (*ActivateTicketsResponse, error)

func (UnimplementedOpenMatchServiceServer) CreateAssignments 

func (UnimplementedOpenMatchServiceServer) CreateAssignments(context.Context, *CreateAssignmentsRequest) (*CreateAssignmentsResponse, error)

func (UnimplementedOpenMatchServiceServer) CreateTicket 

func (UnimplementedOpenMatchServiceServer) CreateTicket(context.Context, *CreateTicketRequest) (*CreateTicketResponse, error)

func (UnimplementedOpenMatchServiceServer) DeactivateTickets 

func (UnimplementedOpenMatchServiceServer) DeactivateTickets(context.Context, *DeactivateTicketsRequest) (*DeactivateTicketsResponse, error)

func (UnimplementedOpenMatchServiceServer) InvokeMatchmakingFunctions 

func (UnimplementedOpenMatchServiceServer) InvokeMatchmakingFunctions(*MmfRequest, OpenMatchService_InvokeMatchmakingFunctionsServer) error

func (UnimplementedOpenMatchServiceServer) WatchAssignments 

func (UnimplementedOpenMatchServiceServer) WatchAssignments(*WatchAssignmentsRequest, OpenMatchService_WatchAssignmentsServer) error

type UnsafeMatchMakingFunctionServiceServer 

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

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

type UnsafeOpenMatchServiceServer 

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

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

type WatchAssignmentsRequest 

type WatchAssignmentsRequest struct {
	TicketIds []string `protobuf:"bytes,1,rep,name=ticket_ids,json=ticketIds,proto3" json:"ticket_ids,omitempty"`
	// contains filtered or unexported fields
}

DEV/TEST ONLY - DO NOT USE IN PRODUCTION WatchAssignments streams back results of the AssignTickets RPC that affected these TicketIds.

func (*WatchAssignmentsRequest) Descriptor deprecated 

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

Deprecated: Use WatchAssignmentsRequest.ProtoReflect.Descriptor instead.

func (*WatchAssignmentsRequest) GetTicketIds 

func (x *WatchAssignmentsRequest) GetTicketIds() []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

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.