rcon

package

v1.0.10 Latest Latest Go to latest Published: Jan 28, 2023 License: MIT Imports: 14 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/leighmacdonald/rcon

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ReadConfig(cfgFile string) error
type RemoteConsole
- func Dial(ctx context.Context, host, password string, timeout time.Duration) (*RemoteConsole, error)
type Server

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrAuthFailed          = errors.New("rcon: authentication failed")
	ErrInvalidAuthResponse = errors.New("rcon: invalid response type during auth")
	ErrUnexpectedFormat    = errors.New("rcon: unexpected response format")
	ErrCommandTooLong      = errors.New("rcon: command too long")
	ErrResponseTooLong     = errors.New("rcon: response too long")
)

View Source

var BuildVersion = "master"

View Source

var Config *rootConfig

Functions ¶

func ReadConfig ¶ added in v1.0.4

func ReadConfig(cfgFile string) error

ReadConfig reads in config file and ENV variables if set.

Types ¶

type RemoteConsole ¶

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

func Dial ¶

func Dial(ctx context.Context, host, password string, timeout time.Duration) (*RemoteConsole, error)

func (*RemoteConsole) Close ¶

func (r *RemoteConsole) Close() error

func (*RemoteConsole) Exec ¶

func (r *RemoteConsole) Exec(c string) (string, error)

func (*RemoteConsole) LocalAddr ¶

func (r *RemoteConsole) LocalAddr() net.Addr

func (*RemoteConsole) Read ¶

func (r *RemoteConsole) Read() (response string, requestID int, err error)

func (*RemoteConsole) RemoteAddr ¶

func (r *RemoteConsole) RemoteAddr() net.Addr

func (*RemoteConsole) Write ¶

func (r *RemoteConsole) Write(cmd string) (requestID int, err error)

type Server ¶ added in v1.0.4

type Server struct {
	Name     string `mapstructure:"name"`
	Host     string `mapstructure:"host"`
	Password string `mapstructure:"password"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL