server

Documentation

Index

• type Registry
  • func NewDefaultRegistry() *Registry
  • func (r *Registry) AddServer(srv *Server)
  • func (r *Registry) RemoveServer(srv *Server)
  • func (r *Registry) Server(name string) (*Server, bool)
  • func (r *Registry) Servers() (all []*Server)
• type Server
  • func New(name, address string) *Server
  • func (s *Server) Address() string
  • func (s *Server) DecrementPlayerCount()
  • func (s *Server) IncrementPlayerCount()
  • func (s *Server) Name() string
  • func (s *Server) PlayerCount() int

Types

type Registry

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

Registry represents a registry which stores the severs registered on the proxy.

func NewDefaultRegistry

func NewDefaultRegistry() *Registry

NewDefaultRegistry creates a new Registry and returns it.

func (*Registry) AddServer

func (r *Registry) AddServer(srv *Server)

AddServer adds a server to the register.

func (*Registry) RemoveServer

func (r *Registry) RemoveServer(srv *Server)

RemoveServer removes a server from the register.

func (*Registry) Server

func (r *Registry) Server(name string) (*Server, bool)

Server attempts to find a server from its name, and returns the server and if it was found or not.

func (*Registry) Servers

func (r *Registry) Servers() (all []*Server)

Servers returns a slice of all the available servers on the proxy.

type Server

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

Server represents a server connected to the proxy which players can join and play on.

func New

func New(name, address string) *Server

New creates a new Server with the provided name, group and address.

func (*Server) Address

func (s *Server) Address() string

Address returns the IP address the server was registered with. This should also contain the port separated by a colon. E.g. "127.0.0.1:19132".

func (*Server) DecrementPlayerCount

func (s *Server) DecrementPlayerCount()

DecrementPlayerCount decreases the player count of the server.

func (*Server) IncrementPlayerCount

func (s *Server) IncrementPlayerCount()

IncrementPlayerCount increments the player count of the server.

func (*Server) Name

func (s *Server) Name() string

Name returns the name the server was registered with.

func (*Server) PlayerCount

func (s *Server) PlayerCount() int

PlayerCount returns the player count of the server controlled by the IncrementPlayerCount and DecrementPlayerCount functions above.