Cutlery/caddy
1
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2025-11-03 19:17:29 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify godoc for HTTP handler signature

Browse Source
This commit is contained in:
Matthew Holt 2016-08-25 17:13:49 -06:00
parent b1ae8a71f1
commit 191ec27c26
No known key found for this signature in database
GPG Key ID: 0D97CC73664F4D03
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
caddyhttp/httpserver/middleware.go
View File

@ -21,17 +21,18 @@ type (
// Handler is like http.Handler except ServeHTTP may return a status // Handler is like http.Handler except ServeHTTP may return a status
// code and/or error. // code and/or error.
// //
// If ServeHTTP writes to the response body, it should return a status // If ServeHTTP writes the response header, it should return a status
// code of 0. This signals to other handlers above it that the response // code of 0. This signals to other handlers before it that the response
// body is already written, and that they should not write to it also. // is already handled, and that they should not write to it also. Keep
// in mind that writing to the response body writes the header, too.
// //
// If ServeHTTP encounters an error, it should return the error value // If ServeHTTP encounters an error, it should return the error value
// so it can be logged by designated error-handling middleware. // so it can be logged by designated error-handling middleware.
// //
// If writing a response after calling another ServeHTTP method, the // If writing a response after calling the next ServeHTTP method, the
// returned status code SHOULD be used when writing the response. // returned status code SHOULD be used when writing the response.
// //
// If handling errors after calling another ServeHTTP method, the // If handling errors after calling the next ServeHTTP method, the
// returned error value SHOULD be logged or handled accordingly. // returned error value SHOULD be logged or handled accordingly.
// //
// Otherwise, return values should be propagated down the middleware // Otherwise, return values should be propagated down the middleware