Merge pull request #394 from amirhasanpour/network-programming

Update network programming season

Author: ja7ad

content/chapter 5/5.10-quic-server.md

@@ -61,19 +61,19 @@ func main() {
 
 // this function start our echo server
 func echoServer() error {
-  // make a new listner with quic
+	// make a new listner with quic
 	listener, err := quic.ListenAddr(addr, generateTLSConfig(), nil)
 	if err != nil {
 		return err
 	}
 
-  // accept incoming connections
+	// accept incoming connections
 	conn, err := listener.Accept(context.Background())
 	if err != nil {
 		return err
 	}
 
-  // accept incoming streams
+	// accept incoming streams
 	stream, err := conn.AcceptStream(context.Background())
 	if err != nil {
 		panic(err)
@@ -84,33 +84,34 @@ func echoServer() error {
 	return err
 }
 
-// client function thah send the message to our server
+// client function that send the message to our server
 func clientMain() error {
-  // set up a tls config
+	// set up a tls config
 	tlsConf := &tls.Config{
 		InsecureSkipVerify: true,
 		NextProtos:         []string{"quic-echo-example"},
 	}
-  // dial with our udp server
+
+	// dial with our udp server
 	conn, err := quic.DialAddr(context.Background(), addr, tlsConf, nil)
 	if err != nil {
 		return err
 	}
 
-  // opening a new stream from our connection
+	// opening a new stream from our connection
 	stream, err := conn.OpenStreamSync(context.Background())
 	if err != nil {
 		return err
 	}
 
-  // write the message over the stream
+	// write the message over the stream
 	fmt.Printf("Client: Sending '%s'\n", message)
 	_, err = stream.Write([]byte(message))
 	if err != nil {
 		return err
 	}
 
-  // read and print incoming answer from server
+	// read and print incoming answer from server
 	buf := make([]byte, len(message))
 	_, err = io.ReadFull(stream, buf)
 	if err != nil {
@@ -135,18 +136,21 @@ func generateTLSConfig() *tls.Config {
 	if err != nil {
 		panic(err)
 	}
+
 	template := x509.Certificate{SerialNumber: big.NewInt(1)}
 	certDER, err := x509.CreateCertificate(rand.Reader, &template, &template, &key.PublicKey, key)
 	if err != nil {
 		panic(err)
 	}
+
 	keyPEM := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(key)})
 	certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: certDER})
 
 	tlsCert, err := tls.X509KeyPair(certPEM, keyPEM)
 	if err != nil {
 		panic(err)
 	}
+
 	return &tls.Config{
 		Certificates: []tls.Certificate{tlsCert},
 		NextProtos:   []string{"quic-echo-example"},

content/chapter 5/5.2-tcp-server-begginer.md

@@ -24,7 +24,7 @@ import (
 // ساختار هر پیام در سرور
 type Message struct {
 	// ادرس ip ارسال کننده پیام
-	from    string
+	from string
 	// متن و محتوای پیام
 	payload []byte
 }
@@ -34,9 +34,9 @@ type Server struct {
 	// ادرس و یا پورت سرور
 	listenAddr string
 	// listener
-	ln         net.Listener
+	ln net.Listener
 	// چنل پیام برای انتقال پیام های دریافتی از اتصال ها بین گوروتین ها
-	msgch      chan Message
+	msgch chan Message
 }
 
 // ایجاد یک سرور جدید
@@ -97,7 +97,7 @@ func (s *Server) readLoop(conn net.Conn) {
 
 		s.msgch <- Message{
 			// ادرس ip ارسال کننده پیام از نوع net.IP
-			from:    conn.RemoteAddr().String(),
+			from: conn.RemoteAddr().String(),
 			// متن پیام
 			payload: buf[:n],
 		}
@@ -113,7 +113,7 @@ func main() {
 
 	//start the server
 	if err := server.start(); err != nil {
-		log.Fetal(err)
+		log.Fatal(err)
 	}
 
 	go func() {

content/chapter 5/5.3-tcp-server-advanced.md

@@ -31,9 +31,7 @@ import (
 	"time"
 )
 
-
-type FileServer struct { }
-
+type FileServer struct{}
 
 func (fs *FileServer) start() {
 	ln, err := net.Listen("tcp", "0.0.0.0:3000")
@@ -57,12 +55,10 @@ func (fs *FileServer) start() {
 }
 
 func (fs *FileServer) readLoop(conn net.Conn) {
-
 	// make a new buffer
 	buf := new(bytes.Buffer)
 
 	for {
-
 		var size int64
 
 		// get the size from connection
@@ -81,12 +77,10 @@ func (fs *FileServer) readLoop(conn net.Conn) {
 }
 
 func main() {
-
-	go func ()  {
-
+	go func() {
 		time.Sleep(4 * time.Second)
 
-    // set your file szie
+		// set your file szie
 		sendFile(2000000)
 	}()
 
@@ -96,7 +90,6 @@ func main() {
 
 // client example that send a large file to server!
 func sendFile(size int) error {
-
 	file := make([]byte, size)
 
 	// make a random file from the size provided

content/chapter 5/5.4-udp-server-begginer.md

@@ -11,7 +11,7 @@ weight: 9004
 پروتکل(User Datagram Protocol)
 یک پروتکل {{< tooltip text="فاقد اتصال" note="connectionless" >}} است.
 به این معنا که {{< tooltip text="بسته" note="packet" >}} های این پروتکل بدون اتصال قبلی و بررسی اینکه ایا همه بسته ها به درستی ارسال شده اند به دستگاه مورد نظر ارسال میشود.
-به همین دلیل سرعت در این پروتکل از پروتکل tcp پایین تر است اما تظمین ارسال کامل و سالم داده وجود ندارد.
+به همین دلیل سرعت در این پروتکل از پروتکل tcp بیشتر است اما تظمین ارسال کامل و سالم داده وجود ندارد.
 از موارد استفاده این پروتکل میتوان سرور بازی های انلاین را مثال زد.
 
 ## 5.4.2 پیاده سازی
@@ -26,9 +26,8 @@ import (
 	"strings"
 )
 
-
 func main() {
-  // ادرس IP و پورت مورد نظر را برای گوش سپردن به پکت های UDP مشخص میکنیم (مقدار بازگشتی این تابع اتصال ما است که قابلیت نوشتن و خواندن آن را داریم)
+	// ادرس IP و پورت مورد نظر را برای گوش سپردن به پکت های UDP مشخص میکنیم (مقدار بازگشتی این تابع اتصال ما است که قابلیت نوشتن و خواندن آن را داریم)
 	conn, err := net.ListenUDP("udp", &net.UDPAddr{
 		Port: 3000,
 		IP:   net.ParseIP("0.0.0.0"),
@@ -42,16 +41,16 @@ func main() {
 
 	for {
 		message := make([]byte, 20)
-    // تمام پیام های نوشته شده (ارسال شده) را میخوانیم
-    // متغییر message را با مقدار ارسال شده پر میکنیم (مقدار های بازگشتی این تابع طول پیام و آدرس ریموت ارسال کننده است)
+		// تمام پیام های نوشته شده (ارسال شده) را میخوانیم
+		// متغییر message را با مقدار ارسال شده پر میکنیم (مقدار های بازگشتی این تابع طول پیام و آدرس ریموت ارسال کننده است)
 		readLen, remote, err := conn.ReadFromUDP(message[:])
 		if err != nil {
 			panic(err)
 		}
 
-    // متن پیام را تا قسمت خوانده شده به string تبدیل میکنیم
+		// متن پیام را تا قسمت خوانده شده به string تبدیل میکنیم
 		data := strings.TrimSpace(string(message[:readLen]))
-    // داده خروجی را چاپ میکنیم
+		// داده خروجی را چاپ میکنیم
 		fmt.Printf("received: %s from %s\n", data, remote)
 	}
 }
@@ -68,12 +67,12 @@ package main
 import "net"
 
 func main() {
-  // یک اتصال به سرور ایجاد میکنیم
-  Conn, _ := net.DialUDP("udp", nil, &net.UDPAddr{IP:[]byte{127,0,0,1},Port:3000,Zone:""})
+	// یک اتصال به سرور ایجاد میکنیم
+	Conn, _ := net.DialUDP("udp", nil, &net.UDPAddr{IP: []byte{127, 0, 0, 1}, Port: 3000, Zone: ""})
 
-  defer Conn.Close()
-  // متن زیر را به سرور ارسال میکنیم
-  Conn.Write([]byte("hello, gofarsi!"))
+	defer Conn.Close()
+	// متن زیر را به سرور ارسال میکنیم
+	Conn.Write([]byte("hello, gofarsi!"))
 }
 {{< /play >}}
 

content/chapter 5/5.7-http-server-advanced.md

@@ -105,6 +105,50 @@ func main() {
 }
 {{< /play >}}
 
+پیش از توضیح نحوه تست سرور http ایجاد شده، اجازه بدهید کمی درباره دو مفهوم
+کلیدی Encode و Decode که در کد بالا آمده است و ممکن است برای کسانی که تازه وارد بحث
+برنامه نویسی شبکه شده اند کمی گنگ باشد، توضیح بدهیم.
+
+## توضیح Encode و Decode در کد
+در کدی که نوشتیم، دو عمل خیلی مهم وجود دارد: Encode و Decode. این‌ها مسئول تبدیل داده‌ها بین دنیای Go و دنیای JSON هستند.
+
+### Encode
+هر وقت بخواهیم داده‌های سمت سرور (مثل یک struct یا slice) را به صورت JSON برای کلاینت بفرستیم، از Encode استفاده می‌کنیم.
+
+مثلاً در تابع getTodos:
+
+```go
+json.NewEncoder(w).Encode(todos)
+```
+
+اینجا متغیر todos (که یک slice از structهای Todo است) گرفته می‌شود و به یک رشته JSON تبدیل می‌شود. خروجی نهایی چیزی شبیه به این خواهد بود:
+
+```json
+[
+  {"id": 1, "title": "Learn Go", "status": false},
+  {"id": 2, "title": "Write Book", "status": true}
+]
+```
+
+### Decode
+وقتی کلاینت داده‌ای را به سرور می‌فرستد (مثلاً با متد POST یا PATCH)، داده‌ها معمولاً در قالب JSON ارسال می‌شوند. ما باید این JSON را به یک struct در Go تبدیل کنیم تا بتوانیم راحت با آن کار کنیم. اینجاست که Decode به کار می‌آید.
+
+مثلاً در تابع addTodo:
+
+```go
+json.NewDecoder(r.Body).Decode(&todo)
+```
+
+اینجا بدنه‌ی درخواست (r.Body) خوانده می‌شود و JSON داخل آن مثلاً:
+
+```json
+{"title": "Buy milk", "status": false}
+```
+
+به یک struct از نوع Todo تبدیل می‌شود و داخل متغیر todo قرار می‌گیرد.
+
+## نحوه تست سرور http ایجاد شده
+
 بعد از اتمام نوشتن سرور با استفاده از یک کلاینت `http` مثل postman سرور خود را به روش زیر تست میکنیم:
 
 نکته: شما می توانید کلاینت خود را خودتان با استفاده از اموزش کلاینت http در قسمت های دیگر بنویسید!

content/chapter 5/5.8-http-client-begginer.md

@@ -19,26 +19,33 @@ weight: 9008
 package main
 
 import (
-    "fmt"
-    "io/ioutil"
-    "net/http"
-    "time"
+	"fmt"
+	"io"
+	"net/http"
+	"time"
 )
 
 func main() {
-    // کلاینت خود را با استفاده از ماژول http ایجاد میکنیم
-    c := http.Client{Timeout: time.Duration(1) * time.Second}
-    // از طریق کلاینت ایجاد شده یک درخواست با متد GET به آدرس example.com ارسال میکنیم
-    // دقیقا سروری مشابه به سرور هایی که در قسمت های قبل ایجاد کردیم در آدرسی که الان به آن درخوایت ارسال میکنیم درحال گوش سپردن به درخواست ها میباشد.
-    resp, err := c.Get("https://www.example.com")
-    if err != nil {
-        fmt.Printf("Error %s", err)
-        return
-    }
-    defer resp.Body.Close()
-    // مقادیر دریافت شده از سرور را میخوانیم و چاپ میکنیم
-    body, err := ioutil.ReadAll(resp.Body)
-    fmt.Printf("Body : %s", body)
+	// کلاینت خود را با استفاده از ماژول http ایجاد میکنیم
+	c := http.Client{Timeout: time.Duration(1) * time.Second}
+
+	// از طریق کلاینت ایجاد شده یک درخواست با متد GET به آدرس example.com ارسال میکنیم
+	// دقیقا سروری مشابه به سرور هایی که در قسمت های قبل ایجاد کردیم در آدرسی که الان به آن درخوایت ارسال میکنیم درحال گوش سپردن به درخواست ها میباشد.
+	resp, err := c.Get("https://www.example.com")
+	if err != nil {
+		fmt.Printf("Error %s", err)
+		return
+	}
+	defer resp.Body.Close()
+	
+	// مقادیر دریافت شده از سرور را میخوانیم و چاپ میکنیم
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		fmt.Println("Error: ", err)
+		return
+	}
+
+	fmt.Printf("Body : %s", body)
 }
 {{< /play >}}