net

Documentation

Overview

Package net pack network connection for Minecraft.

Index

• Constants
• type Conn
  • func DialMC(addr string) (*Conn, error)
  • func DialMCTimeout(addr string, timeout time.Duration) (*Conn, error)
  • func WrapConn(conn net.Conn) *Conn
  • func (c *Conn) Close() error
  • func (c *Conn) ReadPacket() (pk.Packet, error)
  • func (c *Conn) SetCipher(ecoStream, decoStream cipher.Stream)
  • func (c *Conn) SetThreshold(t int)
  • func (c *Conn) WritePacket(p pk.Packet) error
• type Listener
  • func ListenMC(addr string) (*Listener, error)
  • func (l Listener) Accept() (Conn, error)
• type RCONClientConn
  • func DialRCON(addr string, password string) (client RCONClientConn, err error)
• type RCONConn
  • func (r *RCONConn) AcceptCmd() (string, error)
  • func (r *RCONConn) AcceptLogin(password string) error
  • func (r *RCONConn) Cmd(cmd string) error
  • func (r *RCONConn) ReadPacket() (RequestID, Type int32, Payload string, err error)
  • func (r *RCONConn) Resp() (resp string, err error)
  • func (r *RCONConn) RespCmd(resp string) error
  • func (r *RCONConn) WritePacket(RequestID, Type int32, Payload string) error
• type RCONListener
  • func ListenRCON(addr string) (*RCONListener, error)
  • func (r *RCONListener) Accept() (RCONServerConn, error)
• type RCONServerConn
• type ReadWriter
• type Reader
• type Writer

Constants

const MaxRCONPackageSize = 4096

Types

type Conn

type Conn struct {
	Socket net.Conn
	io.ByteReader
	io.Writer
	// contains filtered or unexported fields
}

Conn is a minecraft Connection

func DialMC

func DialMC(addr string) (*Conn, error)

DialMC create a Minecraft connection

func DialMCTimeout

func DialMCTimeout(addr string, timeout time.Duration) (*Conn, error)

DialMCTimeout acts like DialMC but takes a timeout.

func WrapConn

func WrapConn(conn net.Conn) *Conn

WrapConn warp an net.Conn to MC-Conn Helps you modify the connection process (eg. using DialContext).

func (*Conn) Close

func (c *Conn) Close() error

Close close the connection

func (*Conn) ReadPacket

func (c *Conn) ReadPacket() (pk.Packet, error)

ReadPacket read a Packet from Conn.

func (*Conn) SetCipher

func (c *Conn) SetCipher(ecoStream, decoStream cipher.Stream)

SetCipher load the decode/encode stream to this Conn

func (*Conn) SetThreshold

func (c *Conn) SetThreshold(t int)

SetThreshold set threshold to Conn. The data packet with length longer then threshold will be compress when sending.

func (*Conn) WritePacket

func (c *Conn) WritePacket(p pk.Packet) error

WritePacket write a Packet to Conn.

type Listener

type Listener struct{ net.Listener }

A Listener is a minecraft Listener

func ListenMC

func ListenMC(addr string) (*Listener, error)

ListenMC listen as TCP but Accept a mc Conn

func (Listener) Accept

func (l Listener) Accept() (Conn, error)

Accept a minecraft Conn

type RCONClientConn

type RCONClientConn interface {
	Cmd(cmd string) error
	Resp() (resp string, err error)
}

func DialRCON

func DialRCON(addr string, password string) (client RCONClientConn, err error)

type RCONConn

type RCONConn struct {
	net.Conn
	ReqID int32
}

func (*RCONConn) AcceptCmd

func (r *RCONConn) AcceptCmd() (string, error)

func (*RCONConn) AcceptLogin

func (r *RCONConn) AcceptLogin(password string) error

func (*RCONConn) Cmd

func (r *RCONConn) Cmd(cmd string) error

func (*RCONConn) ReadPacket

func (r *RCONConn) ReadPacket() (RequestID, Type int32, Payload string, err error)

func (*RCONConn) Resp

func (r *RCONConn) Resp() (resp string, err error)

func (*RCONConn) RespCmd

func (r *RCONConn) RespCmd(resp string) error

func (*RCONConn) WritePacket

func (r *RCONConn) WritePacket(RequestID, Type int32, Payload string) error

type RCONListener

type RCONListener struct{ net.Listener }

func ListenRCON

func ListenRCON(addr string) (*RCONListener, error)

func (*RCONListener) Accept

func (r *RCONListener) Accept() (RCONServerConn, error)

type RCONServerConn

type RCONServerConn interface {
	AcceptLogin(password string) error
	AcceptCmd() (cmd string, err error)
	RespCmd(resp string) error
}

type ReadWriter

type ReadWriter interface {
	Reader
	Writer
}

type Reader

type Reader interface {
	ReadPacket() (pk.Packet, error)
}

type Writer

type Writer interface {
	WritePacket(p pk.Packet) error
}