project: added readme file. connection, handler, hub, main: refactored code. hub, main: added comments

Author: Lapp

README.md

@@ -0,0 +1,10 @@
+# Чат на вебсокетах
+[![Release](https://img.shields.io/badge/release-v1.0.0-blue)](https://github.com/Lapp-coder/go-pocket-sdk/releases)
+
+### Для запуска сервера используйте следующую команду
+```make docker-build && docker run --name=chat -e CHAT_HOST=<host> -e CHAT_PORT=<port> -p <port>>:<port> --rm websocket-chat```
+
+### Для запуска сервера с конфигурацией по умолчанию
+```make docker-run```
+
+#### P.S: Клиентом можно воспользоваться перейдя на корневую страницу сайта.

connection.go

@@ -16,7 +16,7 @@ func newConnection(ws *websocket.Conn, hub *hub) *connection {
 	}
 }
 
-func (c *connection) read() {
+func (c *connection) readMessages() {
 	for {
 		_, message, err := c.ws.ReadMessage()
 		if err != nil {
@@ -28,7 +28,7 @@ func (c *connection) read() {
 	c.ws.Close()
 }
 
-func (c *connection) write() {
+func (c *connection) writeMessages() {
 	for message := range c.send {
 		if err := c.ws.WriteMessage(websocket.TextMessage, message); err != nil {
 			break

handler.go

@@ -42,6 +42,6 @@ func (h *handler) chat(w http.ResponseWriter, r *http.Request) {
 		conn.hub.unregister <- conn
 	}()
 
-	go conn.write()
-	conn.read()
+	go conn.writeMessages()
+	conn.readMessages()
 }

hub.go

@@ -1,5 +1,6 @@
 package main
 
+// hub является центральным узлом (чатом), который обрабатывает все соединения
 type hub struct {
 	connections map[*connection]struct{}
 	broadcast   chan []byte
@@ -16,7 +17,8 @@ func newHub() *hub {
 	}
 }
 
-func (h *hub) run() {
+// listen прослушивает новые соединения, закрытые соединения и сообщения из канала broadcast
+func (h *hub) listen() {
 	for {
 		select {
 		case conn := <-h.register:

main.go

@@ -14,14 +14,15 @@ func main() {
 	hub := newHub()
 	handler := newHandler(hub)
 	handler.initRoutes()
-	go hub.run()
+	go hub.listen()
 
 	host := os.Getenv("CHAT_HOST")
 	port := os.Getenv("CHAT_PORT")
 	if host == "" || port == "" {
 		logrus.Fatalf("incorrect address to start the server")
 	}
 
+	// Запуск сервера в go-рутине для его плавной остановки
 	srv := newServer(host + ":" + port)
 	go func() {
 		if err := srv.start(); err != nil {
@@ -31,12 +32,14 @@ func main() {
 
 	logrus.Info("server started")
 
+	// Ожидание на получение одного из системных сигналов (SIGINT, SIGTERM) для продолжение выполнения функции main
 	shutdown := make(chan os.Signal)
 	signal.Notify(shutdown, syscall.SIGINT, syscall.SIGTERM)
 	<-shutdown
 
 	logrus.Info("server shutdown")
 
+	// Плавная остановка сервера
 	if err := srv.shutdown(context.Background()); err != nil {
 		logrus.Errorf("failed to graceful shutdown server: %s", err.Error())
 	}