api

Documentation

Index

• type API
  • func NewAPI(registry *session.Registry, logger *slog.Logger, authentication Authentication) *API
  • func (a *API) Accept() (err error)
  • func (a *API) Close() (err error)
  • func (a *API) Listen(addr string) (err error)
  • func (a *API) RegisterHandler(packet uint32, h handler)
• type Authentication
• type Client
  • func Dial(addr, token string) (c *Client, err error)
  • func NewClient(conn net.Conn, pool packet.Pool) *Client
  • func (c *Client) Close() error
  • func (c *Client) ReadPacket() (pk packet.Packet, err error)
  • func (c *Client) WritePacket(pk packet.Packet) error
• type SecretBasedAuthentication
  • func NewSecretBasedAuthentication(secret string) *SecretBasedAuthentication
  • func (authentication *SecretBasedAuthentication) Authenticate(token string) bool

Types

type API

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

API represents a service that enables servers to communicate with the proxy over the TCP protocol. It supports operations such as transferring and kicking players, and allows for the registration of custom packets via packet.Register(). Packets can be handled using RegisterHandler().

func NewAPI

func NewAPI(registry *session.Registry, logger *slog.Logger, authentication Authentication) *API

NewAPI creates a new API service instance using the provided session.Registry.

func (*API) Accept

func (a *API) Accept() (err error)

Accept accepts an incoming client connection and handles it.

func (*API) Close

func (a *API) Close() (err error)

Close closes the listener and all connected clients.

func (*API) Listen

func (a *API) Listen(addr string) (err error)

Listen sets up a net.Listener for incoming connections based on the specified address.

func (*API) RegisterHandler

func (a *API) RegisterHandler(packet uint32, h handler)

RegisterHandler registers a handler for the specified packet.

type Authentication

type Authentication interface {
	// Authenticate checks if the provided token is valid.
	Authenticate(token string) bool
}

Authentication defines an interface for authentication methods.

type Client

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

Client represents a connection to the API service, managing packet reading and writing over an underlying net.Conn.

func Dial

func Dial(addr, token string) (c *Client, err error)

Dial establishes a TCP connection to the specified API service address using the provided token. It returns a new Client instance if the connection and authentication are successful. Otherwise, it returns an error indicating the failure reason.

func NewClient

func NewClient(conn net.Conn, pool packet.Pool) *Client

NewClient creates a new Client instance using the provided net.Conn. It is used for reading and writing packets to the underlying connection.

func (*Client) Close

func (c *Client) Close() error

Close closes the underlying connection.

func (*Client) ReadPacket

func (c *Client) ReadPacket() (pk packet.Packet, err error)

ReadPacket reads the next available packet from the connection and decodes it.

func (*Client) WritePacket

func (c *Client) WritePacket(pk packet.Packet) error

WritePacket encodes and writes the provided packet to the underlying connection.

type SecretBasedAuthentication

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

SecretBasedAuthentication implements the Authentication interface using a secret token for authentication.

func NewSecretBasedAuthentication

func NewSecretBasedAuthentication(secret string) *SecretBasedAuthentication

NewSecretBasedAuthentication creates a new SecretBasedAuthentication instance with the given secret token.

func (*SecretBasedAuthentication) Authenticate

func (authentication *SecretBasedAuthentication) Authenticate(token string) bool

Authenticate ...