httpx

README

httpx

Documentation

Index

• Variables
• func ListenAndServe(addr string, h Handler) error
• func RegisterProvider(p Provider)
• func ReleaseContext(ctx Context)
• func ReleaseRequest(req Request)
• func ReleaseResponse(resp Response)
• func SetEnableRelease(enable bool)
• func ToHttpForm(f Values) url.Values
• func ToHttpHeader(h Header) http.Header
• func ToHttpRequest(r Request) *http.Request
• func ToHttpResponseWriter(w Response) http.ResponseWriter
• type Context
  • func AcquireContext() Context
• type Handler
  • func HttpHandler(handler http.Handler) Handler
• type HandlerFunc
  • func HttpHandlerFunc(fn http.HandlerFunc) HandlerFunc
  • func (fn HandlerFunc) Handle(ctx Context)
• type Header
• type Provider
• type Request
  • func AcquireRequest() Request
• type Response
  • func AcquireResponse() Response
• type Values

Variables

var Http = &httpProvider{}

Http is a provider via "net/http".

Functions

func ListenAndServe

func ListenAndServe(addr string, h Handler) error

ListenAndServe calls ListenAndServe of the registered default provider.

func RegisterProvider

func RegisterProvider(p Provider)

RegisterProvider registers a provider as default provider.

func ReleaseContext

func ReleaseContext(ctx Context)

ReleaseContext calls ReleaseContext of the registered default provider.

func ReleaseRequest

func ReleaseRequest(req Request)

ReleaseRequest calls ReleaseRequest of the registered default provider.

func ReleaseResponse

func ReleaseResponse(resp Response)

ReleaseResponse calls ReleaseResponse of the registered default provider.

func SetEnableRelease

func SetEnableRelease(enable bool)

SetEnableRelease calls SetEnableRelease of the registered default provider.

func ToHttpForm

func ToHttpForm(f Values) url.Values

ToHttpForm converts httpx.Values to url.Values.

func ToHttpHeader

func ToHttpHeader(h Header) http.Header

ToHttpHeader converts httpx.Header to http.Header.

func ToHttpRequest

func ToHttpRequest(r Request) *http.Request

ToHttpRequest converts httpx.Request to *http.Request.

func ToHttpResponseWriter

func ToHttpResponseWriter(w Response) http.ResponseWriter

ToHttpResponseWriter converts httpx.Response to http.ResponseWriter.

Types

type Context

type Context interface {
	// Request returns httpx.Request.
	Request() Request
	// Response returns httpx.Response.
	Response() Response
	// Reset resets request and response.
	Reset()
}

Context holds current HTTP request and response objects.

func AcquireContext

func AcquireContext() Context

AcquireContext calls AcquireContext of the registered default provider.

type Handler

type Handler interface {
	// Handle called by the HTTP server.
	Handle(ctx Context)
}

A Handler responds to a httpx.Context.

func HttpHandler

func HttpHandler(handler http.Handler) Handler

HttpHandler calls HttpHandler of the registered default provider.

type HandlerFunc

type HandlerFunc func(ctx Context)

The HandlerFunc type is an adapter to allow the use of ordinary functions as httpx.Handler. If fn is a function with the appropriate signature, HandlerFunc(fn) is a Handler that calls fn.

func HttpHandlerFunc

func HttpHandlerFunc(fn http.HandlerFunc) HandlerFunc

HttpHandlerFunc calls HttpHandlerFunc of the registered default provider.

func (HandlerFunc) Handle

func (fn HandlerFunc) Handle(ctx Context)

Handle calls fn(ctx).

type Header

type Header interface {
	Values
	// WriteTo writes a header in wire format.
	WriteTo(w io.Writer) error
}

Header represents a HTTP header.

type Provider

