* [PATCH] doc: document Raindrops::TCP hash
@ 2017-03-23 2:44 Eric Wong
0 siblings, 0 replies; only message in thread
From: Eric Wong @ 2017-03-23 2:44 UTC (permalink / raw)
To: raindrops-public
This is part of the stable API, so we shall document it for
others to use.
---
ext/raindrops/tcp_info.c | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/ext/raindrops/tcp_info.c b/ext/raindrops/tcp_info.c
index 3e241a1..42d013b 100644
--- a/ext/raindrops/tcp_info.c
+++ b/ext/raindrops/tcp_info.c
@@ -101,6 +101,10 @@ void Init_raindrops_tcp_info(void)
* are defined corresponding to the "tcpi_" fields in the
* tcp_info struct.
*
+ * As of raindrops 0.18.0+, this is supported on FreeBSD and OpenBSD
+ * systems as well as Linux, although not all fields exist or
+ * match the documentation, below.
+ *
* In particular, the +last_data_recv+ field is useful for measuring
* the amount of time a client spent in the listen queue before
* +accept()+, but only if +TCP_DEFER_ACCEPT+ is used with the
@@ -193,6 +197,32 @@ void Init_raindrops_tcp_info(void)
DEFINE_METHOD_tcp_info_tcpi_total_retrans;
#ifdef RAINDROPS_TCP_STATES_ALL_KNOWN
+
+ /*
+ * Document-const: Raindrops::TCP
+ *
+ * This is a frozen hash storing the numeric values
+ * maps platform-independent symbol keys to
+ * platform-dependent numeric values. These states
+ * are all valid values for the Raindrops::TCP_Info#state field.
+ *
+ * The platform-independent names of the keys in this hash are:
+ *
+ * - :ESTABLISHED
+ * - :SYN_SENT
+ * - :SYN_RECV
+ * - :FIN_WAIT1
+ * - :FIN_WAIT2
+ * - :TIME_WAIT
+ * - :CLOSE
+ * - :CLOSE_WAIT
+ * - :LAST_ACK
+ * - :LISTEN
+ * - :CLOSING
+ *
+ * This is only supported on platforms where TCP_Info is supported,
+ * currently FreeBSD, OpenBSD, and Linux-based systems.
+ */
{
#define TCPSET(n,v) rb_hash_aset(tcp, ID2SYM(rb_intern(#n)), INT2NUM(v))
VALUE tcp = rb_hash_new();
--
EW
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2017-03-23 2:44 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-03-23 2:44 [PATCH] doc: document Raindrops::TCP hash Eric Wong
Code repositories for project(s) associated with this public inbox
https://yhbt.net/raindrops.git/
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).