Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

outbound

package

Go to main page

Versions in this module

v1

v1.0.2

Apr 25, 2024

v1.0.1

Apr 24, 2024

Changes in this version

+ const DefaultALPN

+ const DefaultConnectionReceiveWindow

+ const DefaultHopInterval

+ const DefaultProtocol

+ const DefaultStreamReceiveWindow

+ var ErrUDPRemoteAddrMismatch = errors.New("udp packet dropped due to mismatched remote address")

+ func NewConn(c net.Conn, a C.ProxyAdapter) C.Conn

+ func NewSingMux(option SingMuxOption, proxy C.ProxyAdapter, base ProxyBase) (C.ProxyAdapter, error)

+ func StringToBps(s string) uint64

+ type Base struct

+ func NewBase(opt BaseOption) *Base

+ func (b *Base) Addr() string

+ func (b *Base) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.Conn, error)

+ func (b *Base) DialContextWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.Conn, err error)

+ func (b *Base) DialOptions(opts ...dialer.Option) []dialer.Option

+ func (b *Base) Id() string

+ func (b *Base) IsL3Protocol(metadata *C.Metadata) bool

+ func (b *Base) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.PacketConn, error)

+ func (b *Base) ListenPacketWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (b *Base) MarshalJSON() ([]byte, error)

+ func (b *Base) Name() string

+ func (b *Base) StreamConnContext(ctx context.Context, c net.Conn, metadata *C.Metadata) (net.Conn, error)

+ func (b *Base) SupportTFO() bool

+ func (b *Base) SupportUDP() bool

+ func (b *Base) SupportUOT() bool

+ func (b *Base) SupportWithDialer() C.NetWork

+ func (b *Base) SupportXUDP() bool

+ func (b *Base) Type() C.AdapterType

+ func (b *Base) Unwrap(metadata *C.Metadata, touch bool) C.Proxy

+ type BaseOption struct

+ Addr string

+ Interface string

+ MPTCP bool

+ Name string

+ Prefer C.DNSPrefer

+ RoutingMark int

+ TFO bool

+ Type C.AdapterType

+ UDP bool

+ XUDP bool

+ type BasicOption struct

+ DialerProxy string

+ IPVersion string

+ Interface string

+ MPTCP bool

+ RoutingMark int

+ TFO bool

+ type BrutalOption struct

+ Down string

+ Enabled bool

+ Up string

+ type Direct struct

+ func NewCompatible() *Direct

+ func NewDirect() *Direct

+ func NewDirectWithOption(option DirectOption) *Direct

+ func (d *Direct) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.Conn, error)

+ func (d *Direct) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.PacketConn, error)

+ type DirectOption struct

+ Name string

+ type Dns struct

+ func NewDnsWithOption(option DnsOption) *Dns

+ func (d *Dns) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.Conn, error)

+ func (d *Dns) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.PacketConn, error)

+ type DnsOption struct

+ Name string

+ type GrpcOptions struct

+ GrpcServiceName string

+ type HTTP2Options struct

+ Host []string

+ Path string

+ type HTTPOptions struct

+ Headers map[string][]string

+ Method string

+ Path []string

+ type Http struct

+ func NewHttp(option HttpOption) (*Http, error)

+ func (h *Http) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (h *Http) DialContextWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.Conn, err error)

+ func (h *Http) StreamConnContext(ctx context.Context, c net.Conn, metadata *C.Metadata) (net.Conn, error)

+ func (h *Http) SupportWithDialer() C.NetWork

+ type HttpOption struct

+ Fingerprint string

+ Headers map[string]string

+ Name string

+ Password string

+ Port int

+ SNI string

+ Server string

+ SkipCertVerify bool

+ TLS bool

+ UserName string

+ type Hysteria struct

+ func NewHysteria(option HysteriaOption) (*Hysteria, error)

+ func (h *Hysteria) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.Conn, error)

+ func (h *Hysteria) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.PacketConn, error)

+ type Hysteria2 struct

