api

Documentation

Index

• Variables
• func PlayerToProto(p proxy.Player) *pb.Player
• func PlayersToProto(p []proxy.Player) []*pb.Player
• func ServerToProto(s proxy.RegisteredServer) *pb.Server
• func ServersToProto(s []proxy.RegisteredServer) []*pb.Server
• type Config
  • func (c Config) Validate() (warns []error, errs []error)
• type Handler
• type Server
  • func NewServer(cfg Config, h Handler) *Server
  • func (s *Server) Start(ctx context.Context) error
• type Service
  • func NewService(p *proxy.Proxy) *Service
  • func (s *Service) ConnectPlayer(ctx context.Context, c *connect.Request[pb.ConnectPlayerRequest]) (*connect.Response[pb.ConnectPlayerResponse], error)
  • func (s *Service) DisconnectPlayer(ctx context.Context, c *connect.Request[pb.DisconnectPlayerRequest]) (*connect.Response[pb.DisconnectPlayerResponse], error)
  • func (s *Service) GetPlayer(ctx context.Context, c *connect.Request[pb.GetPlayerRequest]) (*connect.Response[pb.GetPlayerResponse], error)
  • func (s *Service) ListPlayers(ctx context.Context, c *connect.Request[pb.ListPlayersRequest]) (*connect.Response[pb.ListPlayersResponse], error)
  • func (s *Service) ListServers(ctx context.Context, c *connect.Request[pb.ListServersRequest]) (*connect.Response[pb.ListServersResponse], error)
  • func (s *Service) RegisterServer(ctx context.Context, c *connect.Request[pb.RegisterServerRequest]) (*connect.Response[pb.RegisterServerResponse], error)
  • func (s *Service) UnregisterServer(ctx context.Context, c *connect.Request[pb.UnregisterServerRequest]) (*connect.Response[pb.UnregisterServerResponse], error)

Variables

var DefaultConfig = Config{
	Bind: "localhost:8080",
}

DefaultConfig is the default configuration for the Config.

Functions

func PlayerToProto

func PlayerToProto(p proxy.Player) *pb.Player

func PlayersToProto

func PlayersToProto(p []proxy.Player) []*pb.Player

func ServerToProto

func ServerToProto(s proxy.RegisteredServer) *pb.Server

func ServersToProto

func ServersToProto(s []proxy.RegisteredServer) []*pb.Server

Types

type Config

type Config struct {
	// Bind is the address to bind the API server to.
	// Using a localhost address is recommended to avoid exposing the API to the public.
	Bind string `json:"bind,omitempty" yaml:"bind,omitempty"`
}

Config is the configuration for the Gate API.

func (Config) Validate

func (c Config) Validate() (warns []error, errs []error)

Validate validates the API configuration.

type Handler

type Handler = gatev1connect.GateServiceHandler

type Server

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

func NewServer

func NewServer(cfg Config, h Handler) *Server

func (*Server) Start

func (s *Server) Start(ctx context.Context) error

type Service

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

func NewService

func NewService(p *proxy.Proxy) *Service

func (*Service) ConnectPlayer

func (s *Service) ConnectPlayer(ctx context.Context, c *connect.Request[pb.ConnectPlayerRequest]) (*connect.Response[pb.ConnectPlayerResponse], error)

func (*Service) DisconnectPlayer

func (s *Service) DisconnectPlayer(ctx context.Context, c *connect.Request[pb.DisconnectPlayerRequest]) (*connect.Response[pb.DisconnectPlayerResponse], error)

func (*Service) GetPlayer

func (s *Service) GetPlayer(ctx context.Context, c *connect.Request[pb.GetPlayerRequest]) (*connect.Response[pb.GetPlayerResponse], error)

func (*Service) ListPlayers

func (s *Service) ListPlayers(ctx context.Context, c *connect.Request[pb.ListPlayersRequest]) (*connect.Response[pb.ListPlayersResponse], error)

func (*Service) ListServers

func (s *Service) ListServers(ctx context.Context, c *connect.Request[pb.ListServersRequest]) (*connect.Response[pb.ListServersResponse], error)

func (*Service) RegisterServer

func (s *Service) RegisterServer(ctx context.Context, c *connect.Request[pb.RegisterServerRequest]) (*connect.Response[pb.RegisterServerResponse], error)

func (*Service) UnregisterServer

func (s *Service) UnregisterServer(ctx context.Context, c *connect.Request[pb.UnregisterServerRequest]) (*connect.Response[pb.UnregisterServerResponse], error)