connection

type Connection interface {

	// Read ...
	Read(b []byte) (n int, err error)

	// Write
	//
	// @return n 发送成功的大小
	//           注意，如果设置了 Option.WriteChanSize 做异步发送，那么`n`恒等于len(`b`)
	//
	Write(b []byte) (n int, err error)

	// Close 允许调用多次
	//
	Close() error

	LocalAddr() net.Addr
	RemoteAddr() net.Addr
	SetDeadline(t time.Time) error
	SetReadDeadline(t time.Time) error
	SetWriteDeadline(t time.Time) error

	// Writev 发送多块不连续的内存块时使用
	//
	// 当有多块不连续的内存块需要发送时，调用 Writev 在某些平台性能会优于以下做法：
	// 1. 多次调用Write
	// 2. 将多块内存块拷贝拼接成一块内存块后调用Write
	// 原因是减少了系统调用以及内存拷贝（还有可能有内存管理）的开销
	//
	// 注意，如果需要发送的是一块连续的内存块，建议使用 Write 发送
	//
	Writev(b net.Buffers) (n int, err error)

	ReadAtLeast(buf []byte, min int) (n int, err error)
	ReadLine() (line []byte, isPrefix bool, err error) // 只有设置了ReadBufSize才可以使用这个方法

	// Flush
	//
	// 如果使用了bufio写缓冲，则将缓冲中的数据发送出去
	// 如果使用了channel异步发送，则阻塞等待，直到之前channel中的数据全部发送完毕
	//
	// 一般在Close前，想要将剩余数据发送完毕时调用
	//
	Flush() error

	// Done 阻塞直到连接关闭或发生错误
	//
	// 注意，向上层严格保证，消息发送后，后续Read，Write等调用都将失败
	//
	// 注意，向上层严格保证，消息只发送一次
	//
	// @return 返回nil则是本端主动调用Close关闭
	//
	Done() <-chan error

	// ModWriteChanSize Modxxx
	//
	// TODO chef: 这几个接口是否不提供
	// Mod类型函数不加锁，需要调用方保证不发生竞态调用
	//
	// ModWriteChanSize 只允许在初始化时为0的前提下调用
	ModWriteChanSize(n int)
	ModWriteBufSize(n int)
	ModReadTimeoutMs(n int)
	ModWriteTimeoutMs(n int)

	// GetStat 连接上读取和发送的字节总数。
	// 注意，如果是异步发送，发送字节统计的是调用底层write的值，而非上层调用Connection发送的值
	// 也即不包含Connection中的发送缓存部分，但是可能包含内核socket发送缓冲区的值。
	GetStat() Stat
}

type ModOption func(option *Option)

type Option struct {
	// 如果不为0，则之后每次读/写使用bufio的缓冲
	ReadBufSize  int
	WriteBufSize int

	// 如果不为0，则之后每次读/写都带超时
	ReadTimeoutMs  int
	WriteTimeoutMs int

	// 如果不为0，则写使用channel将数据发送到后台协程中发送
	WriteChanSize int

	// 使用channel发送数据时，channel满了时Write函数的行为
	// WriteChanFullBehaviorReturnError 返回错误
	// WriteChanFullBehaviorBlock 阻塞直到向channel写入成功
	WriteChanFullBehavior WriteChanFullBehavior
}

type Stat struct {
	ReadBytesSum  uint64
	WroteBytesSum uint64
}

type StatAtomic struct {
	ReadBytesSum  nazaatomic.Uint64
	WroteBytesSum nazaatomic.Uint64
}

type WriteChanFullBehavior int