rcon

Documentation

Index

• Variables
• func Modules() fx.Option
• func NewRCON() func(NewRCONParams) (RCON, error)
• type NewRCONParams
• type RCON
• type RCONConn
  • func (r *RCONConn) Connect(ctx context.Context)
  • func (r *RCONConn) Execute(ctx context.Context, command string) (string, error)
  • func (r *RCONConn) IsReady() bool

Variables

var (
	ErrTimeout = errors.New("RCON connection is not established within deadline threshold")
)

Functions

func Modules

func Modules() fx.Option

func NewRCON

func NewRCON() func(NewRCONParams) (RCON, error)

Types

type NewRCONParams

type NewRCONParams struct {
	fx.In

	Lifecycle fx.Lifecycle
	Config    *configs.Config
	Logger    *logger.Logger
}

type RCON

type RCON interface {
	Close() error
	Execute(ctx context.Context, command string) (string, error)
	LocalAddr() net.Addr
	RemoteAddr() net.Addr
	IsReady() bool
}

type RCONConn

type RCONConn struct {
	*rcon.Conn
	// contains filtered or unexported fields
}

func (*RCONConn) Connect

func (r *RCONConn) Connect(ctx context.Context)

func (*RCONConn) Execute

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

func (*RCONConn) IsReady

func (r *RCONConn) IsReady() bool