Documentation
¶
Overview ¶
package forwarder implements http handler that forwards requests to remote server and serves back the response websocket proxying support based on https://github.com/yhat/wsutil
Index ¶
- Constants
- Variables
- func ErrorHandler(h utils.ErrorHandler) optSetter
- func PassHostHeader(b bool) optSetter
- func Rewriter(r ReqRewriter) optSetter
- func RoundTripper(r http.RoundTripper) optSetter
- func StateListener(stateListener UrlForwardingStateListener) optSetter
- func Stream(stream bool) optSetter
- func StreamingFlushInterval(flushInterval time.Duration) optSetter
- func WebsocketDial(dial Dialer) optSetter
- func WebsocketRewriter(r ReqRewriter) optSetter
- type Dialer
- type Forwarder
- type HeaderRewriter
- type ReqRewriter
- type UrlForwardingStateListener
Constants ¶
const ( StateConnected = iota StateDisconnected )
const ( XForwardedProto = "X-Forwarded-Proto" XForwardedFor = "X-Forwarded-For" XForwardedHost = "X-Forwarded-Host" XForwardedServer = "X-Forwarded-Server" Connection = "Connection" KeepAlive = "Keep-Alive" ProxyAuthenticate = "Proxy-Authenticate" ProxyAuthorization = "Proxy-Authorization" Te = "Te" // canonicalized version of "TE" Trailers = "Trailers" TransferEncoding = "Transfer-Encoding" Upgrade = "Upgrade" ContentLength = "Content-Length" )
Variables ¶
var HopHeaders = []string{ Connection, KeepAlive, ProxyAuthenticate, ProxyAuthorization, Te, Trailers, TransferEncoding, Upgrade, }
Hop-by-hop headers. These are removed when sent to the backend. http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html Copied from reverseproxy.go, too bad
Functions ¶
func ErrorHandler ¶
func ErrorHandler(h utils.ErrorHandler) optSetter
ErrorHandler is a functional argument that sets error handler of the server
func PassHostHeader ¶
func PassHostHeader(b bool) optSetter
PassHostHeader specifies if a client's Host header field should be delegated
func Rewriter ¶
func Rewriter(r ReqRewriter) optSetter
Rewriter defines a request rewriter for the HTTP forwarder
func RoundTripper ¶
func RoundTripper(r http.RoundTripper) optSetter
RoundTripper sets a new http.RoundTripper Forwarder will use http.DefaultTransport as a default round tripper
func StateListener ¶
func StateListener(stateListener UrlForwardingStateListener) optSetter
func Stream ¶
func Stream(stream bool) optSetter
Logger specifies the logger to use. Forwarder will default to oxyutils.NullLogger if no logger has been specified
func StreamingFlushInterval ¶
func WebsocketDial ¶
func WebsocketDial(dial Dialer) optSetter
WebsocketDial defines a new network dialer to use to dial to remote websocket destination. If no dialer has been defined, net.Dial will be used.
func WebsocketRewriter ¶
func WebsocketRewriter(r ReqRewriter) optSetter
WebsocketRewriter defines a request rewriter for the websocket forwarder
Types ¶
type Forwarder ¶
type Forwarder struct {
// contains filtered or unexported fields
}
Forwarder wraps two traffic forwarding implementations: HTTP and websockets. It decides based on the specified request which implementation to use
type HeaderRewriter ¶
Rewriter is responsible for removing hop-by-hop headers and setting forwarding headers
func (*HeaderRewriter) Rewrite ¶
func (rw *HeaderRewriter) Rewrite(req *http.Request)
type ReqRewriter ¶
ReqRewriter can alter request headers and body
Source Files