tcpserver

Documentation

Index

• Variables
• type ConnectionHandler
• type ConnectionIntf
• type ConnectionParams
• type Server
  • func NewServer(config ServerConfig) *Server
  • func (s Server) Run(ctx context.Context, params ...interface{}) error
• type ServerConfig
• type TCPServer
  • func (tcpServer *TCPServer) GetNbAccepted() int64
  • func (tcpServer *TCPServer) GetNbGoroutines() int64
  • func (tcpServer *TCPServer) ListerAndServe(ctx context.Context, address string, handler ConnectionHandler, ...) error
  • func (tcpServer *TCPServer) Wait()

Variables

var (
	ErrCancelled = errors.New("cancelled")
)

Types

type ConnectionHandler

type ConnectionHandler func(ctx context.Context, conn net.Conn, userData interface{})

ConnectionHandler is the signature of the handler function Returning an error in the handler exits the ListerAndServe function with that error

type ConnectionIntf

type ConnectionIntf interface {
	OnConnect(ctx context.Context, connection ConnectionParams) bool
	OnDisconnect(ctx context.Context, connection ConnectionParams)
	HandleConnection(ctx context.Context, connection ConnectionParams) error
}

type ConnectionParams

type ConnectionParams struct {
	Conn         net.Conn
	ServerConfig *ServerConfig
}

type Server

type Server struct {
	task.Runnable
	// contains filtered or unexported fields
}

Server represents a tcp server

func NewServer

func NewServer(config ServerConfig) *Server

func (Server) Run

func (s Server) Run(ctx context.Context, params ...interface{}) error

type ServerConfig

type ServerConfig struct {
	ListenAddress string // "0.0.0.0"
	ListenPort    int    // 8080
	TlsConfig     *tls.Config
	Logger        *logrus.Entry
	UserData      interface{} // any datas, passed to each connection, must be thread safe
	Connection    ConnectionIntf
}

ServerConfig holds the server configuration parameters for a Server

type TCPServer

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

TCPServer holds the data for our TCP Server

func (*TCPServer) GetNbAccepted

func (tcpServer *TCPServer) GetNbAccepted() int64

GetNbAccepted returns the number of connections accepted

func (*TCPServer) GetNbGoroutines

func (tcpServer *TCPServer) GetNbGoroutines() int64

GetNbGoroutines returns the number of goroutines currently handling connections

func (*TCPServer) ListerAndServe

func (tcpServer *TCPServer) ListerAndServe(ctx context.Context, address string, handler ConnectionHandler, tlsConfig *tls.Config, userData interface{}) error

ListerAndServe accepts incoming tcp connexions and calls the handler in a new goroutine

func (*TCPServer) Wait

func (tcpServer *TCPServer) Wait()

Wait waits until all the goroutines are finished