socket-keepalive 0.1.0

data/README

@@ -0,0 +1,21 @@
+= socket-keepalive
+
+== Description
+
+TCP Keepalive extension for Ruby
+
+== Install
+
+gem install socket-keepalive
+
+== Example
+
+  require 'socket'
+  require 'socket/keepalive'
+  
+  s = TCPSocket.open('localhost', 7)
+  
+  s.keepalive = true
+  s.keepidle = 15
+  s.keepintvl = 5
+  s.keepcnt = 3

data/ext/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+$CFLAGS += " -Wall "
+create_makefile('socket_keepalive')

data/ext/socket_keepalive.c

@@ -0,0 +1,188 @@
+#include "socket_keepalive.h"
+
+static VALUE rb_mSocketKeepalive;
+static VALUE rb_eSocketKeepaliveError;
+
+/* get SO_KEEPALIVE */
+static VALUE rb_sk_get_keepalive(VALUE self, VALUE vSockfd) {
+  int sockfd, optval, rv;
+  socklen_t optlen;
+
+  sockfd = NUM2INT(vSockfd);
+
+  optlen = sizeof(optval);
+  rv = getsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, (void*) &optval, &optlen);
+
+  if (rv != 0) { 
+    rb_raise(rb_eSocketKeepaliveError, "%s", strerror(errno));
+  }
+
+  return(optval ? Qtrue : Qfalse);
+}
+
+/* set SO_KEEPALIVE */
+static VALUE rb_sk_set_keepalive(VALUE self, VALUE vSockfd, VALUE vOptval) {
+  int sockfd, optval, rv;
+  const char *classname;
+
+  sockfd = NUM2INT(vSockfd);
+
+  switch (TYPE(vOptval)) {
+  case T_TRUE:
+    optval = 1;
+    break;
+  case T_FALSE:
+    optval = 0;
+    break;
+  default:
+    classname = rb_class2name(CLASS_OF(vOptval));
+    rb_raise(rb_eTypeError, "wrong argument type %s (expected TrueClass or FalseClass)", classname);
+    break;
+  }
+
+  rv = setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, (void*) &optval, sizeof(optval));
+
+  if (rv != 0) { 
+    rb_raise(rb_eSocketKeepaliveError, "%s", strerror(errno));
+  }
+
+  return Qnil;
+}
+
+/* get TCP_KEEPIDLE */
+static VALUE rb_sk_get_keepidle(VALUE self, VALUE vSockfd) {
+#ifdef TCP_KEEPIDLE
+  int sockfd, optval, rv;
+  socklen_t optlen;
+
+  sockfd = NUM2INT(vSockfd);
+
+  optlen = sizeof(optval);
+  rv = getsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, (void*) &optval, &optlen);
+
+  if (rv != 0) { 
+    rb_raise(rb_eSocketKeepaliveError, "%s", strerror(errno));
+  }
+
+  return INT2NUM(optval);
+#else
+  return Qnil;
+#endif
+}
+
+/* set TCP_KEEPIDLE */
+static VALUE rb_sk_set_keepidle(VALUE self, VALUE vSockfd, VALUE vOptval) {
+#ifdef TCP_KEEPIDLE
+  int sockfd, optval, rv;
+
+  sockfd = NUM2INT(vSockfd);
+  optval = NUM2INT(vOptval);
+
+  rv = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, (void*) &optval, sizeof(optval));
+
+  if (rv != 0) { 
+    rb_raise(rb_eSocketKeepaliveError, "%s", strerror(errno));
+  }
+#endif
+
+  return Qnil;
+}
+
+/* get TCP_KEEPINTVL */
+static VALUE rb_sk_get_keepintvl(VALUE self, VALUE vSockfd) {
+#ifdef TCP_KEEPINTVL
+  int sockfd, optval, rv;
+  socklen_t optlen;
+
+  sockfd = NUM2INT(vSockfd);
+
+  optlen = sizeof(optval);
+  rv = getsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL, (void*) &optval, &optlen);
+
+  if (rv != 0) { 
+    rb_raise(rb_eSocketKeepaliveError, "%s", strerror(errno));
+  }
+
+  return INT2NUM(optval);
+#else
+  return Qnil;
+#endif
+}
+
+/* set TCP_KEEPINTVL */
+static VALUE rb_sk_set_keepintvl(VALUE self, VALUE vSockfd, VALUE vOptval) {
+#ifdef TCP_KEEPINTVL
+  int sockfd, optval, rv;
+
+  sockfd = NUM2INT(vSockfd);
+  optval = NUM2INT(vOptval);
+
+  rv = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL, (void*) &optval, sizeof(optval));
+
+  if (rv != 0) { 
+    rb_raise(rb_eSocketKeepaliveError, "%s", strerror(errno));
+  }
+#endif
+
+  return Qnil;
+}
+
+/* get TCP_KEEPCNT */
+static VALUE rb_sk_get_keepcnt(VALUE self, VALUE vSockfd) {
+#ifdef TCP_KEEPCNT
+  int sockfd, optval, rv;
+  socklen_t optlen;
+
+  sockfd = NUM2INT(vSockfd);
+
+  optlen = sizeof(optval);
+  rv = getsockopt(sockfd, IPPROTO_TCP, TCP_KEEPCNT, (void*) &optval, &optlen);
+
+  if (rv != 0) { 
+    rb_raise(rb_eSocketKeepaliveError, "%s", strerror(errno));
+  }
+
+  return INT2NUM(optval);
+#else
+  return Qnil;
+#endif
+}
+
+/* set TCP_KEEPCNT */
+static VALUE rb_sk_set_keepcnt(VALUE self, VALUE vSockfd, VALUE vOptval) {
+#ifdef TCP_KEEPCNT
+  int sockfd, optval, rv;
+
+  sockfd = NUM2INT(vSockfd);
+  optval = NUM2INT(vOptval);
+
+  rv = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPCNT, (void*) &optval, sizeof(optval));
+
+  if (rv != 0) { 
+    rb_raise(rb_eSocketKeepaliveError, "%s", strerror(errno));
+  }
+
+  return Qnil;
+#endif
+}
+
+void Init_socket_keepalive() {
+  rb_mSocketKeepalive = rb_define_module("SocketKeepalive");
+  rb_eSocketKeepaliveError = rb_define_class_under(rb_mSocketKeepalive, "Error", rb_eStandardError);
+
+  // TCP_KEEPIDLE
+  rb_define_module_function(rb_mSocketKeepalive, "get_keepalive", rb_sk_get_keepalive, 1);
+  rb_define_module_function(rb_mSocketKeepalive, "set_keepalive", rb_sk_set_keepalive, 2);
+
+  // TCP_KEEPIDLE
+  rb_define_module_function(rb_mSocketKeepalive, "get_keepidle", rb_sk_get_keepidle, 1);
+  rb_define_module_function(rb_mSocketKeepalive, "set_keepidle", rb_sk_set_keepidle, 2);
+
+  // TCP_KEEPINTVL
+  rb_define_module_function(rb_mSocketKeepalive, "get_keepintvl", rb_sk_get_keepintvl, 1);
+  rb_define_module_function(rb_mSocketKeepalive, "set_keepintvl", rb_sk_set_keepintvl, 2);
+
+  // TCP_KEEPCNT
+  rb_define_module_function(rb_mSocketKeepalive, "get_keepcnt", rb_sk_get_keepcnt, 1);
+  rb_define_module_function(rb_mSocketKeepalive, "set_keepcnt", rb_sk_set_keepcnt, 2);
+}

