gn

README

gn

简述

gn是一个基于linux下epoll的网络框架，目前只能运行在Linux环境下，gn可以配置处理网络事件的goroutine数量，相比golang原生库，在海量链接下，可以减少goroutine的开销，从而减少系统资源占用。

支持功能

1.tcp拆包粘包
支持多种编解码方式，使用sync.pool申请读写使用的字节数组，减少内存申请开销以及GC压力。
2.客户端超时踢出
可以设置超时时间，gn会定时检测超出超时的TCP连接（在指定时间内没有发送数据的连接）,进行释放。

使用方式

package main

import (
	"github.com/alberliu/gn"
	"github.com/alberliu/gn/codec"
	"net"
	"strconv"
	"time"
)

var (
	decoder = codec.NewUvarintDecoder()
	encoder = codec.NewUvarintEncoder(1024)
)

var log = gn.GetLogger()

type Handler struct{}

func (*Handler) OnConnect(c *gn.Conn) {
	log.Info("server:connect:", c.GetFd(), c.GetAddr())
}
func (*Handler) OnMessage(c *gn.Conn, bytes []byte) {
	c.WriteWithEncoder(bytes)
	log.Info("server:read:", string(bytes))
}
func (*Handler) OnClose(c *gn.Conn, err error) {
	log.Info("server:close:", c.GetFd(), err)
}

func startServer() {
	server, err := gn.NewServer(":8080", &Handler{},
		gn.WithDecoder(decoder),
		gn.WithEncoder(encoder),
		gn.WithTimeout(5*time.Second),
		gn.WithReadBufferLen(10))
	if err != nil {
		log.Info("err")
		return
	}

	server.Run()
}

Documentation

Index

• Constants
• Variables
• func GetLogger() logger
• func SetLogger(l logger)
• func TimeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder)
• type Conn
  • func (c *Conn) Close()
  • func (c *Conn) CloseRead() error
  • func (c *Conn) GetAddr() string
  • func (c *Conn) GetBuffer() *codec.Buffer
  • func (c *Conn) GetData() interface{}
  • func (c *Conn) GetFd() int32
  • func (c *Conn) SetData(data interface{})
  • func (c *Conn) Write(bytes []byte) (int, error)
  • func (c *Conn) WriteWithEncoder(bytes []byte) error
• type Handler
• type Option
  • func WithAcceptGNum(num int) Option
  • func WithDecoder(decoder codec.Decoder) Option
  • func WithEncoder(encoder codec.Encoder) Option
  • func WithIOEventQueueLen(num int) Option
  • func WithIOGNum(num int) Option
  • func WithReadBufferLen(len int) Option
  • func WithTimeout(timeout time.Duration) Option
• type Server
  • func NewServer(address string, handler Handler, opts ...Option) (*Server, error)
  • func (s *Server) GetConn(fd int32) (*Conn, bool)
  • func (s *Server) GetConnsNum() int64
  • func (s *Server) Run()
  • func (s *Server) Stop()

Constants

const (
	EpollRead  = syscall.EPOLLIN | syscall.EPOLLPRI | syscall.EPOLLERR | syscall.EPOLLHUP | unix.EPOLLET | syscall.EPOLLRDHUP
	EpollClose = uint32(syscall.EPOLLIN | syscall.EPOLLRDHUP)
)

对端关闭连接 8193

const (
	EventIn      = 1 // 数据流入
	EventClose   = 2 // 断开连接
	EventTimeout = 3 // 检测到超时
)

Variables

var (
	ErrReadTimeout = errors.New("tcp read timeout")
)

Functions

func GetLogger

func GetLogger() logger

func SetLogger

func SetLogger(l logger)

func TimeEncoder

func TimeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder)

Types

type Conn

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

Conn 客户端长连接

func (*Conn) Close

func (c *Conn) Close()

Close 关闭连接

func (*Conn) CloseRead

func (c *Conn) CloseRead() error

CloseRead 关闭连接

func (*Conn) GetAddr

func (c *Conn) GetAddr() string

GetAddr 获取客户端地址

func (*Conn) GetBuffer

func (c *Conn) GetBuffer() *codec.Buffer

GetBuffer 获取客户端地址

func (*Conn) GetData

func (c *Conn) GetData() interface{}

GetData 获取数据

func (*Conn) GetFd

func (c *Conn) GetFd() int32

GetFd 获取文件描述符

func (*Conn) SetData

func (c *Conn) SetData(data interface{})

SetData 设置数据

func (*Conn) Write

func (c *Conn) Write(bytes []byte) (int, error)

Write 写入数据 todo 这里可能未能把所有数据写进去

func (*Conn) WriteWithEncoder

func (c *Conn) WriteWithEncoder(bytes []byte) error

WriteWithEncoder 使用编码器写入

type Handler

type Handler interface {
	OnConnect(c *Conn)               // OnConnect 当TCP长连接建立成功是回调
	OnMessage(c *Conn, bytes []byte) // OnMessage 当客户端有数据写入是回调
	OnClose(c *Conn, err error)      // OnClose 当客户端主动断开链接或者超时时回调,err返回关闭的原因
}

Handler Server 注册接口

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithAcceptGNum

func WithAcceptGNum(num int) Option

WithAcceptGNum 设置建立连接的goroutine数量

func WithDecoder

func WithDecoder(decoder codec.Decoder) Option

WithDecoder 设置解码器

func WithEncoder

func WithEncoder(encoder codec.Encoder) Option

WithEncoder 设置解码器

func WithIOEventQueueLen

func WithIOEventQueueLen(num int) Option

WithIOEventQueueLen 设置IO事件队列长度，默认值是1024

func WithIOGNum

func WithIOGNum(num int) Option

WithIOGNum 设置处理IO的goroutine数量

func WithReadBufferLen

func WithReadBufferLen(len int) Option

WithReadBufferLen 设置缓存区大小

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout 设置TCP超时检查的间隔时间以及超时时间

type Server

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

Server TCP服务

func NewServer

func NewServer(address string, handler Handler, opts ...Option) (*Server, error)

NewServer 创建server服务器

func (*Server) GetConn

func (s *Server) GetConn(fd int32) (*Conn, bool)

GetConn 获取Conn

func (*Server) GetConnsNum

func (s *Server) GetConnsNum() int64

GetConnsNum 获取当前长连接的数量

func (*Server) Run

func (s *Server) Run()

Run 启动服务

func (*Server) Stop

func (s *Server) Stop()

Stop 启动服务