ezkcp

README

ezkcp

much easier api for kcp-go

Documentation

Index

• func DefaultSnmp() *kcp.Snmp
• func Dial(serverAddr string) (net.Conn, error)
• func DialWithOptions(serverAddr string, opt Option) (net.Conn, error)
• type Client
  • func (c Client) Close() error
  • func (c Client) LocalAddr() net.Addr
  • func (c Client) Read(buf []byte) (n int, err error)
  • func (c Client) RemoteAddr() net.Addr
  • func (c Client) SetDeadline(t time.Time) error
  • func (c Client) SetReadDeadline(t time.Time) error
  • func (c Client) SetWriteDeadline(t time.Time) error
  • func (c Client) Write(data []byte) (n int, err error)
• type KcpConn
  • func (c *KcpConn) Close() error
  • func (c *KcpConn) LocalAddr() net.Addr
  • func (c *KcpConn) Read(buf []byte) (n int, err error)
  • func (c *KcpConn) RemoteAddr() net.Addr
  • func (c *KcpConn) SetDeadline(t time.Time) error
  • func (c *KcpConn) SetReadDeadline(t time.Time) error
  • func (c *KcpConn) SetWriteDeadline(t time.Time) error
  • func (c *KcpConn) Write(data []byte) (n int, err error)
• type KcpListener
  • func Listen(listenAddr string) (*KcpListener, error)
  • func ListenWithOptions(listenAddr string, opt Option) (*KcpListener, error)
  • func (s *KcpListener) Accept() (net.Conn, error)
  • func (s *KcpListener) Addr() net.Addr
  • func (s *KcpListener) Close() error
• type Option
  • func DefaultOption(clientSide bool) Option
  • func (opt *Option) CorrectByMode()

Functions

func DefaultSnmp

func DefaultSnmp() *kcp.Snmp

func Dial

func Dial(serverAddr string) (net.Conn, error)

Create new client connection and dial

func DialWithOptions

func DialWithOptions(serverAddr string, opt Option) (net.Conn, error)

Create new client connection and dial

Types

type Client

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

kcp client type

func (Client) Close

func (c Client) Close() error

func (Client) LocalAddr

func (c Client) LocalAddr() net.Addr

func (Client) Read

func (c Client) Read(buf []byte) (n int, err error)

func (Client) RemoteAddr

func (c Client) RemoteAddr() net.Addr

func (Client) SetDeadline

func (c Client) SetDeadline(t time.Time) error

func (Client) SetReadDeadline

func (c Client) SetReadDeadline(t time.Time) error

func (Client) SetWriteDeadline

func (c Client) SetWriteDeadline(t time.Time) error

func (Client) Write

func (c Client) Write(data []byte) (n int, err error)

type KcpConn

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

func (*KcpConn) Close

func (c *KcpConn) Close() error

func (*KcpConn) LocalAddr

func (c *KcpConn) LocalAddr() net.Addr

func (*KcpConn) Read

func (c *KcpConn) Read(buf []byte) (n int, err error)

func (*KcpConn) RemoteAddr

func (c *KcpConn) RemoteAddr() net.Addr

func (*KcpConn) SetDeadline

func (c *KcpConn) SetDeadline(t time.Time) error

func (*KcpConn) SetReadDeadline

func (c *KcpConn) SetReadDeadline(t time.Time) error

func (*KcpConn) SetWriteDeadline

func (c *KcpConn) SetWriteDeadline(t time.Time) error

func (*KcpConn) Write

func (c *KcpConn) Write(data []byte) (n int, err error)

type KcpListener

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

kcp server type

func Listen

func Listen(listenAddr string) (*KcpListener, error)

func ListenWithOptions

func ListenWithOptions(listenAddr string, opt Option) (*KcpListener, error)

func (*KcpListener) Accept

func (s *KcpListener) Accept() (net.Conn, error)

func (*KcpListener) Addr

func (s *KcpListener) Addr() net.Addr

func (*KcpListener) Close

func (s *KcpListener) Close() error

type Option

type Option struct {
	Key         string `json:"key"`         /* Must be the same between c-s */
	Crypt       string `json:"crypt"`       /* Must be the same between c-s */
	DataShard   int    `json:"datashard"`   /* Must be the same between c-s */
	ParityShard int    `json:"parityshard"` /* Must be the same between c-s */
	NoComp      bool   `json:"nocomp"`      /* Must be the same between c-s */
	MTU         int    `json:"mtu"`
	SndWnd      int    `json:"sndwnd"`
	RcvWnd      int    `json:"rcvwnd"`
	DSCP        int    `json:"dscp"`
	AckNodelay  bool   `json:"acknodelay"`
	SockBuf     int    `json:"sockbuf"` // Shared with smux session
	// mode params
	Mode         string `json:"mode"`
	NoDelay      int    `json:"nodelay"`
	Interval     int    `json:"interval"`
	Resend       int    `json:"resend"`
	NoCongestion int    `json:"nc"`
}

kcp options

func DefaultOption

func DefaultOption(clientSide bool) Option

Default is game/Live mode

func (*Option) CorrectByMode

func (opt *Option) CorrectByMode()

Fix no-delay by mode