gin/response_writer.go

116 lines
2.4 KiB
Go
Raw Normal View History

2014-08-29 17:49:50 +00:00
// Copyright 2014 Manu Martinez-Almeida. All rights reserved.
// Use of this source code is governed by a MIT style
// license that can be found in the LICENSE file.
2014-07-03 22:01:28 +00:00
package gin
import (
2014-08-25 11:58:43 +00:00
"bufio"
"io"
2014-08-25 11:58:43 +00:00
"net"
2014-07-03 22:01:28 +00:00
"net/http"
)
const (
noWritten = -1
defaultStatus = http.StatusOK
)
type responseWriterBase interface {
2017-07-05 07:47:36 +00:00
http.ResponseWriter
http.Hijacker
http.Flusher
http.CloseNotifier
2017-07-05 07:47:36 +00:00
// Returns the HTTP response status code of the current request.
Status() int
2017-07-05 07:47:36 +00:00
// Returns the number of bytes already written into the response http body.
// See Written()
Size() int
2017-07-05 07:47:36 +00:00
// Writes the string into the response body.
WriteString(string) (int, error)
2017-07-05 07:47:36 +00:00
// Returns true if the response body was already written.
Written() bool
2017-07-05 07:47:36 +00:00
// Forces to write the http header (status code + headers).
WriteHeaderNow()
}
2014-07-03 22:01:28 +00:00
2017-07-05 07:47:36 +00:00
type responseWriter struct {
http.ResponseWriter
size int
status int
}
2014-07-03 22:01:28 +00:00
var _ ResponseWriter = &responseWriter{}
2014-07-03 22:01:28 +00:00
func (w *responseWriter) reset(writer http.ResponseWriter) {
w.ResponseWriter = writer
w.size = noWritten
w.status = defaultStatus
2014-07-03 22:01:28 +00:00
}
2014-08-18 03:24:48 +00:00
func (w *responseWriter) WriteHeader(code int) {
if code > 0 && w.status != code {
if w.Written() {
debugPrint("[WARNING] Headers were already written. Wanted to override status code %d with %d", w.status, code)
2014-08-18 03:24:48 +00:00
}
w.status = code
2014-08-18 03:24:48 +00:00
}
2014-07-03 22:01:28 +00:00
}
2014-08-18 03:24:48 +00:00
func (w *responseWriter) WriteHeaderNow() {
if !w.Written() {
w.size = 0
2014-08-18 03:24:48 +00:00
w.ResponseWriter.WriteHeader(w.status)
}
}
func (w *responseWriter) Write(data []byte) (n int, err error) {
w.WriteHeaderNow()
n, err = w.ResponseWriter.Write(data)
w.size += n
return
2014-07-03 22:01:28 +00:00
}
func (w *responseWriter) WriteString(s string) (n int, err error) {
w.WriteHeaderNow()
n, err = io.WriteString(w.ResponseWriter, s)
w.size += n
return
}
2014-07-03 22:01:28 +00:00
func (w *responseWriter) Status() int {
return w.status
}
func (w *responseWriter) Size() int {
return w.size
}
2014-07-03 22:01:28 +00:00
func (w *responseWriter) Written() bool {
return w.size != noWritten
2014-07-03 22:01:28 +00:00
}
2014-08-25 11:58:43 +00:00
2017-08-16 03:55:50 +00:00
// Hijack implements the http.Hijacker interface.
2014-08-25 11:58:43 +00:00
func (w *responseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) {
2015-04-08 13:20:39 +00:00
if w.size < 0 {
w.size = 0
}
2015-03-23 03:45:03 +00:00
return w.ResponseWriter.(http.Hijacker).Hijack()
2014-08-25 11:58:43 +00:00
}
2017-08-16 03:55:50 +00:00
// CloseNotify implements the http.CloseNotify interface.
func (w *responseWriter) CloseNotify() <-chan bool {
return w.ResponseWriter.(http.CloseNotifier).CloseNotify()
}
2017-08-16 03:55:50 +00:00
// Flush implements the http.Flush interface.
func (w *responseWriter) Flush() {
w.WriteHeaderNow()
2015-03-23 03:45:33 +00:00
w.ResponseWriter.(http.Flusher).Flush()
}