router

Documentation

Overview

Package router defines some interfaces for router adapters

Index

• Constants
• Variables
• type Factory
• type Router
• type RouterFunc
  • func (f RouterFunc) Run(cfg config.ServiceConfig)
• type ToHTTPError

Constants

const (
	// HeaderCompleteResponseValue is the value of the CompleteResponseHeader
	// if the response is complete
	// Deprecated: HeaderCompleteResponseValue is deprecated
	HeaderCompleteResponseValue = http.HeaderCompleteResponseValue
	// HeaderIncompleteResponseValue is the value of the CompleteResponseHeader
	// if the response is not complete
	// Deprecated: HeaderIncompleteResponseValue is deprecated
	HeaderIncompleteResponseValue = http.HeaderIncompleteResponseValue
)

Variables

var (
	// CompleteResponseHeaderName is the header to flag incomplete responses to the client
	// Deprecated: HeaderIncompleteResponseValue is deprecated
	CompleteResponseHeaderName = http.CompleteResponseHeaderName
	// HeadersToSend are the headers to pass from the router request to the proxy
	// Deprecated: HeadersToSend is deprecated
	HeadersToSend = http.HeadersToSend
	// UserAgentHeaderValue is the value of the User-Agent header to add to the proxy request
	// Deprecated: UserAgentHeaderValue is deprecated
	UserAgentHeaderValue = http.UserAgentHeaderValue
	// ErrInternalError is the error returned by the router when something went wrong
	// Deprecated: ErrInternalError is deprecated
	ErrInternalError = http.ErrInternalError
)

var DefaultToHTTPError = http.DefaultToHTTPError

DefaultToHTTPError is a ToHTTPError transalator that always returns an internal server error Deprecated: DefaultToHTTPError is deprecated

var InitHTTPDefaultTransport = http.InitHTTPDefaultTransport

InitHTTPDefaultTransport ensures the default HTTP transport is configured just once per execution Deprecated: InitHTTPDefaultTransport is deprecated

var RunServer = http.RunServer

RunServer runs a http.Server with the given handler and configuration Deprecated: RunServer is deprecated

Types

type Factory

type Factory interface {
	New() Router
	NewWithContext(context.Context) Router
}

Factory creates new routers

type Router

type Router interface {
	Run(config.ServiceConfig)
}

Router sets up the public layer exposed to the users

type RouterFunc

type RouterFunc func(config.ServiceConfig)

RouterFunc type is an adapter to allow the use of ordinary functions as routers. If f is a function with the appropriate signature, RouterFunc(f) is a Router that calls f.

func (RouterFunc) Run

func (f RouterFunc) Run(cfg config.ServiceConfig)

Run implements the Router interface

type ToHTTPError

type ToHTTPError http.ToHTTPError

ToHTTPError translates an error into a HTTP status code Deprecated: ToHTTPError is deprecated