Handle ‘broken pipe’ error in Go

向一个异常关闭并发送过RST包的TCP连接写入数据时,会发生broken pipe错误。第一次向异常关闭的连接

发送数据时,对端会回复一个RST数据包,告诉连接应该立即关闭,并重置连接。在已经接收到RST数据包后,

继续向连接发送数据时,则会提示broken pipe错误。在Go中,可以使用syscall.EPIPE来判断该错误。

重现broken pipe错误

重现步骤:

  • 服务端读取一个字节后关闭连接
  • 客户端发送三个1字节的数据包,每个数据包间隔1秒

客户端发送第一个数据包,服务端接收后关闭连接,客户端等待服务端关闭连接,再发送一个数据包,

此时服务端则会发送RST数据包给客户端,客户端在等待收到RST数据包后,再发送一个数据包,就会

发生broken pipe的错误。通过errors.Is(err, syscall.EPIPE)检测返回错误。

模拟错误场景示例代码如下:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
package main

import (
    "errors"
    "log"
    "net"
    "os"
    "syscall"
    "time"
)

func server() {
    listener, err := net.Listen("tcp", ":8080")
    if err != nil {
        log.Fatal(err)
    }

    defer listener.Close()

    conn, err := listener.Accept()
    if err != nil {
        log.Fatal("server", err)
        os.Exit(1)
    }
    data := make([]byte, 1)
    if _, err := conn.Read(data); err != nil {
        log.Fatal("server", err)
    }

    conn.Close()
}

func client() {
    conn, err := net.Dial("tcp", "localhost:8080")
    if err != nil {
        log.Fatal("client", err)
    }

    // write to make the connection closed on the server side
    if _, err := conn.Write([]byte("a")); err != nil {
        log.Printf("client: %v", err)
    }

    time.Sleep(1 * time.Second)

    // write to generate an RST packet
    if _, err := conn.Write([]byte("b")); err != nil {
        log.Printf("client: %v", err)
    }

    time.Sleep(1 * time.Second)

    // write to generate the broken pipe error
    if _, err := conn.Write([]byte("c")); err != nil {
        log.Printf("client: %v", err)
        if errors.Is(err, syscall.EPIPE) {
            log.Print("This is broken pipe error")
        }
    }
}

func main() {
    go server()

    time.Sleep(3 * time.Second) // wait for server to run

    client()
}

输出结果:

1
2
2022/07/31 11:29:43 client: write tcp [::1]:62324->[::1]:8080: write: broken pipe
2022/07/31 11:29:43 This is broken pipe error

通常,在向已经发送过RST包的连接,继续写入时会出现broken pipe错误。而从已经发送过RST包的连接读取时,

会出现connection reset by peer错误。