Context Timeout

Context Timeout middleware applies a timeout to the request context within a predefined period, so context-aware methods can return early once the deadline is exceeded.

Usage

e.Use(middleware.ContextTimeout(60 * time.Second))

Custom configuration

e.Use(middleware.ContextTimeoutWithConfig(middleware.ContextTimeoutConfig{
  Timeout: 60 * time.Second,
}))

Configuration

type ContextTimeoutConfig struct {
  // Skipper defines a function to skip middleware.
  Skipper Skipper

  // ErrorHandler is a function invoked when an error arises during middleware execution.
  ErrorHandler func(c *echo.Context, err error) error

  // Timeout configures the timeout for the middleware.
  Timeout time.Duration
}

Default configuration

// Effective defaults applied when fields are left unset (Timeout is required).
ContextTimeoutConfig{
  Skipper: DefaultSkipper,
}