timeout

README

timeout

HTTP timeout middleware for Go.

Installation

go get -u github.com/go-http-utils/timeout

Documentation

API documentation can be found here: https://godoc.org/github.com/go-http-utils/timeout

Usage

import (
  "github.com/go-http-utils/timeout"
)

mux := http.NewServeMux()
mux.HandleFunc("/", func(res http.ResponseWriter, req *http.Request) {
  res.Write([]byte("Hello World"))
})

http.ListenAndServe(":8080", timeout.Handler(mux, time.Second*10, timeout.DefaultTimeoutHandler))

Documentation

Overview

Example

package main

import (
	"net/http"
	"time"

	"github.com/go-http-utils/timeout"
)

func main() {
	mux := http.NewServeMux()
	mux.HandleFunc("/", func(res http.ResponseWriter, req *http.Request) {
		res.Write([]byte("Hello World"))
	})

	http.ListenAndServe(":8080", timeout.Handler(mux, time.Second*10, timeout.DefaultTimeoutHandler))
}

Index

• Variables
• func Handler(h http.Handler, timeout time.Duration, timeoutHandler http.Handler) http.Handler

Examples

• Package

Variables

var DefaultTimeoutHandler = http.HandlerFunc(
	func(res http.ResponseWriter, req *http.Request) {
		res.WriteHeader(http.StatusGatewayTimeout)
		res.Write([]byte("Service timeout"))
	})

DefaultTimeoutHandler is a convenient timeout handler which simply returns "504 Service timeout".

var Version = "0.1.0"

Version is this package's version.

Functions

func Handler

func Handler(h http.Handler, timeout time.Duration, timeoutHandler http.Handler) http.Handler

Handler wraps the http.Handler h with timeout support.