gudp

Documentation

Overview

Package gtcp provides UDP server and client implementations.

Index

• Constants
• func Checksum(buffer []byte) uint32
• func NewNetConn(raddr string, laddr ...string) (*net.UDPConn, error)
• func Send(addr string, data []byte, retry ...Retry) error
• func SendPkg(addr string, data []byte, retry ...Retry) error
• func SendPkgWithTimeout(addr string, data []byte, timeout time.Duration, retry ...Retry) error
• func SendRecv(addr string, data []byte, receive int, retry ...Retry) ([]byte, error)
• func SendRecvPkg(addr string, data []byte, retry ...Retry) ([]byte, error)
• func SendRecvPkgWithTimeout(addr string, data []byte, timeout time.Duration, retry ...Retry) ([]byte, error)
• type Conn
  • func NewConn(raddr string, laddr ...string) (*Conn, error)
  • func NewConnByNetConn(udp *net.UDPConn) *Conn
  • func (c *Conn) Close() error
  • func (c *Conn) LocalAddr() net.Addr
  • func (c *Conn) Recv(length int, retry ...Retry) ([]byte, error)
  • func (c *Conn) RecvPkg(retry ...Retry) (result []byte, err error)
  • func (c *Conn) RecvPkgWithTimeout(timeout time.Duration, retry ...Retry) ([]byte, error)
  • func (c *Conn) RecvWithTimeout(length int, timeout time.Duration, retry ...Retry) ([]byte, error)
  • func (c *Conn) RemoteAddr() net.Addr
  • func (c *Conn) Send(data []byte, retry ...Retry) error
  • func (c *Conn) SendPkg(data []byte, retry ...Retry) error
  • func (c *Conn) SendPkgWithTimeout(data []byte, timeout time.Duration, retry ...Retry) error
  • func (c *Conn) SendRecv(data []byte, receive int, retry ...Retry) ([]byte, error)
  • func (c *Conn) SendRecvPkg(data []byte, retry ...Retry) ([]byte, error)
  • func (c *Conn) SendRecvPkgWithTimeout(data []byte, timeout time.Duration, retry ...Retry) ([]byte, error)
  • func (c *Conn) SendRecvWithTimeout(data []byte, receive int, timeout time.Duration, retry ...Retry) ([]byte, error)
  • func (c *Conn) SendWithTimeout(data []byte, timeout time.Duration, retry ...Retry) error
  • func (c *Conn) SetDeadline(t time.Time) error
  • func (c *Conn) SetRecvBufferWait(d time.Duration)
  • func (c *Conn) SetRecvDeadline(t time.Time) error
  • func (c *Conn) SetSendDeadline(t time.Time) error
• type Retry
• type Server
  • func GetServer(name ...interface{}) *Server
  • func NewServer(address string, handler func(*Conn), names ...string) *Server
  • func (s *Server) Run() error
  • func (s *Server) SetAddress(address string)
  • func (s *Server) SetHandler(handler func(*Conn))

Constants

const (
	// 允许最大的简单协议包大小(byte), 15MB
	PKG_MAX_SIZE = 0xFFFFFF
	// 消息包头大小: "总长度"3字节+"校验码"4字节
	PKG_HEADER_SIZE = 7
)

Functions

func Checksum

func Checksum(buffer []byte) uint32

常见的二进制数据校验方式，生成校验结果

func NewNetConn

func NewNetConn(raddr string, laddr ...string) (*net.UDPConn, error)

创建标准库UDP链接操作对象

func Send

func Send(addr string, data []byte, retry ...Retry) error

(面向短链接)发送数据

func SendPkg

func SendPkg(addr string, data []byte, retry ...Retry) error

简单协议: (面向短链接)发送消息包

func SendPkgWithTimeout

func SendPkgWithTimeout(addr string, data []byte, timeout time.Duration, retry ...Retry) error

简单协议: (面向短链接)带超时时间的数据发送

func SendRecv

func SendRecv(addr string, data []byte, receive int, retry ...Retry) ([]byte, error)

(面向短链接)发送数据并等待接收返回数据

func SendRecvPkg

func SendRecvPkg(addr string, data []byte, retry ...Retry) ([]byte, error)

简单协议: (面向短链接)发送数据并等待接收返回数据

func SendRecvPkgWithTimeout

func SendRecvPkgWithTimeout(addr string, data []byte, timeout time.Duration, retry ...Retry) ([]byte, error)

