etag

README

etag

Provide etag support for Go web server.

How to install

go get github.com/t-k/etag

Usage

Install the package with go get and use import to include it in your project.

import "github.com/t-k/etag"

GoDoc: http://godoc.org/github.com/t-k/etag

##Example

package main

import (
  "github.com/t-k/etag"
  "net/http"
)

func main() {
  http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
    if etag.IsStale(w, r, "etag-key") {
      // normal response processing
      w.Write([]byte("Hello world!"))
    } else {
      // you don't need to do anything.
    }
  })
  http.ListenAndServe(":8000", nil)
}

Tests

go test

Documentation

Index

• Constants
• func Get(r *http.Request) string
• func IsStale(w http.ResponseWriter, r *http.Request, key string) (isStale bool)
• func Set(w http.ResponseWriter, key string)

Constants

const Version = "0.0.2"

Functions

func Get

func Get(r *http.Request) string

Get Get the "If-None-Match" from header.

func IsStale

func IsStale(w http.ResponseWriter, r *http.Request, key string) (isStale bool)

IsStale sets the etag on the response and checks it against the client request.

func Set

func Set(w http.ResponseWriter, key string)

Set Sets the etag.