summaryrefslogtreecommitdiffstats
path: root/ext/socket/socket.c
diff options
context:
space:
mode:
authormatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-09-26 23:31:35 +0000
committermatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-09-26 23:31:35 +0000
commit2df8336d32025160fe28d5d4f94c73b342b60f1c (patch)
treea1f627e53bea730f38143ce50ec691f89d3e51d8 /ext/socket/socket.c
parent120cfb2bb54ceb7567cb375b7a48dd55ea2fe4f5 (diff)
downloadruby-2df8336d32025160fe28d5d4f94c73b342b60f1c.tar.gz
ruby-2df8336d32025160fe28d5d4f94c73b342b60f1c.tar.xz
ruby-2df8336d32025160fe28d5d4f94c73b342b60f1c.zip
socket.c: a rdoc patch from Daniel Berger <djberg96 at gmail.com>
git-svn-id: http://svn.ruby-lang.org/repos/ruby/branches/ruby_1_8@11039 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/socket/socket.c')
-rw-r--r--ext/socket/socket.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/ext/socket/socket.c b/ext/socket/socket.c
index d42ca3723..b09d5d4f0 100644
--- a/ext/socket/socket.c
+++ b/ext/socket/socket.c
@@ -1278,6 +1278,14 @@ init_inetsock(sock, remote_host, remote_serv, local_host, local_serv, type)
inetsock_cleanup, (VALUE)&arg);
}
+/*
+ * call-seq:
+ * TCPSocket.new(remote_host, remote_port, local_host=nil, local_port=nil)
+ *
+ * Opens a TCP connection to +remote_host+ on +remote_port+. If +local_host+
+ * and +local_port+ are specified, then those parameters are used on the local
+ * end to establish the connection.
+ */
static VALUE
tcp_init(argc, argv, sock)
int argc;