gtcp

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

type BuiltinLogger struct{}

type Conn interface {
	net.Conn
	// Flush writes any buffered data to the underlying net.Conn.
	Flush() error

	// SetCancelFunc sets context.CancelFunc that called automatically
	// when Read/Write failed.
	SetCancelFunc(context.CancelFunc)

	// Stats returns in/out bytes gone through this Conn.
	Stats() (int64, int64)

	// SetIdle sets whether this Conn is idle or not.
	// It's used to realize gtcp.Server.Shutdown.
	SetIdle(bool)

	// IsIdle returns whether this Conn is idle or not.
	// It's used to realize gtcp.Server.Shutdown.
	IsIdle() bool

	// Peek returns the next n bytes without advancing the reader.
	Peek(int) ([]byte, error)
}

type ConnHandler func(context.Context, Conn)

type ConnTracker interface {
	// AddConn adds Conn to active connections.
	AddConn(Conn)
	// DelConn deletes Conn from active connections.
	DelConn(Conn)
	// Close closes active connections with the same manner on net/http/Server.Close.
	// In short, force close.
	Close() error
	// Shutdown closes active connections with the same manner on net/http/Server.Shutdown.
	// In short, graceful shutdown.
	Shutdown(context.Context) error
}

type DebugConn struct {
	Conn
}

type ExponentialRetry struct {
	// InitialDelay defines the retry interval at the first retry.
	InitialDelay time.Duration
	// MaxDelay defines the maximum retry interval.
	MaxDelay time.Duration
}

type Limiter interface {
	// OnConnected is called when Conn accepted on a listener.
	// Returns false if limits it otherwise true.
	OnConnected(Conn) bool
	// OnClosed is called when Conn closed.
	OnClosed(Conn)
}

type Logger interface {
	// Errorf logs error information.
	// Arguments are handled in the manner of fmt.Printf.
	Errorf(format string, args ...interface{})
}

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

type MaxConnLimiter struct {
	// Max defines the maximum connections.
	Max uint32
	// contains filtered or unexported fields
}

type NewConn func(Conn) Conn

type PipelineReader func(io.Reader) ([]byte, error)

type PipelineWriter func([]byte, WriteFlusher) error

type ReqHandler func(Conn) error

type Retry interface {
	// Backoff returns a retry interval.
	Backoff(uint64) time.Duration
}

type Server struct {
	// Addr to listen on, ":1979" if empty.
	Addr string

	// ConnHandler handles a tcp connection accepted.
	// It can be used not only directly setting ConnHandler but
	// - Server.SetKeepAliveHandler
	// - Server.SetPipelineHandler
	// Panic occurred if empty.
	ConnHandler ConnHandler

	// NewConn that applied to each tcp connection accepted by listener.
	// It can be
	// - gtcp.NewBufferedConn
	// - gtcp.NewStatsConn
	// - gtcp.NewDebugConn
	// also can be layered like the below.
	//		func(conn Conn) Conn {
	//			return gtcp.NewBufferedConn(gtcp.NewStatsConn(conn))
	//		}
	// None NewConn is applied if empty.
	NewConn NewConn

	// ConnTracker that handles active connections.
	// It can be
	// - gtcp.MapConnTracker
	// - gtcp.WGConnTracker
	// gtcp.MapConnTracker is set if empty.
	ConnTracker ConnTracker

	// Logger that logs if an error occurred in gtcp.
	// It can be
	// - gtcp.BuiltinLogger
	// gtcp.DefaultLogger is set if empty.
	Logger Logger

	// Retry that handles the retry interval when Accept on listner failed.
	// It can be
	// - gtcp.ExponentialRetry
	// gtcp.DefaultRetry is set if empty.(it behaves in the same manner with net/http/Server.
	Retry Retry

	// Limiters that limits connections.
	// It can be
	// - gtcp.MaxConnLimiter
	// also multiple limiters can be set.
	// None Limiter is set if empty.
	Limiters []Limiter

	// Statistics that measures some statistics.
	// It can be
	// - gtcp.TrafficStatistics
	// gtcp.TrafficStatistics is set if empty.
	Statistics Statistics
	// contains filtered or unexported fields
}

type Statistics interface {
	// AddConnStats adds a Conn statistics.
	AddConnStats(Conn)
	// Reset clears statistics holden now.
	Reset()
	// String returns a string that represents the current statistics.
	String() string
}

type StatsConn struct {
	Conn
	// InBytes stores incomming bytes.
	InBytes int64
	// OutBytes stores outgoing bytes.
	OutBytes int64
}

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

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

type WriteFlusher interface {
	io.Writer
	// Flush writes any buffered data to the underlying Conn.
	Flush() error
}