Context Timeout

ContextTimeout gives each request a deadline. Database calls, HTTP clients, and anything else that honours c.Context() stop when it passes, and the request fails with 503 Service Unavailable.

Quick start

app.Use(middleware.ContextTimeout(2 * time.Second))

Config fields

Field	Meaning
Skipper	Skip timeout handling for selected requests
Timeout	Required timeout duration
ErrorHandler	Customize timeout failures

Accessing timeout state

info, ok := middleware.ContextTimeoutCurrent(c)
remaining, ok := middleware.ContextTimeoutRemaining(c)

ContextTimeoutInfo contains:

• Timeout
• Deadline

The deadline only helps if downstream work uses the request context. Code that ignores c.Context() keeps running.

Error behavior

If the handler chain returns context.DeadlineExceeded, Zinc wraps it in *middleware.ContextTimeoutError.

The default error handler returns 503 Service Unavailable joined with the timeout error.

Example

app.Use(middleware.ContextTimeoutWithConfig(middleware.ContextTimeoutConfig{
  Timeout: 2 * time.Second,
  ErrorHandler: func(c *zinc.Context, err *middleware.ContextTimeoutError) error {
    return zinc.ErrServiceUnavailable.WithMessage("request timed out")
  },
}))