metasploit-framework

https://github.com/rapid7/metasploit-framework

Ruby

Metasploit Framework

RbMysql::Protocol#initialize

make socket connection to server.
=== Argument
host :: [String] if "localhost" or "" nil then use UNIXSocket. Otherwise use TCPSocket
port :: [Integer] port number using by TCPSocket
socket :: [String] socket file name using by UNIXSocket
conn_timeout :: [Integer] connect timeout (sec).
read_timeout :: [Integer] read timeout (sec).
write_timeout :: [Integer] write timeout (sec).

Source | Google | Stack overflow

Edit

git clone [email protected]:rapid7/metasploit-framework.git

cd metasploit-framework

open lib/rbmysql/protocol.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-RbMysql--Protocol-initialize-for-pr

# Commit to git

git add lib/rbmysql/protocol.rbgit commit -m "better docs for RbMysql::Protocol#initialize"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-RbMysql--Protocol-initialize-for-pr

hub pull-request

# Celebrate!