fastsocket

README

fastsocket

faster socket based on epoll/kqueue & goroutine pool

Application

1. Example: TCP Echo Server
2. Example: HTTP Server

Reference

• https://medium.freecodecamp.org/million-websockets-and-go-cc58418460bb
• http://www.barretlee.com/blog/2017/06/06/dive-to-nodejs-at-stream-module/

Documentation

Index

• Constants
• Variables
• func CoarseTimeNow() time.Time
• func SetWorkerPool(p *Pool)
• type Addr
  • func (a Addr) Network() string
  • func (a Addr) String() string
• type NonBlockingConn
  • func (c *NonBlockingConn) Close() error
  • func (c *NonBlockingConn) File() (*os.File, error)
  • func (c *NonBlockingConn) LocalAddr() net.Addr
  • func (c *NonBlockingConn) Read(b []byte) (n int, err error)
  • func (c *NonBlockingConn) RemoteAddr() net.Addr
  • func (c *NonBlockingConn) SetDeadline(t time.Time) error
  • func (c *NonBlockingConn) SetReadDeadline(t time.Time) error
  • func (c *NonBlockingConn) SetWriteDeadline(t time.Time) error
  • func (c *NonBlockingConn) Write(b []byte) (n int, err error)
• type Pool
  • func NewPool(size, queue, spawn int) *Pool
  • func (p *Pool) Schedule(task func())
  • func (p *Pool) ScheduleTimeout(timeout time.Duration, task func()) error
• type Server
  • func NewServer(addrs string) (*Server, error)
  • func (s *Server) Accept(acceptFn func(net.Conn)) error
  • func (s *Server) Close() error
  • func (s *Server) Listen(addrs string) (err error)
• type Socket
  • func NewBufferedSocket(conn net.Conn, readBuffSize, writeBuffSize int, timeout time.Duration) *Socket
  • func NewSocket(conn net.Conn) *Socket
  • func (s *Socket) Close() error
  • func (s *Socket) Flush()
  • func (s *Socket) IsActive() bool
  • func (s *Socket) Listen() error
  • func (s *Socket) OnClose(onClose func()) *Socket
  • func (s *Socket) OnReadable(onReadable func()) *Socket
  • func (s *Socket) Read(b []byte) (n int, err error)
  • func (s *Socket) Write(b []byte) (n int, err error)

Constants

const DefaultBuffSize = 16 * 1024

const DefaultPoolSize = 256 * 1024

Variables

var ErrScheduleTimeout = fmt.Errorf("schedule error: timed out")

ErrScheduleTimeout returned by Pool to indicate that there no free goroutines during some period of time.

Functions

func CoarseTimeNow

func CoarseTimeNow() time.Time

CoarseTimeNow returns the current time truncated to the nearest second.

This is a faster alternative to time.Now().

func SetWorkerPool

func SetWorkerPool(p *Pool)

Types

type Addr

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

func (Addr) Network

func (a Addr) Network() string

func (Addr) String

func (a Addr) String() string

type NonBlockingConn

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

func (*NonBlockingConn) Close

func (c *NonBlockingConn) Close() error

func (*NonBlockingConn) File

func (c *NonBlockingConn) File() (*os.File, error)

func (*NonBlockingConn) LocalAddr

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

func (*NonBlockingConn) Read

func (c *NonBlockingConn) Read(b []byte) (n int, err error)

func (*NonBlockingConn) RemoteAddr

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

func (*NonBlockingConn) SetDeadline

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

func (*NonBlockingConn) SetReadDeadline

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

func (*NonBlockingConn) SetWriteDeadline

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

func (*NonBlockingConn) Write

func (c *NonBlockingConn) Write(b []byte) (n int, err error)

type Pool

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

Pool contains logic of goroutine reuse.

func NewPool

func NewPool(size, queue, spawn int) *Pool

NewPool creates new goroutine pool with given size. It also creates a work queue of given size. Finally, it spawns given amount of goroutines immediately.

func (*Pool) Schedule

func (p *Pool) Schedule(task func())

Schedule schedules task to be executed over pool's workers.

func (*Pool) ScheduleTimeout

func (p *Pool) ScheduleTimeout(timeout time.Duration, task func()) error

ScheduleTimeout schedules task to be executed over pool's workers. It returns ErrScheduleTimeout when no free workers met during given timeout.

type Server

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

func NewServer

func NewServer(addrs string) (*Server, error)

func (*Server) Accept

func (s *Server) Accept(acceptFn func(net.Conn)) error

func (*Server) Close

func (s *Server) Close() error

func (*Server) Listen

func (s *Server) Listen(addrs string) (err error)

type Socket

type Socket struct {
	net.Conn
	Reader *bufio.Reader
	Writer *bufio.Writer
	// contains filtered or unexported fields
}

func NewBufferedSocket

func NewBufferedSocket(conn net.Conn, readBuffSize, writeBuffSize int, timeout time.Duration) *Socket

func NewSocket

func NewSocket(conn net.Conn) *Socket

func (*Socket) Close

func (s *Socket) Close() error

func (*Socket) Flush

func (s *Socket) Flush()

func (*Socket) IsActive

func (s *Socket) IsActive() bool

func (*Socket) Listen

func (s *Socket) Listen() error

func (*Socket) OnClose

func (s *Socket) OnClose(onClose func()) *Socket

func (*Socket) OnReadable

func (s *Socket) OnReadable(onReadable func()) *Socket

func (*Socket) Read

func (s *Socket) Read(b []byte) (n int, err error)

func (*Socket) Write

func (s *Socket) Write(b []byte) (n int, err error)