ss

Documentation

Index

• Variables
• func SetLog(debug, info, err *log.Logger)
• type Dialer
• type Manager
  • func NewManager(minPort, maxPort int) *Manager
  • func (m *Manager) Add(port int, method, password string, opts ...OptionHandler) (*SS, error)
  • func (m *Manager) Del(port int) error
  • func (m *Manager) Get(port int) (*SS, error)
  • func (m *Manager) GetAll() []*SS
  • func (m *Manager) GetAllByMethod(method string) []*SS
  • func (m *Manager) SetHost(host string)
• type Option
• type OptionHandler
  • func WithRateLimit(send, recv uint64) OptionHandler
• type SS
  • func NewSS(server string, port int, method, password string, dialer Dialer) *SS
  • func (ss *SS) ExportJson() []byte
  • func (ss *SS) ExportURL() string
  • func (ss *SS) RunTCP() error
  • func (ss *SS) RunUDP() error
  • func (ss *SS) SetRatelimit(tRate, rRate float64, tBurst, rBurst int64)
  • func (ss *SS) StopTCP() error
  • func (ss *SS) StopUDP() error
• type SSOption
• type SSOptionHandler

Variables

var (
	Debug *log.Logger
	Info  *log.Logger
	Error *log.Logger
)

Functions

func SetLog

func SetLog(debug, info, err *log.Logger)

Types

type Dialer

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

type Manager

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

func NewManager

func NewManager(minPort, maxPort int) *Manager

func (*Manager) Add

func (m *Manager) Add(port int, method, password string, opts ...OptionHandler) (*SS, error)

func (*Manager) Del

func (m *Manager) Del(port int) error

Del delete ss by port

func (*Manager) Get

func (m *Manager) Get(port int) (*SS, error)

func (*Manager) GetAll

func (m *Manager) GetAll() []*SS

GetAll get all ss

func (*Manager) GetAllByMethod

func (m *Manager) GetAllByMethod(method string) []*SS

GetAllByMethod get all ss by method

func (*Manager) SetHost

func (m *Manager) SetHost(host string)

SetHost set host

type Option

type Option struct {
	SendRateLimit uint64
	RecvRateLimit uint64
}

type OptionHandler

type OptionHandler func(*Option)

func WithRateLimit

func WithRateLimit(send, recv uint64) OptionHandler

type SS

type SS struct {
	Server   string `json:"server"`
	Port     int    `json:"server_port"`
	Method   string `json:"method"`
	Password string `json:"password"`
	// contains filtered or unexported fields
}

SS is a sadowsocks instance manager

func NewSS

func NewSS(server string, port int, method, password string, dialer Dialer) *SS

NewSS return a new SS pointer

func (*SS) ExportJson

func (ss *SS) ExportJson() []byte

ExportJson export ss server info to json

func (*SS) ExportURL

func (ss *SS) ExportURL() string

ExportURL export ss server info to url

func (*SS) RunTCP

func (ss *SS) RunTCP() error

RunTCP run ss server on tcp, use localAddr as source ip

func (*SS) RunUDP

func (ss *SS) RunUDP() error

RunUDP Listen on addr for encrypted packets and basically do UDP NAT.

func (*SS) SetRatelimit

func (ss *SS) SetRatelimit(tRate, rRate float64, tBurst, rBurst int64)

func (*SS) StopTCP

func (ss *SS) StopTCP() error

StopTCP stop ss server on tcp

func (*SS) StopUDP

func (ss *SS) StopUDP() error

type SSOption

type SSOption struct {
	EnableBlocklist      bool
	Blocklist            map[string]bool
	EnableTrafficControl bool
	TxBucket             *rate.Limiter
	RxBucket             *rate.Limiter
	EnablePeeper         bool
	Dialer               Dialer
}

type SSOptionHandler

type SSOptionHandler func(*SSOption)