lib/ronin/network/tcp/proxy.rb in ronin-support-0.5.0.rc2 vs lib/ronin/network/tcp/proxy.rb in ronin-support-0.5.0

@@ -25,9 +25,49 @@
   module Network
     module TCP
       #
       # The TCP Proxy allows for inspecting and manipulating TCP protocols.
       #
+      # ## Example
+      # 
+      #     require 'ronin/network/tcp/proxy'
+      #     require 'hexdump'
+      #
+      #     Ronin::Network::TCP::Proxy.start(:port => 1337, :server => ['www.wired.com', 80]) do |proxy|
+      #       address = lambda { |socket|
+      #         addrinfo = socket.peeraddr
+      #
+      #        "#{addrinfo[3]}:#{addrinfo[1]}"
+      #       }
+      #       hex = Hexdump::Dumper.new
+      #
+      #       proxy.on_client_data do |client,server,data|
+      #         puts "#{address[client]} -> #{proxy}"
+      #         hex.dump(data)
+      #       end
+      #
+      #       proxy.on_client_connect do |client|
+      #         puts "#{address[client]} -> #{proxy} [connected]"
+      #       end
+      #
+      #       proxy.on_client_disconnect do |client,server|
+      #         puts "#{address[client]} <- #{proxy} [disconnected]"
+      #       end
+      #
+      #       proxy.on_server_data do |client,server,data|
+      #         puts "#{address[client]} <- #{proxy}"
+      #         hex.dump(data)
+      #       end
+      #
+      #       proxy.on_server_connect do |client,server|
+      #         puts "#{address[client]} <- #{proxy} [connected]"
+      #       end
+      #
+      #       proxy.on_server_disconnect do |client,server|
+      #         puts "#{address[client]} <- #{proxy} [disconnected]"
+      #       end
+      #     end
+      #
       # ## Callbacks
       #
       # In addition to the events supported by the {Network::Proxy Proxy}
       # base class, the TCP Proxy also supports the following callbacks.
       #