client

Documentation

Overview

Package client provides a typed Go client for interacting with a factop server over NATS. It handles the RCON-over-NATS connection and provides the base for command-specific sub-packages.

Convention: each softmod/factop/<name>.lua that registers custom commands gets a corresponding client/<name>/ package. The Lua file defines the server-side commands; the Go package provides the typed client methods.

softmod/factop/tiles.lua  →  client/tiles/  (TilesClient)
softmod/factop/foo.lua    →  client/foo/    (FooClient)

All sub-packages accept a *client.Conn and use its Rcon method to send commands to the factop server.

Index

• Constants
• type Conn
  • func Dial(natsURL string, opts ...Option) (*Conn, error)
  • func (c *Conn) Close()
  • func (c *Conn) Rcon(command string) (string, error)
• type Option
  • func WithTimeout(d time.Duration) Option

Constants

const (
	DefaultTimeout = 10 * time.Second
	RconSubject    = "factop.rcon"
)

Types

type Conn

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

Conn wraps a NATS connection for communicating with a factop server.

func Dial

func Dial(natsURL string, opts ...Option) (*Conn, error)

Dial connects to the NATS server at the given URL and returns a Conn.

func (*Conn) Close

func (c *Conn) Close()

Close closes the underlying NATS connection.

func (*Conn) Rcon

func (c *Conn) Rcon(command string) (string, error)

Rcon sends a raw RCON command string to the factop server and returns the response. This is the low-level method used by all sub-packages.

type Option

type Option func(*Conn)

Option configures a Conn.

func WithTimeout

func WithTimeout(d time.Duration) Option

WithTimeout sets the RCON request timeout.