tcpserver

README

tcpserver

Installation

$: go get github.com/x-mod/tcpserver

Quick Start

import (
    "net"
    "log"
	"context"
	"github.com/x-mod/tcpserver"
)

func EchoHandler(ctx context.Context, con net.Conn) error {
    //TODO LOGIC
    return nil
}

func main() {
	srv := tcpserver.New(
		tcpserver.Address(":8080"),
		//tcpserver.TLSConfig(tlsconfig),
		tcpserver.TCPHandler(EchoHandler),
	)
	if err := srv.Serve(context.TODO()); err != nil {
		log.Println("tcpserver failed:", err)
	}
}

More Details, Pls check the example.

Documentation

Index

• type Handler
• type Server
  • func New(opts ...ServerOpt) *Server
  • func (srv *Server) Close()
  • func (srv *Server) Serve(ctx context.Context) error
• type ServerOpt
  • func Address(addr string) ServerOpt
  • func Listener(ln net.Listener) ServerOpt
  • func Name(name string) ServerOpt
  • func NetTrace(flag bool) ServerOpt
  • func Network(inet string) ServerOpt
  • func TCPHandler(h Handler) ServerOpt
  • func TLSConfig(tls *tls.Config) ServerOpt

Types

type Handler

type Handler func(ctx context.Context, conn net.Conn) error

Handler connection handler definition

type Server

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

Server represent tcpserver

func New

func New(opts ...ServerOpt) *Server

NewServer create a new tcpserver

func (*Server) Close

func (srv *Server) Close()

Close tcpserver waiting all connections finished

func (*Server) Serve

func (srv *Server) Serve(ctx context.Context) error

Serve tcpserver serving

type ServerOpt

type ServerOpt func(*Server)

ServerOpt typedef

func Address

func Address(addr string) ServerOpt

Address option for listener

func Listener

func Listener(ln net.Listener) ServerOpt

Listener option for listener

func Name

func Name(name string) ServerOpt

Name option for tcpserver

func NetTrace

func NetTrace(flag bool) ServerOpt

func Network

func Network(inet string) ServerOpt

Network option for listener

func TCPHandler

func TCPHandler(h Handler) ServerOpt

TCPHandler option for Connection Handler

func TLSConfig

func TLSConfig(tls *tls.Config) ServerOpt

TLSConfig option