rcon

Documentation

Index

• Variables
• type Client
  • func Connect(host string, port uint16, options ...options.RCON) (*Client, error)
  • func (r *Client) Close() error
  • func (r *Client) Execute(ctx context.Context, command string) (string, error)
  • func (r *Client) Login(password string) error
  • func (r *Client) Run(command string) error

Variables

var (
	// ErrNotConnected means the client attempted to send data but there was no connection to the server
	ErrNotConnected = errors.New("rcon: not connected to the server")
	// ErrAlreadyLoggedIn means the RCON client was already logged in but a second login attempt was made
	ErrAlreadyLoggedIn = errors.New("rcon: already successfully logged in")
	// ErrInvalidPassword means the password used in the RCON login was incorrect
	ErrInvalidPassword = errors.New("rcon: incorrect password")
	// ErrNotAuthenticated means the client attempted to execute a command before a login was successful
	ErrNotAuthenticated = errors.New("rcon: not authenticated with the server")
)

Types

type Client

type Client struct {
	Messages chan string
	// contains filtered or unexported fields
}

Client is a client for interacting with RCON and contains multiple methods

func Connect

func Connect(host string, port uint16, options ...options.RCON) (*Client, error)

Connect connects to the server using the address provided and returns a new client

func (*Client) Close

func (r *Client) Close() error

Close closes the connection to the server

func (*Client) Execute

func (r *Client) Execute(ctx context.Context, command string) (string, error)

Execute runs the command on the server and attempts to wait for a response

func (*Client) Login

func (r *Client) Login(password string) error

Login communicates authentication with the server using the plaintext password

func (*Client) Run

func (r *Client) Run(command string) error

Run executes the command on the server but does not wait for a response