raindrops RubyGem user+dev discussion/patches/pulls/bugs/help
 help / color / mirror / code / Atom feed
From: Eric Wong <e@80x24.org>
To: raindrops-public@bogomips.org
Subject: [PATCH] TCP_Info: custom documentation for #get!
Date: Wed,  1 Mar 2017 02:55:46 +0000	[thread overview]
Message-ID: <20170301025546.26233-1-e@80x24.org> (raw)

While #get! is the same as the #initialize method,
the former is public and called explicitly by folks
wishing to reduce allocation overhead.
 ext/raindrops/linux_tcp_info.c | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/ext/raindrops/linux_tcp_info.c b/ext/raindrops/linux_tcp_info.c
index eebca94..4693e47 100644
--- a/ext/raindrops/linux_tcp_info.c
+++ b/ext/raindrops/linux_tcp_info.c
@@ -131,6 +131,19 @@ void Init_raindrops_linux_tcp_info(void)
 	cTCP_Info = rb_define_class_under(cRaindrops, "TCP_Info", rb_cObject);
 	rb_define_alloc_func(cTCP_Info, alloc);
 	rb_define_private_method(cTCP_Info, "initialize", init, 1);
+	/*
+	 * Document-method: Raindrops::TCP_Info#get!
+	 *
+	 * call-seq:
+	 *
+	 *	info = Raindrops::TCP_Info.new(tcp_socket)
+	 *	info.get!(tcp_socket)
+	 *
+	 * Update an existing TCP_Info objects with the latest stats
+	 * from the given socket.  This even allows sharing TCP_Info
+	 * objects between different sockets to avoid garbage.
+	 */
 	rb_define_method(cTCP_Info, "get!", init, 1);
 #define TCPI_DEFINE_METHOD(x) \

                 reply	other threads:[~2017-03-01  2:55 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information: http://yhbt.net/raindrops/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170301025546.26233-1-e@80x24.org \
    --to=e@80x24.org \
    --cc=raindrops-public@bogomips.org \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox


This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).