+ func NewHysteria2(option Hysteria2Option) (*Hysteria2, error)

+ func (h *Hysteria2) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (h *Hysteria2) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.PacketConn, err error)

+ type Hysteria2Option struct

+ ALPN []string

+ CWND int

+ CustomCA string

+ CustomCAString string

+ Down string

+ Fingerprint string

+ HopInterval int

+ Name string

+ Obfs string

+ ObfsPassword string

+ Password string

+ Port int

+ Ports string

+ SNI string

+ Server string

+ SkipCertVerify bool

+ UdpMTU int

+ Up string

+ type HysteriaOption struct

+ ALPN []string

+ Auth string

+ AuthString string

+ CustomCA string

+ CustomCAString string

+ DisableMTUDiscovery bool

+ Down string

+ DownSpeed int

+ FastOpen bool

+ Fingerprint string

+ HopInterval int

+ Name string

+ Obfs string

+ ObfsProtocol string

+ Port int

+ Ports string

+ Protocol string

+ ReceiveWindow int

+ ReceiveWindowConn int

+ SNI string

+ Server string

+ SkipCertVerify bool

+ Up string

+ UpSpeed int

+ func (c *HysteriaOption) Speed() (uint64, uint64, error)

+ type ProxyBase interface

+ DialOptions func(opts ...dialer.Option) []dialer.Option

+ type RealityOptions struct

+ PublicKey string

+ ShortID string

+ func (o RealityOptions) Parse() (*tlsC.RealityConfig, error)

+ type Reject struct

+ func NewPass() *Reject

+ func NewReject() *Reject

+ func NewRejectDrop() *Reject

+ func NewRejectWithOption(option RejectOption) *Reject

+ func (r *Reject) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.Conn, error)

+ func (r *Reject) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.PacketConn, error)

+ type RejectOption struct

+ Name string

+ type ShadowSocks struct

+ func NewShadowSocks(option ShadowSocksOption) (*ShadowSocks, error)

+ func (ss *ShadowSocks) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (ss *ShadowSocks) DialContextWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.Conn, err error)

+ func (ss *ShadowSocks) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.PacketConn, error)

+ func (ss *ShadowSocks) ListenPacketOnStreamConn(ctx context.Context, c net.Conn, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (ss *ShadowSocks) ListenPacketWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (ss *ShadowSocks) StreamConnContext(ctx context.Context, c net.Conn, metadata *C.Metadata) (net.Conn, error)

+ func (ss *ShadowSocks) SupportUOT() bool

+ func (ss *ShadowSocks) SupportWithDialer() C.NetWork

+ type ShadowSocksOption struct

+ Cipher string

+ ClientFingerprint string

+ Name string

+ Password string

+ Plugin string

+ PluginOpts map[string]any

+ Port int

+ Server string

+ UDP bool

+ UDPOverTCP bool

+ UDPOverTCPVersion int

+ type ShadowSocksR struct

+ func NewShadowSocksR(option ShadowSocksROption) (*ShadowSocksR, error)

+ func (ssr *ShadowSocksR) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (ssr *ShadowSocksR) DialContextWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.Conn, err error)

+ func (ssr *ShadowSocksR) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.PacketConn, error)

+ func (ssr *ShadowSocksR) ListenPacketWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (ssr *ShadowSocksR) StreamConnContext(ctx context.Context, c net.Conn, metadata *C.Metadata) (net.Conn, error)

+ func (ssr *ShadowSocksR) SupportWithDialer() C.NetWork

+ type ShadowSocksROption struct

+ Cipher string

+ Name string

+ Obfs string

+ ObfsParam string

+ Password string

+ Port int

+ Protocol string

+ ProtocolParam string

+ Server string

+ UDP bool

+ type SingMux struct

+ func (s *SingMux) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (s *SingMux) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.PacketConn, err error)

+ func (s *SingMux) SupportUDP() bool

+ func (s *SingMux) SupportUOT() bool

+ type SingMuxOption struct

+ BrutalOpts BrutalOption

