about summary refs log tree commit homepage
path: root/ext/kgio/accept.c
diff options
context:
space:
mode:
Diffstat (limited to 'ext/kgio/accept.c')
-rw-r--r--ext/kgio/accept.c13
1 files changed, 13 insertions, 0 deletions
diff --git a/ext/kgio/accept.c b/ext/kgio/accept.c
index 479a606..902145c 100644
--- a/ext/kgio/accept.c
+++ b/ext/kgio/accept.c
@@ -453,13 +453,26 @@ void init_kgio_accept(void)
         rb_define_singleton_method(mKgio, "accept_class=", set_accepted, 1);
         rb_define_singleton_method(mKgio, "accept_class", get_accepted, 0);
 
+        /*
+         * Document-class: Kgio::UNIXServer
+         *
+         * Kgio::UNIXServer should be used in place of the plain UNIXServer
+         * when kgio_accept and kgio_tryaccept methods are needed.
+         */
         cUNIXServer = rb_const_get(rb_cObject, rb_intern("UNIXServer"));
         cUNIXServer = rb_define_class_under(mKgio, "UNIXServer", cUNIXServer);
         rb_define_method(cUNIXServer, "kgio_tryaccept", unix_tryaccept, -1);
         rb_define_method(cUNIXServer, "kgio_accept", unix_accept, -1);
 
+        /*
+         * Document-class: Kgio::TCPServer
+         *
+         * Kgio::TCPServer should be used in place of the plain TCPServer
+         * when kgio_accept and kgio_tryaccept methods are needed.
+         */
         cTCPServer = rb_const_get(rb_cObject, rb_intern("TCPServer"));
         cTCPServer = rb_define_class_under(mKgio, "TCPServer", cTCPServer);
+
         rb_define_method(cTCPServer, "kgio_tryaccept", tcp_tryaccept, -1);
         rb_define_method(cTCPServer, "kgio_accept", tcp_accept, -1);
         init_sock_for_fd();