network

type Attr interface {
	// Set sets the value of the attribute with the given key.
	Set(key, value any)
	// Get returns the value of the attribute with the given key and whether it exists.
	Get(key any) (any, bool)
	// Del deletes the attribute with the given key and reports whether the deletion succeeded.
	Del(key any) bool
	// Clear removes all attributes.
	Clear()
	// Visit calls fn for every attribute and stops when fn returns false.
	Visit(fn func(key, value any) bool)
}

type Client interface {
	// Dial dials a connection.
	//
	// When addr is empty the address from the client options is used. The connect handler runs on
	// the connection read goroutine before the first frame is read, so it may run concurrently with
	// or after Dial returns. A transport that reports a connection through the connect handler and
	// then fails to complete Dial must deliver the disconnect handler for that connection so
	// consumers can release it.
	Dial(addr ...string) (Conn, error)
	// Protocol returns the protocol name.
	Protocol() string
	// OnConnect registers the handler invoked when a connection is opened.
	OnConnect(handler ConnectHandler)
	// OnHeartbeat registers the handler invoked when a heartbeat is received.
	OnHeartbeat(handler HeartbeatHandler)
	// OnReceive registers the handler invoked when a message is received.
	OnReceive(handler ReceiveHandler)
	// OnHandshake registers the handler invoked when a handshake frame is received.
	OnHandshake(handler HandshakeHandler)
	// OnDisconnect registers the handler invoked when a connection is closed.
	OnDisconnect(handler DisconnectHandler)
}

type CloseHandler func()

type Conn interface {
	// ID returns the connection ID.
	ID() int64
	// UID returns the user ID.
	UID() int64
	// Attr returns the attribute interface of the connection.
	Attr() Attr
	// Bind binds the connection to the given user ID.
	Bind(uid int64) error
	// Unbind unbinds the user ID from the connection.
	Unbind() error
	// Push sends a message with low priority.
	//
	// The caller controls when buf is released when the send fails.
	Push(buf buffer.Buffer) error
	// State returns the connection state.
	State() ConnState
	// Close closes the connection.
	//
	// When force is true the connection is closed forcibly.
	Close(force ...bool) error
	// CloseIf closes the connection forcibly when it is still the connection with the given ID.
	//
	// Server connection objects are recycled and reused, so a caller that may hold a stale
	// reference must use this method instead of Close to avoid closing a newer connection that
	// reuses the same object. It reports ErrConnectionClosed when the connection no longer
	// carries the given ID.
	CloseIf(id int64) error
	// LocalIP returns the local IP address.
	LocalIP() (string, error)
	// LocalAddr returns the local address.
	LocalAddr() (net.Addr, error)
	// RemoteIP returns the remote IP address.
	RemoteIP() (string, error)
	// RemoteAddr returns the remote address.
	RemoteAddr() (net.Addr, error)
}

type ConnState int32

type ConnectHandler func(conn Conn)

type DisconnectHandler func(conn Conn)

type HandshakeHandler func(conn Conn, buf buffer.Buffer)

type HeartbeatHandler func(conn Conn, heartbeatTime int64)

type ReceiveHandler func(conn Conn, buf buffer.Buffer)

type Server interface {
	// Addr returns the listen address.
	Addr() string
	// Start starts the server.
	Start() error
	// Stop stops the server.
	Stop() error
	// Protocol returns the protocol name.
	Protocol() string
	// OnStart registers the handler invoked when the server starts.
	OnStart(handler StartHandler)
	// OnStop registers the handler invoked when the server stops.
	OnStop(handler CloseHandler)
	// OnConnect registers the handler invoked when a connection is opened.
	OnConnect(handler ConnectHandler)
	// OnHeartbeat registers the handler invoked when a heartbeat is received.
	OnHeartbeat(handler HeartbeatHandler)
	// OnReceive registers the handler invoked when a message is received.
	OnReceive(handler ReceiveHandler)
	// OnHandshake registers the handler invoked when a handshake frame is received.
	OnHandshake(handler HandshakeHandler)
	// OnDisconnect registers the handler invoked when a connection is closed.
	OnDisconnect(handler DisconnectHandler)
}

type StartHandler func()