http

Documentation

Overview

Package http provides a HTTP transport and some utitities.

Index

• func GetClientIP(r *http.Request) net.IP
• func GetRequestBody(w http.ResponseWriter, r *http.Request, maxBodyBytes ...int64) io.Reader
• func Health(probe *xtransport.Probe) http.HandlerFunc
• func NewHTTPTransport(httpSrv *http.Server, logger xlog.Logger, probe *xtransport.Probe) xtransport.Transport

Functions

func GetClientIP

func GetClientIP(r *http.Request) net.IP

GetClientIP returns client ip from following sources, in this order: X-Real-Ip, X-Forwarded-For (first ip in an eventual list), r.RemoteAddr. Note: we assume these headers come from a trusted proxy, as client can also set them to any arbitrary value which may lead to ip spoofing.

func GetRequestBody

func GetRequestBody(w http.ResponseWriter, r *http.Request, maxBodyBytes ...int64) io.Reader

GetRequestBody MaxBytesReader prevents clients from accidentally or maliciously sending a large request and wasting server resources.

func Health

func Health(probe *xtransport.Probe) http.HandlerFunc

Health can be registered as health probe endpoint.

func NewHTTPTransport

func NewHTTPTransport(
	httpSrv *http.Server,
	logger xlog.Logger,
	probe *xtransport.Probe,
) xtransport.Transport

NewHTTPTransport instantiates a new HTTP transport.