proxy

README

proxy

A Go library based on golang.org/x/net/proxy.

Documentation

Overview

Package proxy is a library based on golang.org/x/net/proxy.

Index

• func Dial(ctx context.Context, d Dialer, network, addr string) (net.Conn, error)
• func RegisterDialerType(scheme string, f func(*url.URL, Dialer) (Dialer, error))
• type ContextDialer
• type Dialer
  • func FromEnvironment() Dialer
  • func FromEnvironmentUsing(forward Dialer) Dialer
  • func FromURL(u *url.URL, forward Dialer) (Dialer, error)

Functions

func Dial

func Dial(ctx context.Context, d Dialer, network, addr string) (net.Conn, error)

Dial works like DialContext on Dialer with a fallback in case provided Dialer is not a ContextDialer.

The passed ctx is only used for returning the Conn, not the lifetime of the Conn.

Custom dialers (registered via RegisterDialerType) that do not implement ContextDialer can leak a goroutine for as long as it takes the underlying Dialer implementation to timeout.

func RegisterDialerType

func RegisterDialerType(scheme string, f func(*url.URL, Dialer) (Dialer, error))

RegisterDialerType takes a URL scheme and a function to generate Dialers from a URL with that scheme and a forwarding Dialer. Registered schemes are used by FromURL.

Types

type ContextDialer

type ContextDialer interface {
	DialContext(ctx context.Context, network, addr string) (net.Conn, error)
}

A ContextDialer dials using a context.

type Dialer

type Dialer interface {
	Dial(network, addr string) (net.Conn, error)
}

A Dialer is a means to establish a connection. Custom dialers should also implement ContextDialer.

var Direct Dialer = proxy_Direct

Direct implements Dialer by making network connections directly using net.Dial or net.DialContext.

func FromEnvironment

func FromEnvironment() Dialer

FromEnvironment returns the dialer specified by the proxy-related variables in the environment and makes underlying connections directly.

func FromEnvironmentUsing

func FromEnvironmentUsing(forward Dialer) Dialer

FromEnvironmentUsing returns the dialer specify by the proxy-related variables in the environment and makes underlying connections using the provided forwarding Dialer (for instance, a *net.Dialer with desired configuration).

func FromURL

func FromURL(u *url.URL, forward Dialer) (Dialer, error)

FromURL returns a Dialer given a URL specification and an underlying Dialer for it to make network requests.