简单协议: (面向短链接)发送数据并等待接收返回数据(带返回超时等待时间)

Types

type Conn

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

封装的链接对象

func NewConn

func NewConn(raddr string, laddr ...string) (*Conn, error)

创建TCP链接

func NewConnByNetConn

func NewConnByNetConn(udp *net.UDPConn) *Conn

将*net.UDPConn对象转换为*Conn对象

func (*Conn) Close

func (c *Conn) Close() error

func (*Conn) LocalAddr

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

func (*Conn) Recv

func (c *Conn) Recv(length int, retry ...Retry) ([]byte, error)

接收数据

func (*Conn) RecvPkg

func (c *Conn) RecvPkg(retry ...Retry) (result []byte, err error)

简单协议: 获取一个数据包。

func (*Conn) RecvPkgWithTimeout

func (c *Conn) RecvPkgWithTimeout(timeout time.Duration, retry ...Retry) ([]byte, error)

简单协议: 带超时时间的消息包获取

func (*Conn) RecvWithTimeout

func (c *Conn) RecvWithTimeout(length int, timeout time.Duration, retry ...Retry) ([]byte, error)

带超时时间的数据获取

func (*Conn) RemoteAddr

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

不能使用c.conn.RemoteAddr()，其返回为nil， 这里使用c.raddr获取远程连接地址。

func (*Conn) Send

func (c *Conn) Send(data []byte, retry ...Retry) error

发送数据

func (*Conn) SendPkg

func (c *Conn) SendPkg(data []byte, retry ...Retry) error

根据简单协议发送数据包。 简单协议数据格式：总长度(24bit)|校验码(32bit)|数据(变长)。 注意： 1. "总长度"包含自身3字节及"校验码"4字节。 2. 由于"总长度"为3字节，并且使用的BigEndian字节序，因此最后返回的buffer使用了buffer[1:]。

func (*Conn) SendPkgWithTimeout

func (c *Conn) SendPkgWithTimeout(data []byte, timeout time.Duration, retry ...Retry) error

简单协议: 带超时时间的数据发送

func (*Conn) SendRecv

func (c *Conn) SendRecv(data []byte, receive int, retry ...Retry) ([]byte, error)

发送数据并等待接收返回数据

func (*Conn) SendRecvPkg

func (c *Conn) SendRecvPkg(data []byte, retry ...Retry) ([]byte, error)

简单协议: 发送数据并等待接收返回数据

func (*Conn) SendRecvPkgWithTimeout

func (c *Conn) SendRecvPkgWithTimeout(data []byte, timeout time.Duration, retry ...Retry) ([]byte, error)

简单协议: 发送数据并等待接收返回数据(带返回超时等待时间)

func (*Conn) SendRecvWithTimeout

func (c *Conn) SendRecvWithTimeout(data []byte, receive int, timeout time.Duration, retry ...Retry) ([]byte, error)

发送数据并等待接收返回数据(带返回超时等待时间)

func (*Conn) SendWithTimeout

func (c *Conn) SendWithTimeout(data []byte, timeout time.Duration, retry ...Retry) error

带超时时间的数据发送

func (*Conn) SetDeadline

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

func (*Conn) SetRecvBufferWait

func (c *Conn) SetRecvBufferWait(d time.Duration)

读取全部缓冲区数据时，读取完毕后的写入等待间隔，如果超过该等待时间后仍无可读数据，那么读取操作返回。 该时间间隔不能设置得太大，会影响Recv读取时长(默认为1毫秒)。

func (*Conn) SetRecvDeadline

func (c *Conn) SetRecvDeadline(t time.Time) error

func (*Conn) SetSendDeadline

func (c *Conn) SetSendDeadline(t time.Time) error

type Retry

type Retry struct {
	Count    int // 重试次数
	Interval int // 重试间隔(毫秒)
}

type Server

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

tcp server结构体

func GetServer

func GetServer(name ...interface{}) *Server

获取/创建一个空配置的UDP Server 单例模式，请保证name的唯一性

func NewServer

func NewServer(address string, handler func(*Conn), names ...string) *Server

创建一个tcp server对象，并且可以选择指定一个单例名字

func (*Server) Run

func (s *Server) Run() error

执行监听

func (*Server) SetAddress

func (s *Server) SetAddress(address string)

设置参数 - address

func (*Server) SetHandler

func (s *Server) SetHandler(handler func(*Conn))

设置参数 - handler