+ Enabled bool

+ MaxConnections int

+ MaxStreams int

+ MinStreams int

+ OnlyTcp bool

+ Padding bool

+ Protocol string

+ Statistic bool

+ type Snell struct

+ func NewSnell(option SnellOption) (*Snell, error)

+ func (s *Snell) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (s *Snell) DialContextWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.Conn, err error)

+ func (s *Snell) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.PacketConn, error)

+ func (s *Snell) ListenPacketWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (C.PacketConn, error)

+ func (s *Snell) StreamConnContext(ctx context.Context, c net.Conn, metadata *C.Metadata) (net.Conn, error)

+ func (s *Snell) SupportUOT() bool

+ func (s *Snell) SupportWithDialer() C.NetWork

+ type SnellOption struct

+ Name string

+ ObfsOpts map[string]any

+ Port int

+ Psk string

+ Server string

+ UDP bool

+ Version int

+ type Socks5 struct

+ func NewSocks5(option Socks5Option) (*Socks5, error)

+ func (ss *Socks5) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (ss *Socks5) DialContextWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.Conn, err error)

+ func (ss *Socks5) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.PacketConn, err error)

+ func (ss *Socks5) StreamConnContext(ctx context.Context, c net.Conn, metadata *C.Metadata) (net.Conn, error)

+ func (ss *Socks5) SupportWithDialer() C.NetWork

+ type Socks5Option struct

+ Fingerprint string

+ Name string

+ Password string

+ Port int

+ Server string

+ SkipCertVerify bool

+ TLS bool

+ UDP bool

+ UserName string

+ type Ssh struct

+ func NewSsh(option SshOption) (*Ssh, error)

+ func (s *Ssh) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ type SshOption struct

+ HostKey []string

+ HostKeyAlgorithms []string

+ Name string

+ Password string

+ Port int

+ PrivateKey string

+ PrivateKeyPassphrase string

+ Server string

+ UserName string

+ type Trojan struct

+ func NewTrojan(option TrojanOption) (*Trojan, error)

+ func (t *Trojan) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (t *Trojan) DialContextWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.Conn, err error)

+ func (t *Trojan) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.PacketConn, err error)

+ func (t *Trojan) ListenPacketOnStreamConn(c net.Conn, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (t *Trojan) ListenPacketWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (t *Trojan) StreamConnContext(ctx context.Context, c net.Conn, metadata *C.Metadata) (net.Conn, error)

+ func (t *Trojan) SupportUOT() bool

+ func (t *Trojan) SupportWithDialer() C.NetWork

+ type TrojanOption struct

+ ALPN []string

+ ClientFingerprint string

+ Fingerprint string

+ GrpcOpts GrpcOptions

+ Name string

+ Network string

+ Password string

+ Port int

+ RealityOpts RealityOptions

+ SNI string

+ Server string

+ SkipCertVerify bool

+ UDP bool

+ WSOpts WSOptions

+ type Tuic struct

+ func NewTuic(option TuicOption) (*Tuic, error)

+ func (t *Tuic) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.Conn, error)

+ func (t *Tuic) DialContextWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (C.Conn, error)

+ func (t *Tuic) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.PacketConn, err error)

+ func (t *Tuic) ListenPacketWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (t *Tuic) SupportWithDialer() C.NetWork

+ type TuicOption struct

+ ALPN []string

+ CWND int

+ CongestionController string

+ CustomCA string

+ CustomCAString string

+ DisableMTUDiscovery bool

+ DisableSni bool

+ FastOpen bool

+ Fingerprint string

+ HeartbeatInterval int

+ Ip string

+ MaxDatagramFrameSize int

+ MaxOpenStreams int

+ MaxUdpRelayPacketSize int

+ Name string

+ Password string

+ Port int

+ ReceiveWindow int

+ ReceiveWindowConn int

+ ReduceRtt bool

+ RequestTimeout int

+ SNI string

+ Server string

+ SkipCertVerify bool

+ Token string

