gorcon

README

gorcon

A Minecraft RCON client

Documentation

Index

• Constants
• func Unpack(pac *Packet) ([]byte, error)
• type Header
• type Packet
  • func NewPacket(i int32, t PacketType, p []byte) *Packet
  • func Pack(raw []byte) (*Packet, error)
• type PacketType
• type Rconn
  • func Dial(addr string) (Rconn, error)
  • func DialTimeout(addr string, timeout time.Duration) (Rconn, error)
  • func (c *Rconn) Auth(password string) error
  • func (c *Rconn) AuthTimeout(password string, timeout time.Duration) error
  • func (c *Rconn) ExecCommand(command string) (string, error)
  • func (c *Rconn) ExecCommandTimeout(command string, timeout time.Duration) (string, error)
  • func (c *Rconn) ReadPacket(pac *Packet) error
  • func (c *Rconn) ReadPacketTimeout(pac *Packet, timeout time.Duration) error
  • func (c *Rconn) WritePacket(pac *Packet) error
  • func (c *Rconn) WritePacketTimeout(pac *Packet, timeout time.Duration) error

Constants

const (
	BadAuthRequestId         = -1
	RequestPayloadMaxLength  = 1446
	ResponsePayloadMaxLength = 4096
)

const (
	Auth          = PacketType(3)
	ExecCommand   = PacketType(2)
	ResponseValue = PacketType(0)
	DummyRequest  = PacketType(100)
)

Functions

func Unpack

func Unpack(pac *Packet) ([]byte, error)

Types

type Header

type Header struct {
	Length    int32
	RequestId int32
	Type      PacketType
}

type Packet

type Packet struct {
	Header
	Payload []byte
}

func NewPacket

func NewPacket(i int32, t PacketType, p []byte) *Packet

func Pack

func Pack(raw []byte) (*Packet, error)

type PacketType

type PacketType int32

type Rconn

type Rconn struct {
	net.Conn
}

func Dial

func Dial(addr string) (Rconn, error)

func DialTimeout

func DialTimeout(addr string, timeout time.Duration) (Rconn, error)

func (*Rconn) Auth

func (c *Rconn) Auth(password string) error

func (*Rconn) AuthTimeout

func (c *Rconn) AuthTimeout(password string, timeout time.Duration) error

func (*Rconn) ExecCommand

func (c *Rconn) ExecCommand(command string) (string, error)

func (*Rconn) ExecCommandTimeout

func (c *Rconn) ExecCommandTimeout(command string, timeout time.Duration) (string, error)

func (*Rconn) ReadPacket

func (c *Rconn) ReadPacket(pac *Packet) error

func (*Rconn) ReadPacketTimeout

func (c *Rconn) ReadPacketTimeout(pac *Packet, timeout time.Duration) error

func (*Rconn) WritePacket

func (c *Rconn) WritePacket(pac *Packet) error

func (*Rconn) WritePacketTimeout

func (c *Rconn) WritePacketTimeout(pac *Packet, timeout time.Duration) error