vulcan

README

Status

This library has been refactored into: https://github.com/mailgun/oxy and is being deprecated

OXY is compatible with HTTP standard library, provides the same features as Vulcan and is simpler to use. Please consider using it instead.

Vulcan library will stay there for a while in case if you are using it, but I would suggest consider migrating. Vulcand project is currently migrating to oxy library.

Documentation

Overview

This package contains the reverse proxy that implements http.HandlerFunc

Index

• type Options
• type Proxy
  • func NewProxy(router route.Router) (*Proxy, error)
  • func NewProxyWithOptions(router route.Router, o Options) (*Proxy, error)
  • func (p *Proxy) GetRouter() route.Router
  • func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request)

Types

type Options

type Options struct {
	// Takes a status code and formats it into proxy response
	ErrorFormatter errors.Formatter
}

type Proxy

type Proxy struct {
	// contains filtered or unexported fields
}

func NewProxy

func NewProxy(router route.Router) (*Proxy, error)

Creates a proxy with a given router

func NewProxyWithOptions

func NewProxyWithOptions(router route.Router, o Options) (*Proxy, error)

Creates reverse proxy that acts like http request handler

func (*Proxy) GetRouter

func (p *Proxy) GetRouter() route.Router

func (*Proxy) ServeHTTP

func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request)

Accepts requests, round trips it to the endpoint, and writes back the response.