sbus

type BaseRequest struct{}

type BaseRouter struct{}

type ConnManager struct {
	Connections utils.ShardLockMaps
}

type Connection struct {
	Conn net.Conn
	// The ID of the current connection, also known as SessionID, globally unique, used by server Connection
	// uint64 range: 0~18,446,744,073,709,551,615
	// This is the maximum number of connID theoretically supported by the process
	// (当前连接的ID 也可以称作为SessionID，ID全局唯一 ，服务端Connection使用
	// uint64 取值范围：0 ~ 18,446,744,073,709,551,615
	// 这个是理论支持的进程connID的最大数量)
	ConnID uint64
	// connection id for string
	// (字符串的连接id)
	ConnIdStr string
	// 连接版本
	ConnVersion int32
	// The message management module that manages MsgID and the corresponding processing method
	// (消息管理MsgID和对应处理方法的消息管理模块)
	TaskHandler STaskHandler
	// onConnStart is the Hook function when the current connection is created.
	// (当前连接创建时Hook函数)
	OnConnStart func(conn SConnection)
	// onConnStop is the Hook function when the current connection is created.
	// (当前连接断开时的Hook函数)
	OnConnStop func(conn SConnection)

	// frameDecoder is the decoder for splitting or splicing data packets.
	// (断粘包解码器)
	FrameDecoder SFrameDecoder

	Datapack SDataPack

	// property is the connection attribute. (链接属性)
	Property map[string]string

	IOReadBuffSize uint32
	// contains filtered or unexported fields
}

type HandleStep int

type HeartBeatFunc func(connection SConnection) error

type HeartBeatMsgFunc func(connection SConnection) SMsg

type HeartBeatOption struct {
	MakeMsg          HeartBeatMsgFunc // User-defined method for handling heartbeat detection messages(用户自定义的心跳检测消息处理方法)
	OnRemoteNotAlive OnRemoteNotAlive // User-defined method for handling remote connections that are not alive(用户自定义的远程连接不存活时的处理方法)
	HeartBeatMsgID   uint32           // User-defined ID for heartbeat detection messages(用户自定义的心跳检测消息ID)
	Router           SRouter          // User-defined business processing route for heartbeat detection messages(用户自定义的心跳检测消息业务处理路由)
}

type MsgData struct {
	MsgID uint32
	// contains filtered or unexported fields
}

type NSQMsg struct {
	//*Header
	//PkgLen        uint32  // nsq不存在粘包问题 不需要
	Cmd           uint16
	Ret           uint16
	Version       uint8
	SerializeType smsg.SerializeType
	CompressType  smsg.CompressType
	MessageType   smsg.MessageType
	Seq           uint64
	Metadata      map[string]string
	Data          []byte
	// contains filtered or unexported fields
}

type Nsq struct {
	Consumers []*NsqConsumer

	// Buffered channel used for message communication between the read and write goroutines
	// (有缓冲管道，用于读、写两个goroutine之间的消息通信)
	NsqDataBuffChan   chan *NsqData
	MaxNsqDataChanLen uint32

	Apis map[int32]SRouter
	// contains filtered or unexported fields
}

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

type NsqData struct {
	Topic string
	// contains filtered or unexported fields
}

type NsqDataPack struct {
}

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

type OnRemoteNotAlive func(connection SConnection)

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

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

type SConnManager interface {
	Add(SConnection)                                                        // Add connection
	Remove(SConnection)                                                     // Remove connection
	Get(uint64) (SConnection, error)                                        // Get a connection by ConnID
	Get2(string) (SConnection, error)                                       // Get a connection by string ConnID
	Len() int                                                               // Get current number of connections
	ClearConn()                                                             // Remove and stop all connections
	GetAllConnID() []uint64                                                 // Get all connection IDs
	GetAllConnIdStr() []string                                              // Get all string connection IDs
	Range(func(uint64, SConnection, interface{}) error, interface{}) error  // Traverse all connections
	Range2(func(string, SConnection, interface{}) error, interface{}) error // Traverse all connections 2
}

