re
/
gin
forked from mirror/gin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #470 from bwiggs/master 

Clarify context.Abort docs
This commit is contained in:
Manu Mtz.-Almeida 2016-01-26 20:03:10 +01:00
parent e73da74410 353fa14750
commit afa95eff67
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
context.go
View File

@ -101,10 +101,10 @@ func (c *Context) IsAborted() bool {
return c.index >= abortIndex return c.index >= abortIndex
} }
// Abort stops the system to continue calling the pending handlers in the chain. // Abort prevents pending handlers from being called. Note that this will not stop the current handler.
// Let's say you have an authorization middleware that validates if the request is authorized // Let's say you have an authorization middleware that validates that the current request is authorized. If the
// if the authorization fails (the password does not match). This method (Abort()) should be called // authorization fails (ex: the password does not match), call Abort to ensure the remaining handlers
// in order to stop the execution of the actual handler. // for this request are not called.
func (c *Context) Abort() { func (c *Context) Abort() {
c.index = abortIndex c.index = abortIndex
} }