frontend

Documentation

Overview

frontend is a package compiled from the protobuffer in <REPO_ROOT>/api/protobuf-spec/frontend.proto. It is auto-generated and shouldn't be edited.

Package frontend is a generated protocol buffer package.

It is generated from these files:

frontend.proto

It has these top-level messages:

Group
PlayerId
ConnectionInfo
Result

Index

• func RegisterAPIServer(s *grpc.Server, srv APIServer)
• type APIClient
  • func NewAPIClient(cc *grpc.ClientConn) APIClient
• type APIServer
• type ConnectionInfo
  • func (*ConnectionInfo) Descriptor() ([]byte, []int)
  • func (m *ConnectionInfo) GetConnectionString() string
  • func (*ConnectionInfo) ProtoMessage()
  • func (m *ConnectionInfo) Reset()
  • func (m *ConnectionInfo) String() string
• type Group
  • func (*Group) Descriptor() ([]byte, []int)
  • func (m *Group) GetId() string
  • func (m *Group) GetProperties() string
  • func (*Group) ProtoMessage()
  • func (m *Group) Reset()
  • func (m *Group) String() string
• type PlayerId
  • func (*PlayerId) Descriptor() ([]byte, []int)
  • func (m *PlayerId) GetId() string
  • func (*PlayerId) ProtoMessage()
  • func (m *PlayerId) Reset()
  • func (m *PlayerId) String() string
• type Result
  • func (*Result) Descriptor() ([]byte, []int)
  • func (m *Result) GetError() string
  • func (m *Result) GetSuccess() bool
  • func (*Result) ProtoMessage()
  • func (m *Result) Reset()
  • func (m *Result) String() string

Functions

func RegisterAPIServer

func RegisterAPIServer(s *grpc.Server, srv APIServer)

Types

type APIClient

type APIClient interface {
	CreateRequest(ctx context.Context, in *Group, opts ...grpc.CallOption) (*Result, error)
	DeleteRequest(ctx context.Context, in *Group, opts ...grpc.CallOption) (*Result, error)
	GetAssignment(ctx context.Context, in *PlayerId, opts ...grpc.CallOption) (*ConnectionInfo, error)
	DeleteAssignment(ctx context.Context, in *PlayerId, opts ...grpc.CallOption) (*Result, error)
}

func NewAPIClient

func NewAPIClient(cc *grpc.ClientConn) APIClient

type APIServer

type APIServer interface {
	CreateRequest(context.Context, *Group) (*Result, error)
	DeleteRequest(context.Context, *Group) (*Result, error)
	GetAssignment(context.Context, *PlayerId) (*ConnectionInfo, error)
	DeleteAssignment(context.Context, *PlayerId) (*Result, error)
}

type ConnectionInfo

type ConnectionInfo struct {
	ConnectionString string `protobuf:"bytes,1,opt,name=connection_string,json=connectionString" json:"connection_string,omitempty"`
}

Simple message used to pass the connection string for the DGS to the player.

func (*ConnectionInfo) Descriptor

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

func (*ConnectionInfo) GetConnectionString

func (m *ConnectionInfo) GetConnectionString() string

func (*ConnectionInfo) ProtoMessage

func (*ConnectionInfo) ProtoMessage()

func (*ConnectionInfo) Reset

func (m *ConnectionInfo) Reset()

func (*ConnectionInfo) String

func (m *ConnectionInfo) String() string

type Group

type Group struct {
	Id         string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Properties string `protobuf:"bytes,2,opt,name=properties" json:"properties,omitempty"`
}

Data structure for a group of players to pass to the matchmaking function. Obviously, the group can be a group of one!

func (*Group) Descriptor

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

func (*Group) GetId

func (m *Group) GetId() string

func (*Group) GetProperties

func (m *Group) GetProperties() string

func (*Group) ProtoMessage

func (*Group) ProtoMessage()

func (*Group) Reset

func (m *Group) Reset()

func (*Group) String

func (m *Group) String() string

type PlayerId

type PlayerId struct {
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}

func (*PlayerId) Descriptor

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

func (*PlayerId) GetId

func (m *PlayerId) GetId() string

func (*PlayerId) ProtoMessage

func (*PlayerId) ProtoMessage()

func (*PlayerId) Reset

func (m *PlayerId) Reset()

func (*PlayerId) String

func (m *PlayerId) String() string

type Result

type Result struct {
	Success bool   `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	Error   string `protobuf:"bytes,2,opt,name=error" json:"error,omitempty"`
}

Simple message to return success/failure and error status.

func (*Result) Descriptor

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

func (*Result) GetError

func (m *Result) GetError() string

func (*Result) GetSuccess

func (m *Result) GetSuccess() bool

func (*Result) ProtoMessage

func (*Result) ProtoMessage()

func (*Result) Reset

func (m *Result) Reset()

func (*Result) String

func (m *Result) String() string