vulcan

README

Reverse proxy library

Vulcan is a low level library that provides reverse proxy functionality to golang programs

• Docs: http://www.vulcanproxy.com
• Used by: https://github.com/mailgun/vulcand

Features

• Load balancing
• Request routing
• Error detection and failure recovery
• Connection and rate limiting
• Pluggable middlewares

Status

• Hardening and covering by tests, use at own risk

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.