shadowsocks

v0.5.2

shadowsocks v0.5.2 Shadowsocks View Source

The Shadowsocks.

This module defines common apis to start,update,stop shadowsocks listeners.

start a listener 

Shadowsocks.start(args)

the args is a keyword list, fields:

  • type required atom - the connection type, :client or :server or custom module name
  • port required integer - listen port
  • ip optional tuple - listen ip, example: {127,0,0,1}
  • method optional string - encode method, default: "rc4-md5"
  • password required string - encode password
  • ota optional bool - is force open one time auth, default: false
  • server optional tuple - required if type is :client, example: {"la.ss.org", 8388}

stop a listener 

Shadowsocks.stop(port)

stop listener by listen port, always return :ok

update listener args 

Shadowsocks.update(port, args)

the args is a keyword list, see Shadowsocks.start/1 method

Link to this section Summary

Functions

get(port)

get listener pid

running?(port)

check port is running

start(args)

start a listener

stop(port)

stop a listener

update(port, args)

update listener args

Link to this section Functions

Link to this function get(port) View Source

get listener pid

Link to this function running?(port) View Source

check port is running

Link to this function start(args) View Source

start a listener

the args is a keyword list, fields:

  • type required atom - the connection type, :client or :server or custom module name

    There are currently four built-in type:

    1. Shadowsocks.Conn.Client - general client, alias is :client
    2. Shadowsocks.Conn.Server - general server, alias is :server
    3. Shadowsocks.Conn.TransparentClient - transparent client, perfect with iptables
    4. Shadowsocks.Conn.HTTP302 - redirect any http get request to :redirect_url, otherwise drop connections
    5. Shadowsocks.Conn.ObfsServer - simple http obfs server (can both accept http obfs client and original shadowsocks client)

  • port required integer - listen port

  • ip optional tuple - listen ip, example: {127,0,0,1}

  • method optional string - encode method, default: "aes-256-cfb"

  • password required string - encode password

  • ota optional bool - is force open one time auth, default: false

  • server optional tuple - required if type is :client, example: {"la.ss.org", 8388}

Link to this function stop(port) View Source

stop a listener

stop listener by listen port, always return :ok

Link to this function update(port, args) View Source

update listener args

the args is a keyword list, see Shadowsocks.start/1 method