websocket

type ClientConnection interface {
	// Send buf through the web-socket, wrapping it into a WebSocket frame and
	// as text data. Use 'Send' if you need to specify the type.
	Write(buf []byte) (int, error)
	// Send buf through the web-socket, wrapping it into a WebSocket frame and
	// as the specified type.
	Send(buf []byte, dataType Opcode) error
	// Send data throught the WebSocket as-is. Shouldn't be used unless you know
	// what you are doing!
	SendRaw(buf []byte) error
	// Requests to close the connection with the client.
	Close(code CloseReason, reason []byte) error
	// Release cached memory. Should be used for long-living connections that
	// occasionally sends really big messages.
	Flush()
}

type CloseReason uint16

type Context struct {
	// Local IP where connections are accept (blank for accepting globally).
	Ip string
	// URI for accepting connections (e.g., 'ws://Ip:Port/Uri').
	Uri string
	// Port where the WebSocket will listen to. Cannot be changed after starting
	// the server.
	Port int
	// How many simultaneous connections this server accepts. Anything less or
	// equal to 0 means unlimited.
	MaximumConnections int
	// contains filtered or unexported fields
}

type Opcode uint8

type Server interface {
	// Returns a new instance of this server, passed to the runner.
	Clone(conn ClientConnection) (Server, error)
	// Do something with the received message. Offset points to the actual
	// payload within the WebSocket frame.
	Do(msg []byte, offset int) error
	// Called after the connection to this client was closed.
	Cleanup()
}