webds

type Config struct {
	// IDGenerator used to create (and later on, set)
	// an ID for each incoming websocket connections (clients).
	// The request is an input parameter which you can use to generate the ID (from headers for example).
	// If empty then the ID is generated by DefaultIDGenerator: randomString(64)
	IDGenerator func(r *http.Request) string
	// record the url address of the superior masters
	SuperiorMaster []string
	// record the url address of the lateral masters
	LateralMaster []string
	// EvtMessagePrefix is the prefix of the underline websocket events that are being established under the hoods.
	// This prefix is visible only to the javascript side (code) and it has nothing to do
	// with the message that the end-user receives.
	// Do not change it unless it is absolutely necessary.
	//
	// If empty then defaults to []byte("ws").
	EvtMessagePrefix []byte
	NewConn          func(server *Server, w http.ResponseWriter, r *http.Request) (Connection, error)
	// Error is the function that will be fired if any client couldn't upgrade the HTTP connection
	// to a websocket connection, a handshake error.
	Error func(w http.ResponseWriter, r *http.Request, status int, reason error)
	// CheckOrigin a function that is called right before the handshake,
	// if returns false then that client is not allowed to connect with the websocket server.
	CheckOrigin func(r *http.Request) bool
	// HandshakeTimeout specifies the duration for the handshake to complete.
	HandshakeTimeout time.Duration
	// WriteTimeout time allowed to write a message to the connection.
	// 0 means no timeout.
	// Default value is 0
	WriteTimeout time.Duration
	// ReadTimeout time allowed to read a message from the connection.
	// 0 means no timeout.
	// Default value is 0
	ReadTimeout time.Duration
	// PongTimeout allowed to read the next pong message from the connection.
	// Default value is 60 * time.Second
	PongTimeout time.Duration
	// PingPeriod send ping messages to the connection within this period. Must be less than PongTimeout.
	// Default value is 60 *time.Second
	PingPeriod time.Duration
	// MaxMessageSize max message size allowed from connection.
	// Default value is 1024
	MaxMessageSize int64
	// BinaryMessages set it to true in order to denotes binary data messages instead of utf-8 text
	// compatible if you wanna use the Connection's EmitMessage to send a custom binary data to the client, like a native server-client communication.
	// Default value is false
	BinaryMessages bool
	// ReadBufferSize is the buffer size for the connection reader.
	// Default value is 4096
	ReadBufferSize int
	// WriteBufferSize is the buffer size for the connection writer.
	// Default value is 4096
	WriteBufferSize int
	// EnableCompression specify if the server should attempt to negotiate per
	// message compression (RFC 7692). Setting this value to true does not
	// guarantee that compression will be supported. Currently only "no context
	// takeover" modes are supported.
	//
	// Defaults to false and it should be remain as it is, unless special requirements.
	EnableCompression bool

	// Subprotocols specifies the server's supported protocols in order of
	// preference. If this field is set, then the Upgrade method negotiates a
	// subprotocol by selecting the first match in this list with a protocol
	// requested by the client.
	Subprotocols []string
}

type Connection interface {
	// ID returns the connection's identifier
	ID() string

	Request() *http.Request

	// Server returns the websocket server instance
	// which this connection is listening to.
	//
	// Its connection-relative operations are safe for use.
	Server() *Server

	// OnDisconnect registers a callback which is fired when this connection is closed by an error or manual
	OnDisconnect(DisconnectFunc)
	// OnError registers a callback which fires when this connection occurs an error
	OnError(ErrorFunc)
	// OnPing  registers a callback which fires on each ping
	// It does nothing more than firing the OnError listeners. It doesn't send anything to the client.
	FireOnError(err error)
	// To defines on which "topic" the server should send a message
	// returns an Publisher to send messages.
	// Broadcast to any node which subscribe this topic.
	// 发布给订阅主题的所有节点
	Publisher(string) Publisher
	// On registers a callback to a particular topic which is fired when a message to this topic is received
	// just for topic with prefix '/inner'
	// 注册某些话题的回调事件
	On(topic string, callback message.Func)

	// only send to the node of this conn
	Echo(topic string, data interface{}) error

	// subscribe registers this connection to a topic, if it doesn't exist then it creates a new.
	// One topic can have one or more connections. One connection can subscribe many topics.
	// All connections subscribe a topic specified by their `ID` automatically.
	// 代替节点订阅主题, 可以配置节点是否有权限订阅主题
	Subscribe(string)

	IsSubscribe(string) bool
	// Leave removes this connection entry from a room
	// Returns true if the connection has actually left from the particular room.
	CancelSubscribe(string)
	// Wait starts the ping and the messages reader,
	// it's named as "Wait" because it should be called LAST,
	// after the "Subscribe" events IF server's `Upgrade` is used,
	// otherwise you don't have to call it because the `Handler()` does it automatically.
	Wait()
	// Disconnect disconnects the client, close the underline websocket conn and removes it from the conn list
	// returns the error, if any, from the underline connection
	Disconnect(error) error
}

type ConnectionFunc func(Connection) error

type DisconnectFunc func()

type ErrorFunc func(error)

type Publisher interface {
	// Pub sends a message on a particular topic
	Pub(interface{}) error
}

type RowConn = connection

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