type SConnection interface {
	// Start the connection, make the current connection start working
	// (启动连接，让当前连接开始工作)
	Start()
	// Stop the connection and end the current connection state
	// (停止连接，结束当前连接状态)
	Stop()

	// Returns ctx, used by user-defined go routines to obtain connection exit status
	// (返回ctx，用于用户自定义的go程获取连接退出状态)
	Context() context.Context

	GetConnID() uint64            // Get the current connection ID (获取当前连接ID)
	GetConnIdStr() string         // Get the current connection ID for string (获取当前字符串连接ID)
	GetTaskHandler() STaskHandler // Get the message handler (获取消息处理器)
	RemoteAddr() net.Addr         // Get the remote address information of the connection (获取链接远程地址信息)
	LocalAddr() net.Addr          // Get the local address information of the connection (获取链接本地地址信息)
	LocalAddrString() string      // Get the local address information of the connection as a string
	RemoteAddrString() string     // Get the remote address information of the connection as a string
	GetConnVersion() int32

	SendData(data []byte) error // Send data to the message queue to be sent to the remote TCP client later
	SendMsg(msg SMsg) error

	SetProperty(key string, value string)   // Set connection property
	GetProperty(key string) (string, error) // Get connection property
	RemoveProperty(key string)              // Remove connection property
	IsAlive() bool                          // Check if the current connection is alive(判断当前连接是否存活)
	SetHeartBeat(checker SHeartbeatChecker) // Set the heartbeat detector (设置心跳检测器)

	// 返回当前连接是否存在FrameDecoder
	HasFrameDecoder() bool
}

type SDataPack interface {
	GetHeadLen() uint32
	Pack(msg SMsg) ([]byte, error)
	Unpack(binaryData []byte) (SMsg, error)
}

type SFrameDecoder interface {
	Decode(buff []byte) ([][]byte, error)
}

type SFuncTask interface {
	CallFunc()
}

type SHeartbeatChecker interface {
	SetOnRemoteNotAlive(OnRemoteNotAlive)
	SetHeartbeatMsgFunc(HeartBeatMsgFunc)
	//SetHeartbeatFunc(HeartBeatFunc)
	//BindRouter(uint32, SRouter)
	Start()
	Stop()
	SendHeartBeatMsg() error
	BindConn(connection SConnection)
	//Clone() SHeartbeatChecker
	Cmd() uint16
}

type SMsg interface {
	GetMsgId() int32
	GetCmd() uint16 // Gets the ID of the message(获取消息ID)
	GetRet() uint16
	GetVersion() uint8
	GetSerializeType() smsg.SerializeType
	GetCompressType() smsg.CompressType
	GetMessageType() smsg.MessageType
	GetSeq() uint64
	GetMeta() map[string]string
	GetData() []byte // Gets the content of the message(获取消息内容)
	//
	SetNsqMessage(message *nsq.Message)
	GetNsqMessage() *nsq.Message
	//
	GetHasFrameDecoder() bool
	SetHasFrameDecoder(hasFrameDevoder bool)
}

type SRouter interface {
	PreHandle(task STask)    //Hook method before processing conn business(在处理conn业务之前的钩子方法)
	Handle(task STask) error //Method for processing conn business(处理conn业务的方法)
	PostHandle(task STask)   //Hook method after processing conn business(处理conn业务之后的钩子方法)
}

type STask interface {
	GetConnection() SConnection // Get the connection information of the request(获取请求连接信息)

	GetData() []byte // Get the data of the request message(获取请求消息的数据)
	GetMsgID() int32 // Get the message ID of the request(获取请求的消息ID)
	GetCmd() uint16
	GetMessage() SMsg // Get the raw data of the request message (获取请求消息的原始数据 add by uuxia 2023-03-10)

	BindRouter(router SRouter) // Bind which router handles this request(绑定这次请求由哪个路由处理)
	// Move on to the next handler to start execution, but the function that calls this method will execute in reverse order of their order
	// (转进到下一个处理器开始执行 但是调用此方法的函数会根据先后顺序逆序执行)
	Call() error

	//erminate the execution of the processing function, but the function that calls this method will be executed until completion
	// 终止处理函数的运行 但调用此方法的函数会执行完毕
	Abort()

	//Set 在 Request 中存放一个上下文
	Set(key string, value interface{})
	//Get 从 Request 中获取一个上下文信息
	Get(key string) (value interface{}, exists bool)
}

type STaskHandler interface {
	AddRouter(msgID int32, router SRouter)
	StartWorkerPool()               //  Start the worker pool
	SendTaskToTaskQueue(task STask) // Pass the message to the TaskQueue for processing by the worker(将消息交给TaskQueue,由worker进行处理)
	Stop()
}

type Task struct {
	BaseRequest
	// contains filtered or unexported fields
}

type TaskHandler struct {
	Apis map[int32]SRouter
	// The number of worker goroutines in the business work Worker pool
	// (业务工作Worker池的数量)
	WorkerPoolSize uint32
	// A message queue for workers to take tasks
	// (Worker负责取任务的消息队列)
	TaskQueue chan STask
	// contains filtered or unexported fields
}

type TopicEnum int32

type WsConnection struct {
	Connection
	// contains filtered or unexported fields
}