server

Documentation

Overview

Package server contains golang implementations for common matchmaking function gRPC server functionality, like starting up the server, or parsing the chunked profile format sent by om-core.

• The MMF Server is defined in the proto/mmf.proto file. If you want to write your MMFs in golang, you can use the protoc-generated grpc server module in pkg/pb/mmf*.go. If you want to write it in a different language, consult the protoc documentation for instructions on generating grpc server source files in your language of choice.
• This package doesn't include the matchmaking function itself. You pass in a Server struct when calling Start that includes your MMF Run() implementation.

Index

• func GetChunkedRequest(stream pb.MatchMakingFunctionService_RunServer) (*pb.Profile, error)
• func StartServer(port int32, mmfServer pb.MatchMakingFunctionServiceServer, l *logrus.Logger) error

Functions

func GetChunkedRequest

func GetChunkedRequest(stream pb.MatchMakingFunctionService_RunServer) (*pb.Profile, error)

GetChunkedRequest is a function that receives a MMF Server request stream and re-assembles the profile in that request. Profiles are 'chunked' when the profile contains enough participating tickets in it's pools that it is larger than the 4MB default max size of a single protobuf message. Each 'chunk' contains the complete profile and a portion of the tickets participating in the profile's pools.

func StartServer

func StartServer(port int32, mmfServer pb.MatchMakingFunctionServiceServer, l *logrus.Logger) error

Start creates and starts the Match Function server