+ UDPOverStream bool

+ UDPOverStreamVersion int

+ UUID string

+ UdpRelayMode string

+ type Vless struct

+ func NewVless(option VlessOption) (*Vless, error)

+ func (v *Vless) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (v *Vless) DialContextWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.Conn, err error)

+ func (v *Vless) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.PacketConn, err error)

+ func (v *Vless) ListenPacketOnStreamConn(ctx context.Context, c net.Conn, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (v *Vless) ListenPacketWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (v *Vless) StreamConnContext(ctx context.Context, c net.Conn, metadata *C.Metadata) (net.Conn, error)

+ func (v *Vless) SupportUOT() bool

+ func (v *Vless) SupportWithDialer() C.NetWork

+ type VlessOption struct

+ ALPN []string

+ ClientFingerprint string

+ Fingerprint string

+ Flow string

+ GrpcOpts GrpcOptions

+ HTTP2Opts HTTP2Options

+ HTTPOpts HTTPOptions

+ Name string

+ Network string

+ PacketAddr bool

+ PacketEncoding string

+ Port int

+ RealityOpts RealityOptions

+ Server string

+ ServerName string

+ SkipCertVerify bool

+ TLS bool

+ UDP bool

+ UUID string

+ WSHeaders map[string]string

+ WSOpts WSOptions

+ WSPath string

+ XUDP bool

+ type Vmess struct

+ func NewVmess(option VmessOption) (*Vmess, error)

+ func (v *Vmess) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (v *Vmess) DialContextWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.Conn, err error)

+ func (v *Vmess) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.PacketConn, err error)

+ func (v *Vmess) ListenPacketOnStreamConn(ctx context.Context, c net.Conn, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (v *Vmess) ListenPacketWithDialer(ctx context.Context, dialer C.Dialer, metadata *C.Metadata) (_ C.PacketConn, err error)

+ func (v *Vmess) StreamConnContext(ctx context.Context, c net.Conn, metadata *C.Metadata) (net.Conn, error)

+ func (v *Vmess) SupportUOT() bool

+ func (v *Vmess) SupportWithDialer() C.NetWork

+ type VmessOption struct

+ ALPN []string

+ AlterID int

+ AuthenticatedLength bool

+ Cipher string

+ ClientFingerprint string

+ Fingerprint string

+ GlobalPadding bool

+ GrpcOpts GrpcOptions

+ HTTP2Opts HTTP2Options

+ HTTPOpts HTTPOptions

+ Name string

+ Network string

+ PacketAddr bool

+ PacketEncoding string

+ Port int

+ RealityOpts RealityOptions

+ Server string

+ ServerName string

+ SkipCertVerify bool

+ TLS bool

+ UDP bool

+ UUID string

+ WSOpts WSOptions

+ XUDP bool

+ type WSOptions struct

+ EarlyDataHeaderName string

+ Headers map[string]string

+ MaxEarlyData int

+ Path string

+ V2rayHttpUpgrade bool

+ V2rayHttpUpgradeFastOpen bool

+ type WireGuard struct

+ func NewWireGuard(option WireGuardOption) (*WireGuard, error)

+ func (w *WireGuard) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.Conn, err error)

+ func (w *WireGuard) IsL3Protocol(metadata *C.Metadata) bool

+ func (w *WireGuard) ListenPacketContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (_ C.PacketConn, err error)

+ type WireGuardOption struct

+ Dns []string

+ Ip string

+ Ipv6 string

+ MTU int

+ Name string

+ Peers []WireGuardPeerOption

+ PersistentKeepalive int

+ PrivateKey string

+ RemoteDnsResolve bool

+ UDP bool

+ Workers int

+ func (option WireGuardOption) Prefixes() ([]netip.Prefix, error)

+ type WireGuardPeerOption struct

+ AllowedIPs []string

+ Port int

+ PreSharedKey string

+ PublicKey string

+ Reserved []uint8

+ Server string

+ func (option WireGuardPeerOption) Addr() M.Socksaddr