Module: ShadowsocksRuby::Connections

Defined in:
lib/shadowsocks_ruby/connections/connection.rb,
lib/shadowsocks_ruby/connections/client_connection.rb,
lib/shadowsocks_ruby/connections/server_connection.rb,
lib/shadowsocks_ruby/connections/backend_connection.rb,
lib/shadowsocks_ruby/connections/tcp/client_connection.rb,
lib/shadowsocks_ruby/connections/udp/client_connection.rb,
lib/shadowsocks_ruby/connections/tcp/destination_connection.rb,
lib/shadowsocks_ruby/connections/udp/destination_connection.rb,
lib/shadowsocks_ruby/connections/tcp/localbackend_connection.rb,
lib/shadowsocks_ruby/connections/tcp/remoteserver_connection.rb,
lib/shadowsocks_ruby/connections/udp/localbackend_connection.rb,
lib/shadowsocks_ruby/connections/udp/remoteserver_connection.rb

Overview

This module contains various functionality code to be mixed-in with EventMachine::Connection when Connection object is instantiated.

There are 4 kinds of connection: client, local backend, remote server and destination. Which are demonstrated below:

             -------------------------------------------       -------------------------------------------------
             |                                         |       |                                               |
Client <---> |ClientConnection -- RemoteServerConnecton| <---> |LocalBackendConnection -- DestinationConnection| <---> Destination
        net  |           Shadowsocks Client            |  net  |               Shadowsocks Server              |  net
             -------------------------------------------       -------------------------------------------------

Defined Under Namespace

Modules: TCP, UDP Classes: BackendConnection, ClientConnection, Connection, ServerConnection