Skip to content

Commit 6af2b1a

Browse files
http3: rename Server.CloseGracefully to Shutdown (#4701)
This is more consistent with standard library naming for graceful shutdown methods for HTTP/1 and HTTP/2.
1 parent 4a9a81c commit 6af2b1a

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

http3/server.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -747,10 +747,10 @@ func (s *Server) Close() error {
747747
return err
748748
}
749749

750-
// CloseGracefully shuts down the server gracefully.
750+
// Shutdown shuts down the server gracefully.
751751
// The server sends a GOAWAY frame first, then or for all running requests to complete.
752-
// CloseGracefully in combination with ListenAndServe() (instead of Serve()) may race if it is called before a UDP socket is established.
753-
func (s *Server) CloseGracefully(ctx context.Context) error {
752+
// Shutdown in combination with ListenAndServe() (instead of Serve()) may race if it is called before a UDP socket is established.
753+
func (s *Server) Shutdown(ctx context.Context) error {
754754
s.mutex.Lock()
755755
s.closed = true
756756
// server is never used

http3/server_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1200,7 +1200,7 @@ var _ = Describe("Server", func() {
12001200
})
12011201

12021202
It("closes gracefully", func() {
1203-
Expect(s.CloseGracefully(context.Background())).To(Succeed())
1203+
Expect(s.Shutdown(context.Background())).To(Succeed())
12041204
})
12051205

12061206
It("errors when listening fails", func() {

integrationtests/self/http_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -1092,7 +1092,7 @@ var _ = Describe("HTTP tests", func() {
10921092
go func() {
10931093
defer GinkgoRecover()
10941094
defer close(done)
1095-
Expect(server.CloseGracefully(context.Background())).To(Succeed())
1095+
Expect(server.Shutdown(context.Background())).To(Succeed())
10961096
fmt.Println("close gracefully done")
10971097
}()
10981098
time.Sleep(delay)
@@ -1112,7 +1112,7 @@ var _ = Describe("HTTP tests", func() {
11121112
// manually close the client, since we don't support
11131113
client.Transport.(*http3.Transport).Close()
11141114

1115-
// make sure that CloseGracefully returned
1115+
// make sure that Shutdown returned
11161116
Eventually(done).Should(BeClosed())
11171117
})
11181118

@@ -1130,7 +1130,7 @@ var _ = Describe("HTTP tests", func() {
11301130
ctx, cancel := context.WithTimeout(context.Background(), delay)
11311131
defer cancel()
11321132
defer close(shutdownDone)
1133-
Expect(server.CloseGracefully(ctx)).To(MatchError(context.DeadlineExceeded))
1133+
Expect(server.Shutdown(ctx)).To(MatchError(context.DeadlineExceeded))
11341134
}()
11351135
for t := range time.NewTicker(delay / 10).C {
11361136
if _, err := w.Write([]byte(t.String())); err != nil {
@@ -1155,7 +1155,7 @@ var _ = Describe("HTTP tests", func() {
11551155
Eventually(requestChan).Should(Receive(&requestDuration))
11561156
Expect(requestDuration).To(BeNumerically("~", delay, delay/2))
11571157

1158-
// make sure that CloseGracefully returned
1158+
// make sure that Shutdown returned
11591159
Eventually(shutdownDone).Should(BeClosed())
11601160
})
11611161
})

0 commit comments

Comments
 (0)