gf: github.com/johng-cn/gf/g/net/gtcp Index | Files

package gtcp

import "github.com/johng-cn/gf/g/net/gtcp"

Package gtcp provides TCP server and client implementations.

Index

Package Files

gtcp.go gtcp_conn.go gtcp_func.go gtcp_pool.go gtcp_server.go

func Checksum Uses

func Checksum(buffer []byte) uint32

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

func NewNetConn Uses

func NewNetConn(addr string, timeout ...int) (net.Conn, error)

创建原生TCP链接, addr地址格式形如:127.0.0.1:80

func Send Uses

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

(面向短链接)发送数据

func SendRecv Uses

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

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

func SendRecvWithTimeout Uses

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

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

func SendWithTimeout Uses

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

(面向短链接)带超时时间的数据发送

type Conn Uses

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

封装的链接对象

func NewConn Uses

func NewConn(addr string, timeout ...int) (*Conn, error)

创建TCP链接

func NewConnByNetConn Uses

func NewConnByNetConn(conn net.Conn) *Conn

将net.Conn接口对象转换为*gtcp.Conn对象

func (*Conn) Close Uses

func (c *Conn) Close()

关闭连接

func (*Conn) LocalAddr Uses

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

func (*Conn) Recv Uses

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

获取数据,指定读取的数据长度(length < 1表示获取所有可读数据),以及重试策略(retry) 需要注意: 1、往往在socket通信中需要指定固定的数据结构,并在设定对应的长度字段,并在读取数据时便于区分包大小; 2、当length < 1时表示获取缓冲区所有的数据,但是可能会引起包解析问题(可能出现非完整的包情况),因此需要解析端注意解析策略;

func (*Conn) RecvLine Uses

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

按行读取数据,阻塞读取,直到完成一行读取位置(末尾以'\n'结尾,返回数据不包含换行符)

func (*Conn) RecvWithTimeout Uses

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

带超时时间的数据获取

func (*Conn) RemoteAddr Uses

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

func (*Conn) Send Uses

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

发送数据

func (*Conn) SendRecv Uses

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

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

func (*Conn) SendRecvWithTimeout Uses

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

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

func (*Conn) SendWithTimeout Uses

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

带超时时间的数据发送

func (*Conn) SetDeadline Uses

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

func (*Conn) SetRecvBufferWait Uses

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

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

func (*Conn) SetRecvDeadline Uses

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

func (*Conn) SetSendDeadline Uses

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

type PoolConn Uses

type PoolConn struct {
    *Conn // 继承底层链接接口对象
    // contains filtered or unexported fields
}

链接池链接对象

func NewPoolConn Uses

func NewPoolConn(addr string, timeout ...int) (*PoolConn, error)

创建TCP链接池对象

func (*PoolConn) Close Uses

func (c *PoolConn) Close() error

(方法覆盖)覆盖底层接口对象的Close方法

func (*PoolConn) Recv Uses

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

(方法覆盖)接收数据

func (*PoolConn) RecvLine Uses

func (c *PoolConn) RecvLine(retry ...Retry) ([]byte, error)

(方法覆盖)按行读取数据,阻塞读取,直到完成一行读取位置(末尾以'\n'结尾,返回数据不包含换行符)

func (*PoolConn) RecvWithTimeout Uses

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

(方法覆盖)带超时时间的数据获取

func (*PoolConn) Send Uses

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

(方法覆盖)发送数据

func (*PoolConn) SendRecv Uses

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

(方法覆盖)发送数据并等待接收返回数据

func (*PoolConn) SendRecvWithTimeout Uses

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

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

func (*PoolConn) SendWithTimeout Uses

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

(方法覆盖)带超时时间的数据发送

type Retry Uses

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

type Server Uses

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

tcp server结构体

func GetServer Uses

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

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

func NewServer Uses

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

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

func (*Server) Run Uses

func (s *Server) Run() error

执行监听

func (*Server) SetAddress Uses

func (s *Server) SetAddress(address string)

设置参数 - address

func (*Server) SetHandler Uses

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

设置参数 - handler

Package gtcp imports 10 packages (graph). Updated 2019-01-16. Refresh now. Tools for package owners.