type Provider interface {
	// AcquireContext returns an empty Context instance from the pool.
	// The returned Context instance should be passed to ReleaseContext to
	// be returned when no longer needed.
	AcquireContext() Context

	// AcquireRequest returns an empty Request instance from the pool.
	// The returned Request instance should be passed to ReleaseRequest to
	// be returned when no longer needed.
	AcquireRequest() Request

	// AcquireResponse returns an empty Response instance from the pool.
	// The returned Response instance should be passed to ReleaseResponse to
	// be returned when no longer needed.
	AcquireResponse() Response

	// ReleaseContext return a context acquired via AcquireContext to the pool.
	// It is forbidden accessing instance and/or its' members after returning
	// it to the pool.
	ReleaseContext(ctx Context)

	// ReleaseRequest return a request acquired via AcquireRequest to the pool.
	// It is forbidden accessing instance and/or its' members after returning
	// it to the pool.
	ReleaseRequest(req Request)

	// ReleaseResponse return a response acquired via AcquireResponse to the pool.
	// It is forbidden accessing instance and/or its' members after returning
	// it to the pool.
	ReleaseResponse(res Response)

	// SetEnableRelease sets enable ReleaseContext, ReleaseRequest, and
	// ReleaseResponse. The default is enable.
	// Set disable is not normally used, but is used when assertions are required
	// for unit tests.
	SetEnableRelease(enable bool)

	// ListenAndServe listens on the TCP network address addr and then calls
	// Serve with handler to handle requests on incoming connections.
	ListenAndServe(addr string, h Handler) error

	// ListenAndServeTLS acts identically to ListenAndServe, except that it
	// expects HTTPS connections. Additionally, files containing a certificate and
	// matching private key for the server must be provided. If the certificate
	// is signed by a certificate authority, the certFile should be the concatenation
	// of the server's certificate, any intermediates, and the CA's certificate.
	ListenAndServeTLS(addr, certFile, keyFile string, h Handler) error

	// HttpHandler converts http.Handler to httpx.Handler.
	HttpHandler(h http.Handler) Handler

	// HttpHandlerFunc converts http.HandlerFunc to httpx.Handler.
	HttpHandlerFunc(fn http.HandlerFunc) HandlerFunc
}

Provider is the interface for providing objects of httpx.

type Request

type Request interface {
	// Header returns the HTTP header.
	Header() Header
	// Trailer returns the trailer HTTP header.
	Trailer() Header
	// Method returns the HTTP method.
	Method() string
	// URL returns the URI being requested.
	URL() *url.URL
	// Proto returns the protocol version for incoming server requests.
	Proto() string
	// ProtoMajor returns a major version number in the protocol version.
	ProtoMajor() int
	// ProtoMinor returns a minor version number in the protocol version.
	ProtoMinor() int
	// Host returns the host on which the URL is sought.
	Host() string
	// RemoteAddr returns the network address that sent the request.
	RemoteAddr() string
	// RequestURI returns the request target.
	RequestURI() string
	// ContentLength returns the length of the associated content.
	ContentLength() int64
	// Body returns is the request's body.
	Body() io.ReadCloser
	// TLS returns the TLS connection on which the request was received.
	TLS() *tls.ConnectionState
	// Form returns the parsed form data.
	Form() Values
	// PostForm returns the parsed form data from PATCH, POST or PUT body parameters.
	PostForm() Values
	// MultipartmForm returns the parsed multipart form, including file uploads.
	MultipartmForm() *multipart.Form
	// SetMethod sets the HTTP method.
	SetMethod(method string)
	// SetURL sets the URL.
	SetURL(u *url.URL)
	// SetProto sets the protocol version.
	SetProto(proto string)
	// SetHost sets the host.
	SetHost(host string)
	// SetRemoteAddr sets the remote addr.
	SetRemoteAddr(addr string)
	// SetRequestURI sets the request URI.
	SetRequestURI(requestURI string)
	// SetContentLength set the content length.
	SetContentLength(contentLength int64)
	// SetBody sets the request body.
	SetBody(body io.ReadCloser)
	// SetTLS sets the connection state.
	SetTLS(connectionState *tls.ConnectionState)
	// Context returns the request context.
	Context() context.Context
	// WithContext returns a shallow copy of the request with its context changed to ctx.
	WithContext(ctx context.Context) Request
	// SetHttpRequest copies headers, body, etc. to this httpx.Request.
	// Depending on the implementation, it may be re-set as an internal request.
	// Update operations on this httpx.Request may affect specified request.
	SetHttpRequest(hr *http.Request)
	// Reset resets this request.
	Reset()
}

Request represents a HTTP request.

func AcquireRequest

func AcquireRequest() Request

AcquireRequest calls AcquireRequest of the registered default provider.

type Response

type Response interface {
	// Header returns a header.
	Header() Header
	// Write writes p to the HTTP response body.
	Write(p []byte) (int, error)
	// Write writes statusCode to the HTTP response header.
	WriteHeader(statusCode int)
	// SetHttpResponseWriter sets http.ResponseWriter.
	SetHttpResponseWriter(hw http.ResponseWriter)
	// Reset resets this response.
	Reset()
}

Response represents a HTTP response.

func AcquireResponse

func AcquireResponse() Response

AcquireResponse calls AcquireResponse of the registered default provider.

type Values

type Values interface {
	// Each calls fn for each names with values.
	Each(fn func(name string, values []string))
	// Set sets the named values.
	Set(name string, values ...string)
	// Add adds a value to the existing named values.
	Add(name, value string)
	// Del deletes named values.
	Del(name string)
	// Has checks the name is exists.
	Has(name string) bool
	// Value returns a first value.
	Value(name string) string
	// Values returns values.
	Values(name string) []string
	// Len returns the names count.
	Len() int
	// Reset resets all values.
	Reset()
}

Value represents HTTP values like map[string][]string.