xprotocol

Documentation

Index

• Constants
• Variables
• func NewConnPool(ctx context.Context, host types.Host) types.ConnectionPool
• func NewKeepAlive(codec str.Client, proto types.ProtocolName, timeout time.Duration) types.KeepAlive
• func NewPoolBinding(p *connpool) types.ConnectionPool
• func NewPoolMultiplex(p *connpool) types.ConnectionPool
• func NewPoolPingPong(p *connpool) types.ConnectionPool
• func RefreshKeepaliveConfig(c KeepaliveConfig)
• func SetDefaultMaxConnNumPerHostPortForMuxPool(maxConns int)
• func SetIdleTimeout(d time.Duration)
• type KeepaliveConfig

Constants

const (
	Init = iota
	Connecting
	Connected
)

for xprotocol

Variables

var DefaultKeepaliveConfig = KeepaliveConfig{
	TickCountIfFail:  1,
	TickCountIfSucc:  1,
	FailCountToClose: 6,
}

DefaultKeepaliveConfig keeps the same with previous behavior

Functions

func NewConnPool

func NewConnPool(ctx context.Context, host types.Host) types.ConnectionPool

NewConnPool init a connection pool

func NewKeepAlive

func NewKeepAlive(codec str.Client, proto types.ProtocolName, timeout time.Duration) types.KeepAlive

NewKeepAlive creates a keepalive object

func NewPoolBinding

func NewPoolBinding(p *connpool) types.ConnectionPool

NewPoolBinding generates a binding connection pool the upstream connection close will trigger the downstream connection to close and vice versa

func NewPoolMultiplex

func NewPoolMultiplex(p *connpool) types.ConnectionPool

NewPoolMultiplex generates a multiplex conn pool

func NewPoolPingPong

func NewPoolPingPong(p *connpool) types.ConnectionPool

NewPoolPingPong generates a connection pool which uses p pingpong protocol

func RefreshKeepaliveConfig

func RefreshKeepaliveConfig(c KeepaliveConfig)

RefreshKeepaliveConfig refresh the keepalive config

func SetDefaultMaxConnNumPerHostPortForMuxPool

func SetDefaultMaxConnNumPerHostPortForMuxPool(maxConns int)

SetDefaultMaxConnNumPerHostPortForMuxPool set the max connections for each host:port users could use this function or cluster threshold config to configure connection no.

func SetIdleTimeout

func SetIdleTimeout(d time.Duration)

SetIdleTimeout calculates the idle timeout as max idle count.

Types

type KeepaliveConfig

type KeepaliveConfig struct {
	// the next hb will be sent after tick_count_if_fail times of ConnReadTimeout if the current hb fails
	// if normal request comes after a heartbeat request, the next tick will be delayed
	TickCountIfFail uint32
	// the next hb will be sent after tick_count_if_succ times of ConnReadTimeout if the current hb succs
	// if normal request comes after a heartbeat request, the next tick will be delayed
	TickCountIfSucc uint32
	// if hb fails in a line, and count = fail_count_to_close, close this connection
	FailCountToClose uint32
}

KeepaliveConfig is the the config for xprotocol keepalive the config parameter can be set from the outside system