data/ext/socket_keepalive.h

@@ -0,0 +1,18 @@
+#ifndef __SOCKET_KEEPALIVE_H__
+#define __SOCKET_KEEPALIVE_H__
+
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <netinet/in.h>
+#include <netinet/tcp.h>
+#include <errno.h>
+#include <ruby.h>
+
+#ifndef RSTRING_PTR
+#define RSTRING_PTR(s) (RSTRING(s)->ptr)
+#endif
+#ifndef RSTRING_LEN
+#define RSTRING_LEN(s) (RSTRING(s)->len)
+#endif
+
+#endif // __SOCKET_KEEPALIVE_H__

data/lib/socket/keepalive.rb

@@ -0,0 +1,36 @@
+require 'socket'
+require 'socket_keepalive'
+
+class TCPSocket
+  def keepalive
+    SocketKeepalive.get_keepalive(self.fileno)
+  end
+
+  def keepalive=(optval)
+    SocketKeepalive.set_keepalive(self.fileno, optval)
+  end
+
+  def keepidle
+    SocketKeepalive.get_keepidle(self.fileno)
+  end
+
+  def keepidle=(optval)
+    SocketKeepalive.set_keepidle(self.fileno, optval)
+  end
+
+  def keepintvl
+    SocketKeepalive.get_keepintvl(self.fileno)
+  end
+
+  def keepintvl=(optval)
+    SocketKeepalive.set_keepintvl(self.fileno, optval)
+  end
+
+  def keepcnt
+    SocketKeepalive.get_keepcnt(self.fileno)
+  end
+
+  def keepcnt=(optval)
+    SocketKeepalive.set_keepcnt(self.fileno, optval)
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: socket-keepalive
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- winebarrel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-08 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: TCP Keepalive extension for Ruby. see tcp(7). (Linux only)
+email: sgwr_dts@yahoo.co.jp
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- ext/socket_keepalive.c
+- ext/socket_keepalive.h
+- ext/extconf.rb
+- README
+- lib/socket/keepalive.rb
+has_rdoc: true
+homepage: https://bitbucket.org/winebarrel/socket-keepalive
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: TCP Keepalive extension for Ruby
+test_files: []
+