sctp-socket 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a4c2e587ffc98a2c81d1d2a267fa4936539dc2456a9106a0146f31275e6db21
-  data.tar.gz: e5aa191fd3beb57240128ef58ef82df8f3b6beba3c25a5b357bc9b5effc7c238
+  metadata.gz: a483264dd5712655f641ade00e03177756f25340c2fd398bed3ad453bc6a9cdb
+  data.tar.gz: 719857e2ce3a5db341aa317f23ec0bf2fa674dd9b427b502f99e3515cb786dac
 SHA512:
-  metadata.gz: d023d5c17b03912812d02c8cb58279b5c874c45c481bdc1cd685dd89e8f2d62565512675d2cdc89f5e6b8107dce42634a3a1b4a063df8a6b32fed6762029adb4
-  data.tar.gz: 900e6fb83030d63453d99f9046942b2e6dfaee4340615d668669a922abc5628f58056aa464c9f36fe974ac0cccec4f3699fee7211778b6e49f49d856d7ea002d
+  metadata.gz: 3dd98e9076f37396a55339fa20f1097ab5c582a418d885d8599b320b5cf722acb3c296b8afb798faadbee67519ee9368e87596c60d8658ef35a23a01d76c0d82
+  data.tar.gz: 4c7adf403e6075eb53129e9f4b92a97e3887518afa15458bf8b74fa7765478c54001d5f5f6cd997c2a4e44e1cba8783ee329ff9c3125f62fb9ae87e53c7e06b7

data/CHANGES.md

@@ -1,3 +1,25 @@
+## 0.1.0 - 31-May-2024
+* Added support for sender dry events.
+* Added the get_peer_address_params method.
+* Comments were added to methods that were missing them.
+* Remove version locking for dev dependencies, doesn't matter to me.
+* Bumped version to 0.1.0, I guess I'll declare it stable.
+
+## 0.0.7 - 28-May-2024
+* Added the recvv method.
+* The getlocalnames and getpeernames methods now accept optional fileno and
+  association ID arguments.
+* The peeloff method now returns the peeled off fileno and no longer modifies
+  the receiver, so I dropped the exclamation point from the method name.
+* Added the get_subscriptions method.
+* Changed bind method to bindx and connect method to connectx. I may try to
+  subclass Socket someday so I didn't want a conflict, and this more closely
+  matches the underlying function name anyway.
+* Changed the sock_fd method to fileno.
+* Changed the default backlog from 1024 to 128 for the listen method.
+* Updated comments and documentation.
+* Added more specs.
+
 ## 0.0.6 - 24-May-2024
 * Fixup the sendv method and add some documentation.
 * Added documentation to the get_status method.

data/README.md

@@ -39,7 +39,7 @@ require 'sctp/socket'
 begin
   port = 62324
   socket = SCTP::Socket.new
-  socket.bind(:port => port, :addresses => ['10.0.5.4', '10.0.6.4'])
+  socket.bindx(:port => port, :addresses => ['10.0.5.4', '10.0.6.4'])
   socket.set_initmsg(:output_streams => 5, :input_streams => 5, :max_attempts => 4)
   socket.subscribe(:data_io => true)
   socket.listen

data/examples/client_example.rb

@@ -10,10 +10,11 @@ begin
   socket = SCTP::Socket.new
 
   # Optional, but could bind to a subset of available addresses
-  p socket.bind(:addresses => addresses)
+  p socket.bindx(:addresses => addresses)
 
   # Initial connection
-  p socket.connect(:addresses => addresses, :port => port)
+  p socket.connectx(:addresses => addresses, :port => port)
+  p socket.get_status
 
   # Try a sendv
   p socket.sendv(:message => ["Hello ", "World!"])

data/examples/server_example.rb

@@ -23,7 +23,7 @@ addresses = ['1.1.1.1', '1.1.1.2']
 begin
   port = 62324
   socket = SCTP::Socket.new
-  socket.bind(:port => port, :addresses => addresses)
+  socket.bindx(:port => port, :addresses => addresses)
   socket.set_initmsg(:output_streams => 5, :input_streams => 5, :max_attempts => 4)
   socket.subscribe(:data_io => true, :shutdown => true, :send_failure => true, :partial_delivery => true)
   socket.listen

data/ext/sctp/extconf.rb

@@ -26,5 +26,6 @@ end
 
 have_library('sctp')
 have_func('sctp_sendv', 'netinet/sctp.h')
+have_func('sctp_recvv', 'netinet/sctp.h')
 have_struct_member('struct sctp_event_subscribe', 'sctp_send_failure_event', 'netinet/sctp.h')
 create_makefile('sctp/socket')

data/ext/sctp/socket.c

@@ -21,6 +21,10 @@ VALUE v_sctp_status_struct;
 VALUE v_sctp_rtoinfo_struct;
 VALUE v_sctp_associnfo_struct;
 VALUE v_sctp_default_send_params_struct;
+VALUE v_sctp_event_subscribe_struct;
+VALUE v_sctp_receive_info_struct;
+VALUE v_sctp_peer_addr_params_struct;
+VALUE v_sender_dry_event_struct;
 
 #if !defined(IOV_MAX)
 #if defined(_SC_IOV_MAX)
@@ -77,7 +81,7 @@ VALUE rb_hash_aref2(VALUE v_hash, const char* key){
  *   socket2 = SCTP::Socket.new(Socket::AF_INET, Socket::SOCK_STREAM)
  */
 static VALUE rsctp_init(int argc, VALUE* argv, VALUE self){
-  int sock_fd;
+  int fileno;
   VALUE v_domain, v_type;
 
   rb_scan_args(argc, argv, "02", &v_domain, &v_type);
@@ -88,14 +92,14 @@ static VALUE rsctp_init(int argc, VALUE* argv, VALUE self){
   if(NIL_P(v_type))
     v_type = INT2NUM(SOCK_SEQPACKET);
 
-  sock_fd = socket(NUM2INT(v_domain), NUM2INT(v_type), IPPROTO_SCTP);
+  fileno = socket(NUM2INT(v_domain), NUM2INT(v_type), IPPROTO_SCTP);
 
-  if(sock_fd < 0)
+  if(fileno < 0)
     rb_raise(rb_eSystemCallError, "socket: %s", strerror(errno));
 
   rb_iv_set(self, "@domain", v_domain);
   rb_iv_set(self, "@type", v_type);
-  rb_iv_set(self, "@sock_fd", INT2NUM(sock_fd));
+  rb_iv_set(self, "@fileno", INT2NUM(fileno));
   rb_iv_set(self, "@association_id", INT2NUM(0));
 
   return self;
@@ -114,19 +118,19 @@ static VALUE rsctp_init(int argc, VALUE* argv, VALUE self){
  *    socket = SCTP::Socket.new
  *
  *    # Bind 2 addresses
- *    socket.bind(:port => 64325, :addresses => ['10.0.4.5', '10.0.5.5'])
+ *    socket.bindx(:port => 64325, :addresses => ['10.0.4.5', '10.0.5.5'])
  *
  *    # Remove 1 later
- *    socket.bind(:addresses => ['10.0.4.5'], :flags => SCTP::Socket::BINDX_REM_ADDR)
+ *    socket.bindx(:addresses => ['10.0.4.5'], :flags => SCTP::Socket::BINDX_REM_ADDR)
  *
  *  If no addresses are specified, then it will bind to all available interfaces. If
  *  no port is specified, then one will be assigned by the host.
  *
  *  Returns the port that it was bound to.
  */
-static VALUE rsctp_bind(int argc, VALUE* argv, VALUE self){
+static VALUE rsctp_bindx(int argc, VALUE* argv, VALUE self){
   struct sockaddr_in addrs[8];
-  int i, sock_fd, num_ip, flags, domain, port;
+  int i, fileno, num_ip, flags, domain, port;
   VALUE v_addresses, v_port, v_flags, v_address, v_options;
 
   rb_scan_args(argc, argv, "01", &v_options);
@@ -156,7 +160,7 @@ static VALUE rsctp_bind(int argc, VALUE* argv, VALUE self){
     num_ip = RARRAY_LEN(v_addresses);
 
   domain = NUM2INT(rb_iv_get(self, "@domain"));
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
   if(num_ip > 1){
     for(i = 0; i < num_ip; i++){
@@ -172,14 +176,15 @@ static VALUE rsctp_bind(int argc, VALUE* argv, VALUE self){
     addrs[0].sin_addr.s_addr = htonl(INADDR_ANY);
   }
 
-  if(sctp_bindx(sock_fd, (struct sockaddr *) addrs, num_ip, flags) != 0)
+  if(sctp_bindx(fileno, (struct sockaddr *) addrs, num_ip, flags) != 0)
     rb_raise(rb_eSystemCallError, "sctp_bindx: %s", strerror(errno));
 
   if(port == 0){
     struct sockaddr_in sin;
     socklen_t len = sizeof(sin);
+    bzero(&sin, len);
 
-    if(getsockname(sock_fd, (struct sockaddr *)&sin, &len) == -1)
+    if(getsockname(fileno, (struct sockaddr *)&sin, &len) == -1)
       rb_raise(rb_eSystemCallError, "getsockname: %s", strerror(errno));
 
     port = sin.sin_port;
@@ -197,13 +202,13 @@ static VALUE rsctp_bind(int argc, VALUE* argv, VALUE self){
  * Example:
  *
  *   socket = SCTP::Socket.new
- *   socket.connect(:port => 62354, :addresses => ['10.0.4.5', '10.0.5.5'])
+ *   socket.connectx(:port => 62354, :addresses => ['10.0.4.5', '10.0.5.5'])
  *
  * Note that this will also set/update the object's association_id.
  */
-static VALUE rsctp_connect(int argc, VALUE* argv, VALUE self){
+static VALUE rsctp_connectx(int argc, VALUE* argv, VALUE self){
   struct sockaddr_in addrs[8];
-  int i, num_ip, sock_fd;
+  int i, num_ip, fileno;
   sctp_assoc_t assoc;
   VALUE v_address, v_domain, v_options, v_addresses, v_port;
 
@@ -235,9 +240,9 @@ static VALUE rsctp_connect(int argc, VALUE* argv, VALUE self){
     addrs[i].sin_addr.s_addr = inet_addr(StringValueCStr(v_address));
   }
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
-  if(sctp_connectx(sock_fd, (struct sockaddr *) addrs, num_ip, &assoc) < 0)
+  if(sctp_connectx(fileno, (struct sockaddr *) addrs, num_ip, &assoc) < 0)
     rb_raise(rb_eSystemCallError, "sctp_connectx: %s", strerror(errno));
 
   rb_iv_set(self, "@association_id", INT2NUM(assoc));
@@ -254,30 +259,55 @@ static VALUE rsctp_connect(int argc, VALUE* argv, VALUE self){
  *   socket.close
  */
 static VALUE rsctp_close(VALUE self){
-  VALUE v_sock_fd = rb_iv_get(self, "@sock_fd");
+  VALUE v_fileno = rb_iv_get(self, "@fileno");
 
-  if(close(NUM2INT(v_sock_fd)))
+  if(close(NUM2INT(v_fileno)))
     rb_raise(rb_eSystemCallError, "close: %s", strerror(errno));
 
   return self;
 }
 
 /*
- *  Return an array of all addresses of a peer.
+ *  Return an array of all addresses of a peer of the current socket
+ *  and association number.
+ *
+ *  You may optionally pass a assocation fileno and association ID. Typically
+ *  this information would come from the peeloff method.
+ *
+ *  Example:
+ *
+ *    socket = SCTP::Socket.new
+ *    # ...
+ *    p socket.getpeernames
+ *
+ *    info = socket.recvmsg
+ *    association_fileno = socket.peeloff(info.association_id)
+ *
+ *    p socket.getpeernames(association_fileno, info.association_id)
  */
-static VALUE rsctp_getpeernames(VALUE self){
+static VALUE rsctp_getpeernames(int argc, VALUE* argv, VALUE self){
   sctp_assoc_t assoc_id;
   struct sockaddr* addrs;
-  int i, sock_fd, num_addrs;
+  int i, fileno, num_addrs;
   char str[16];
+  VALUE v_fileno, v_association_id;
   VALUE v_array = rb_ary_new();
 
   bzero(&addrs, sizeof(addrs));
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
-  assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  rb_scan_args(argc, argv, "02", &v_fileno, &v_association_id);
 
-  num_addrs = sctp_getpaddrs(sock_fd, assoc_id, &addrs);
+  if(NIL_P(v_fileno))
+    fileno = NUM2INT(rb_iv_get(self, "@fileno"));
+  else
+    fileno = NUM2INT(v_fileno);
+
+  if(NIL_P(v_association_id))
+    assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  else
+    assoc_id = NUM2INT(v_association_id);
+
+  num_addrs = sctp_getpaddrs(fileno, assoc_id, &addrs);
 
   if(num_addrs < 0){
     sctp_freepaddrs(addrs);
@@ -303,20 +333,35 @@ static VALUE rsctp_getpeernames(VALUE self){
  *  socket = SCTP::Socket.new
  *  socket.bind(:addresses => ['10.0.4.5', '10.0.5.5'])
  *  socket.getlocalnames # => ['10.0.4.5', '10.0.5.5'])
+ *
+ *  # or get info from a peeled off association...
+ *
+ *  assoc_fileno = socket.peeloff(some_association_id)
+ *  socket.getlocalnames(assoc_fileno, some_association_id)
  */
-static VALUE rsctp_getlocalnames(VALUE self){
+static VALUE rsctp_getlocalnames(int argc, VALUE* argv, VALUE self){
   sctp_assoc_t assoc_id;
   struct sockaddr* addrs;
-  int i, sock_fd, num_addrs;
+  int i, fileno, num_addrs;
   char str[16];
+  VALUE v_assoc_fileno, v_assoc_id;
   VALUE v_array = rb_ary_new();
 
   bzero(&addrs, sizeof(addrs));
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
-  assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  rb_scan_args(argc, argv, "02", &v_assoc_fileno, &v_assoc_id);
 
-  num_addrs = sctp_getladdrs(sock_fd, assoc_id, &addrs);
+  if(NIL_P(v_assoc_fileno))
+    fileno = NUM2INT(rb_iv_get(self, "@fileno"));
+  else
+    fileno = NUM2INT(v_assoc_fileno);
+
+  if(NIL_P(v_assoc_id))
+    assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  else
+    assoc_id = NUM2INT(v_assoc_id);
+
+  num_addrs = sctp_getladdrs(fileno, assoc_id, &addrs);
 
   if(num_addrs < 0){
     sctp_freeladdrs(addrs);
@@ -362,7 +407,7 @@ static VALUE rsctp_sendv(VALUE self, VALUE v_options){
   struct iovec iov[IOV_MAX];
   struct sockaddr_in* addrs;
   struct sctp_sndinfo info;
-  int i, sock_fd, num_bytes, size, num_ip;
+  int i, fileno, num_bytes, size, num_ip;
 
   Check_Type(v_options, T_HASH);
 
@@ -385,7 +430,7 @@ static VALUE rsctp_sendv(VALUE self, VALUE v_options){
     num_ip = 0;
   }
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
   size = RARRAY_LEN(v_message);
 
   if(!size)
@@ -424,7 +469,7 @@ static VALUE rsctp_sendv(VALUE self, VALUE v_options){
   }
 
   num_bytes = sctp_sendv(
-    sock_fd,
+    fileno,
     iov,
     size,
     (struct sockaddr*)addrs,
@@ -442,6 +487,74 @@ static VALUE rsctp_sendv(VALUE self, VALUE v_options){
 }
 #endif
 
+#ifdef HAVE_SCTP_RECVV
+static VALUE rsctp_recvv(int argc, VALUE* argv, VALUE self){
+  VALUE v_flags;
+  int fileno, flags, bytes, on;
+  uint infotype;
+  socklen_t infolen;
+  struct iovec iov[1];
+  struct sctp_rcvinfo info;
+  char buffer[1024];
+
+  bzero(&iov, sizeof(iov));
+  bzero(&info, sizeof(info));
+  bzero(&buffer, sizeof(buffer));
+
+	iov->iov_base = buffer;
+	iov->iov_len = sizeof(buffer);
+
+  rb_scan_args(argc, argv, "01", &v_flags);
+
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
+
+  if(NIL_P(v_flags))
+    flags = 0;
+  else
+    flags = NUM2INT(v_flags);
+
+  on = 1;
+  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_RECVRCVINFO, &on, sizeof(on)) < 0)
+    rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
+
+  infolen = sizeof(struct sctp_rcvinfo);
+  infotype = 0;
+
+  bytes = sctp_recvv(
+    fileno,
+    iov,
+    1,
+    NULL,
+    NULL,
+    &info,
+    &infolen,
+    &infotype,
+    &flags
+  );
+
+  if(bytes < 0)
+    rb_raise(rb_eSystemCallError, "sctp_recvv: %s", strerror(errno));
+
+  if(infotype != SCTP_RECVV_RCVINFO){
+    return Qnil;
+  }
+  else{
+    return rb_struct_new(
+      v_sctp_receive_info_struct,
+      rb_str_new2(iov->iov_base),
+      UINT2NUM(info.rcv_sid),
+      UINT2NUM(info.rcv_ssn),
+      UINT2NUM(info.rcv_flags),
+      UINT2NUM(info.rcv_ppid),
+      UINT2NUM(info.rcv_tsn),
+      UINT2NUM(info.rcv_cumtsn),
+      UINT2NUM(info.rcv_context),
+      UINT2NUM(info.rcv_assoc_id)
+    );
+  }
+}
+#endif
+
 /*
  * Send a message on an already-connected socket to a specific association.
  *
@@ -458,7 +571,7 @@ static VALUE rsctp_send(VALUE self, VALUE v_options){
   uint16_t stream;
   uint32_t ppid, send_flags, ctrl_flags, ttl, context;
   ssize_t num_bytes;
-  int sock_fd;
+  int fileno;
   sctp_assoc_t assoc_id;
   struct sctp_sndrcvinfo info;
   VALUE v_msg, v_stream, v_ppid, v_context, v_send_flags, v_ctrl_flags, v_ttl, v_assoc_id;
@@ -519,10 +632,10 @@ static VALUE rsctp_send(VALUE self, VALUE v_options){
   info.sinfo_timetolive = ttl;
   info.sinfo_assoc_id = assoc_id;
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
   num_bytes = sctp_send(
-    sock_fd,
+    fileno,
     StringValueCStr(v_msg),
     RSTRING_LEN(v_msg),
     &info,
@@ -570,7 +683,7 @@ static VALUE rsctp_sendmsg(VALUE self, VALUE v_options){
   uint32_t ppid, flags, ttl, context;
   ssize_t num_bytes;
   struct sockaddr_in addrs[8];
-  int sock_fd, size;
+  int fileno, size;
 
   Check_Type(v_options, T_HASH);
 
@@ -637,10 +750,10 @@ static VALUE rsctp_sendmsg(VALUE self, VALUE v_options){
     size = 0;
   }
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
   num_bytes = sctp_sendmsg(
-    sock_fd,
+    fileno,
     StringValueCStr(v_msg),
     RSTRING_LEN(v_msg),
     (struct sockaddr*)addrs,
@@ -681,7 +794,7 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
   VALUE v_flags, v_notification, v_message;
   struct sctp_sndrcvinfo sndrcvinfo;
   struct sockaddr_in clientaddr;
-  int flags, bytes, sock_fd;
+  int flags, bytes, fileno;
   char buffer[1024]; // TODO: Let this be configurable?
   socklen_t length;
 
@@ -692,7 +805,7 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
   else
     flags = NUM2INT(v_flags);  
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
   length = sizeof(struct sockaddr_in);
 
   bzero(buffer, sizeof(buffer));
@@ -700,7 +813,7 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
   bzero(&sndrcvinfo, sizeof(sndrcvinfo));
 
   bytes = sctp_recvmsg(
-    sock_fd,
+    fileno,
     buffer,
     sizeof(buffer),
     (struct sockaddr*)&clientaddr,
@@ -803,6 +916,7 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
 
         v_notification = rb_struct_new(v_remote_error_struct,
           UINT2NUM(snp->sn_remote_error.sre_type),
+          UINT2NUM(snp->sn_remote_error.sre_flags),
           UINT2NUM(snp->sn_remote_error.sre_length),
           UINT2NUM(snp->sn_remote_error.sre_error),
           UINT2NUM(snp->sn_remote_error.sre_assoc_id),
@@ -884,6 +998,14 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
           UINT2NUM(snp->sn_authkey_event.auth_assoc_id)
         );
         break;
+      case SCTP_SENDER_DRY_EVENT:
+        v_notification = rb_struct_new(v_sender_dry_event_struct,
+          UINT2NUM(snp->sn_sender_dry_event.sender_dry_type),
+          UINT2NUM(snp->sn_sender_dry_event.sender_dry_flags),
+          UINT2NUM(snp->sn_sender_dry_event.sender_dry_length),
+          UINT2NUM(snp->sn_sender_dry_event.sender_dry_assoc_id)
+        );
+        break;
     }
   }
 
@@ -915,15 +1037,15 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
  *
  * The following parameters can be configured:
  *
- * :output_streams - The number of outbound SCTP streams an application would like to request.
- * :input_streams - The maximum number of inbound streams an application is prepared to allow.
- * :max_attempts - How many times the the SCTP stack should send the initial INIT message before it's considered unreachable.
- * :timeout - The maximum RTO value for the INIT timer.
+ *  :output_streams - The number of outbound SCTP streams an application would like to request.
+ *  :input_streams  - The maximum number of inbound streams an application is prepared to allow.
+ *  :max_attempts   - How many times the the SCTP stack should send the initial INIT message before it's considered unreachable.
+ *  :timeout        - The maximum RTO value for the INIT timer.
  *
  * By default these values are set to zero (i.e. ignored).
  */
 static VALUE rsctp_set_initmsg(VALUE self, VALUE v_options){
-  int sock_fd;
+  int fileno;
   struct sctp_initmsg initmsg;
   VALUE v_output, v_input, v_attempts, v_timeout;
 
@@ -934,7 +1056,7 @@ static VALUE rsctp_set_initmsg(VALUE self, VALUE v_options){
   v_attempts = rb_hash_aref2(v_options, "max_attempts");
   v_timeout  = rb_hash_aref2(v_options, "timeout");
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
   if(!NIL_P(v_output))
     initmsg.sinit_num_ostreams = NUM2INT(v_output);
@@ -948,15 +1070,15 @@ static VALUE rsctp_set_initmsg(VALUE self, VALUE v_options){
   if(!NIL_P(v_timeout))
     initmsg.sinit_max_init_timeo = NUM2INT(v_timeout);
 
-  if(setsockopt(sock_fd, IPPROTO_SCTP, SCTP_INITMSG, &initmsg, sizeof(initmsg)) < 0)
+  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_INITMSG, &initmsg, sizeof(initmsg)) < 0)
     rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
 
   return self;
 }
 
 /*
- * Subscribe to various notification types, which will generate additional
- * data that the socket may receive. The possible notification types are
+ * Subscribe to various notification type events, which will generate additional
+ * data that the socket may receive. The possible notification type events are
  * as follows:
  *
  *   :association
@@ -979,11 +1101,8 @@ static VALUE rsctp_set_initmsg(VALUE self, VALUE v_options){
  *   :adaptation
  *   :authentication
  *   :partial_delivery
- *
- *   Not yet supported:
- *
  *   :sender_dry
- *   :peer_error
+ *   :peer_error (aka remote error)
  *
  * Example:
  * 
@@ -993,11 +1112,13 @@ static VALUE rsctp_set_initmsg(VALUE self, VALUE v_options){
  *   socket.subscribe(:data_io => true, :shutdown => true, :send_failure => true)
  */
 static VALUE rsctp_subscribe(VALUE self, VALUE v_options){
-  int sock_fd;
+  int fileno;
   struct sctp_event_subscribe events;
 
   bzero(&events, sizeof(events));
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  Check_Type(v_options, T_HASH);
+
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
   if(RTEST(rb_hash_aref2(v_options, "data_io")))
     events.sctp_data_io_event = 1;
@@ -1033,7 +1154,7 @@ static VALUE rsctp_subscribe(VALUE self, VALUE v_options){
   if(RTEST(rb_hash_aref2(v_options, "sender_dry")))
     events.sctp_sender_dry_event = 1;
 
-  if(setsockopt(sock_fd, IPPROTO_SCTP, SCTP_EVENTS, &events, sizeof(events)) < 0)
+  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_EVENTS, &events, sizeof(events)) < 0)
     rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
 
   return self;
@@ -1044,29 +1165,39 @@ static VALUE rsctp_subscribe(VALUE self, VALUE v_options){
  * will be used to accept incoming connection requests.
  *
  * The backlog argument defines the maximum length to which the queue of
- * pending connections for sockfd may grow. The default is 1024.
+ * pending connections for sockfd may grow. The default value is 128. The
+ * maximum value is Socket::SOMAXCONN.
+ *
+ * Why a default of 128? The answer is a "best guess" compromise between
+ * handling server load versus avoiding SYN flood attacks. I leave it as an
+ * exercise to the programmer to adjust as desired.
+ *
+ * See https://tangentsoft.com/wskfaq/advanced.html#backlog if you want
+ * more details on the advantages and drawbacks of various values.
  *
  * Example:
  *
  *  socket = SCTP::Socket.new
  *  socket.bind(:port => 62534, :addresses => ['127.0.0.1'])
  *  socket.listen
- *
  */
 static VALUE rsctp_listen(int argc, VALUE* argv, VALUE self){
   VALUE v_backlog;
-  int backlog, sock_fd;
+  int backlog, fileno;
 
   rb_scan_args(argc, argv, "01", &v_backlog);
 
   if(NIL_P(v_backlog))
-    backlog = 1024;
+    backlog = 128;
   else
     backlog = NUM2INT(v_backlog);
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  if(backlog > SOMAXCONN)
+    rb_raise(rb_eArgError, "backlog value exceeds maximum value of: %i", SOMAXCONN);
+
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
-  if(listen(sock_fd, backlog) < 0)
+  if(listen(fileno, backlog) < 0)
     rb_raise(rb_eSystemCallError, "listen: %s", strerror(errno));
   
   return self;
@@ -1074,38 +1205,62 @@ static VALUE rsctp_listen(int argc, VALUE* argv, VALUE self){
 
 /*
  * Extracts an association contained by a one-to-many socket connection into
- * a one-to-one style socket. Note that this modifies the underlying sock_fd.
+ * a one-to-one style socket. Returns the socket descriptor (fileno).
+ *
+ * Example:
+ *
+ *   socket = SCTP::Socket.new
+ *   # etc...
+ *
+ *   while true
+ *     info = socket.recvmsg
+ *     assoc_fileno = socket.peeloff(info.association_id)
+ *     # ... Do something with this new fileno
+ *   end
  */
 static VALUE rsctp_peeloff(VALUE self, VALUE v_assoc_id){
-  int sock_fd, new_sock_fd;
+  int fileno, assoc_fileno;
   sctp_assoc_t assoc_id;
     
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
   assoc_id = NUM2INT(v_assoc_id);
 
-  new_sock_fd = sctp_peeloff(sock_fd, assoc_id);
+  assoc_fileno = sctp_peeloff(fileno, assoc_id);
 
-  if(new_sock_fd < 0)
+  if(assoc_fileno < 0)
     rb_raise(rb_eSystemCallError, "sctp_peeloff: %s", strerror(errno));
 
-  rb_iv_set(self, "@sock_fd", INT2NUM(new_sock_fd));
-
-  return self;
+  return INT2NUM(assoc_fileno);
 }
 
+/*
+ * Returns the default set of parameters that a call to the sendto function
+ * uses on this association. This is a struct that contains the following
+ * members:
+ *
+ *  * stream
+ *  * ssn
+ *  * flags
+ *  * ppid
+ *  * context
+ *  * ttl
+ *  * tsn
+ *  * cumtsn
+ *  * association_id
+ */
 static VALUE rsctp_get_default_send_params(VALUE self){
-  int sock_fd;
+  int fileno;
   socklen_t size;
   sctp_assoc_t assoc_id;
   struct sctp_sndrcvinfo sndrcv;
 
   bzero(&sndrcv, sizeof(sndrcv));
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
   assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
   size = sizeof(struct sctp_sndrcvinfo);
 
-  if(sctp_opt_info(sock_fd, assoc_id, SCTP_DEFAULT_SEND_PARAM, (void*)&sndrcv, &size) < 0)
+  if(sctp_opt_info(fileno, assoc_id, SCTP_DEFAULT_SEND_PARAM, (void*)&sndrcv, &size) < 0)
     rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
 
   return rb_struct_new(
@@ -1122,19 +1277,32 @@ static VALUE rsctp_get_default_send_params(VALUE self){
   );
 }
 
+/*
+ * Returns the association specific parameters. This is a struct
+ * that contains the following members:
+ *
+ *  * association_id
+ *  * max_retransmission_count
+ *  * number_peer_destinations
+ *  * peer_receive_window
+ *  * local_receive_window
+ *  * cookie_life
+ *
+ *  All values that refer to time values are measured in milliseconds.
+ */
 static VALUE rsctp_get_association_info(VALUE self){
-  int sock_fd;
+  int fileno;
   socklen_t size;
   sctp_assoc_t assoc_id;
   struct sctp_assocparams assoc;
 
   bzero(&assoc, sizeof(assoc));
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
   assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
   size = sizeof(struct sctp_assocparams);
 
-  if(sctp_opt_info(sock_fd, assoc_id, SCTP_ASSOCINFO, (void*)&assoc, &size) < 0)
+  if(sctp_opt_info(fileno, assoc_id, SCTP_ASSOCINFO, (void*)&assoc, &size) < 0)
     rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
 
   return rb_struct_new(
@@ -1148,11 +1316,23 @@ static VALUE rsctp_get_association_info(VALUE self){
   );
 }
 
+/*
+ * Shuts down socket send and receive operations.
+ *
+ * Optionally accepts an argument that specifieds the type of shutdown.
+ * This can be one of the following values:
+ *
+ *  * SHUT_RD   - Disables further receive operations.
+ *  * SHUT_WR   - Disables further send operations.
+ *  * SHUT_RDWR - Disables further send and receive operations.
+ *
+ *  The default is SHUT_RDWR.
+ */
 static VALUE rsctp_shutdown(int argc, VALUE* argv, VALUE self){
-  int how, sock_fd;
+  int how, fileno;
   VALUE v_how;
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
   rb_scan_args(argc, argv, "01", &v_how);
 
@@ -1164,25 +1344,35 @@ static VALUE rsctp_shutdown(int argc, VALUE* argv, VALUE self){
     how = NUM2INT(v_how);
   }
 
-  if(shutdown(sock_fd, how) < 0)
+  if(shutdown(fileno, how) < 0)
     rb_raise(rb_eSystemCallError, "shutdown: %s", strerror(errno));
 
   return self;
 }
 
+/*
+ * Returns the protocol parameters that are used to initialize and bind the
+ * retransmission timeout (RTO) tunable. This is a struct with the following
+ * members:
+ *
+ *  * association_id
+ *  * initial
+ *  * max
+ *  * min
+ */
 static VALUE rsctp_get_retransmission_info(VALUE self){
-  int sock_fd;
+  int fileno;
   socklen_t size;
   sctp_assoc_t assoc_id;
   struct sctp_rtoinfo rto;
 
   bzero(&rto, sizeof(rto));
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
   assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
   size = sizeof(struct sctp_rtoinfo);
 
-  if(sctp_opt_info(sock_fd, assoc_id, SCTP_RTOINFO, (void*)&rto, &size) < 0)
+  if(sctp_opt_info(fileno, assoc_id, SCTP_RTOINFO, (void*)&rto, &size) < 0)
     rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
 
   return rb_struct_new(
@@ -1216,7 +1406,7 @@ static VALUE rsctp_get_retransmission_info(VALUE self){
  *  * primary (IP)
  */
 static VALUE rsctp_get_status(VALUE self){
-  int sock_fd;
+  int fileno;
   socklen_t size;
   sctp_assoc_t assoc_id;
   struct sctp_status status;
@@ -1225,11 +1415,11 @@ static VALUE rsctp_get_status(VALUE self){
 
   bzero(&status, sizeof(status));
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
   assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
   size = sizeof(struct sctp_status);
 
-  if(sctp_opt_info(sock_fd, assoc_id, SCTP_STATUS, (void*)&status, &size) < 0)
+  if(sctp_opt_info(fileno, assoc_id, SCTP_STATUS, (void*)&status, &size) < 0)
     rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
 
   spinfo = &status.sstat_primary;
@@ -1258,6 +1448,87 @@ static VALUE rsctp_get_status(VALUE self){
   );
 }
 
+/*
+ * Returns a struct of events detailing which events have been
+ * subscribed to by the socket. The struct contains the following
+ * members:
+ *
+ *  * data_io
+ *  * association
+ *  * address
+ *  * send_failure
+ *  * peer_error
+ *  * shutdown
+ *  * partial_delivery
+ *  * adaptation_layer
+ *  * authentication
+ *  * sender_dry
+ *  * stream_reset
+ *  * assoc_reset
+ *  * stream_change
+ *  * send_failure_event
+ */
+static VALUE rsctp_get_subscriptions(VALUE self){
+  int fileno;
+  socklen_t size;
+  sctp_assoc_t assoc_id;
+  struct sctp_event_subscribe events;
+
+  bzero(&events, sizeof(events));
+
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
+  assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  size = sizeof(struct sctp_event_subscribe);
+
+  if(sctp_opt_info(fileno, assoc_id, SCTP_EVENTS, (void*)&events, &size) < 0)
+    rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
+
+  return rb_struct_new(v_sctp_event_subscribe_struct,
+    (events.sctp_data_io_event ? Qtrue : Qfalse),
+    (events.sctp_association_event ? Qtrue : Qfalse),
+    (events.sctp_address_event ? Qtrue : Qfalse),
+    (events.sctp_send_failure_event ? Qtrue : Qfalse),
+    (events.sctp_peer_error_event ? Qtrue : Qfalse),
+    (events.sctp_shutdown_event ? Qtrue : Qfalse),
+    (events.sctp_partial_delivery_event ? Qtrue : Qfalse),
+    (events.sctp_adaptation_layer_event ? Qtrue : Qfalse),
+    (events.sctp_authentication_event ? Qtrue : Qfalse),
+    (events.sctp_sender_dry_event ? Qtrue : Qfalse),
+    (events.sctp_stream_reset_event ? Qtrue : Qfalse),
+    (events.sctp_assoc_reset_event ? Qtrue : Qfalse),
+    (events.sctp_stream_change_event ? Qtrue : Qfalse),
+    (events.sctp_send_failure_event_event ? Qtrue : Qfalse)
+  );
+}
+
+static VALUE rsctp_get_peer_address_params(VALUE self){
+  int fileno;
+  char str[16];
+  socklen_t size;
+  sctp_assoc_t assoc_id;
+  struct sctp_paddrparams paddr;
+
+  bzero(&paddr, sizeof(paddr));
+  bzero(&str, sizeof(str));
+
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
+  assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  size = sizeof(struct sctp_paddrparams);
+
+  if(sctp_opt_info(fileno, assoc_id, SCTP_PEER_ADDR_PARAMS, (void*)&paddr, &size) < 0)
+    rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
+
+  inet_ntop(AF_INET, ((struct sockaddr_in*)&paddr.spp_address), str, sizeof(str));
+
+  return rb_struct_new(
+    v_sctp_peer_addr_params_struct,
+    INT2NUM(paddr.spp_assoc_id),
+    rb_str_new2(str),
+    INT2NUM(paddr.spp_hbinterval),
+    INT2NUM(paddr.spp_pathmaxrxt)
+  );
+}
+
 void Init_socket(void){
   mSCTP   = rb_define_module("SCTP");
   cSocket = rb_define_class_under(mSCTP, "Socket", rb_cObject);
@@ -1278,7 +1549,7 @@ void Init_socket(void){
   );
 
   v_remote_error_struct = rb_struct_define(
-    "RemoteError", "type", "length", "error", "association_id", "data", NULL
+    "RemoteError", "type", "flags", "length", "error", "association_id", "data", NULL
   );
 
   v_send_failed_event_struct = rb_struct_define(
@@ -1306,6 +1577,10 @@ void Init_socket(void){
     "AuthEvent", "type", "length", "key_number", "indication", "association_id", NULL
   );
 
+  v_sender_dry_event_struct = rb_struct_define(
+    "SenderDryEvent", "type", "flags", "length", "association_id", NULL
+  );
+
   v_sockaddr_in_struct = rb_struct_define(
     "SockAddrIn", "family", "port", "address", NULL
   );
@@ -1330,19 +1605,38 @@ void Init_socket(void){
     "ttl", "tsn", "cumtsn", "association_id", NULL
   );
 
+  v_sctp_event_subscribe_struct = rb_struct_define(
+    "EventSubscriptions", "data_io", "association", "address", "send_failure",
+    "peer_error", "shutdown", "partial_delivery", "adaptation_layer",
+    "authentication", "sender_dry", "stream_reset", "assoc_reset",
+    "stream_change", "send_failure_event", NULL
+  );
+
+  v_sctp_receive_info_struct = rb_struct_define(
+    "ReceiveInfo", "message", "sid", "ssn", "flags", "ppid", "tsn",
+    "cumtsn", "context", "assocation_id", NULL
+  );
+
+  v_sctp_peer_addr_params_struct = rb_struct_define(
+    "PeerAddressParams", "association_id", "address", "heartbeat_interval",
+    "max_retransmission_count", NULL
+  );
+
   rb_define_method(cSocket, "initialize", rsctp_init, -1);
 
-  rb_define_method(cSocket, "bind", rsctp_bind, -1);
+  rb_define_method(cSocket, "bindx", rsctp_bindx, -1);
   rb_define_method(cSocket, "close", rsctp_close, 0);
-  rb_define_method(cSocket, "connect", rsctp_connect, -1);
-  rb_define_method(cSocket, "getpeernames", rsctp_getpeernames, 0);
-  rb_define_method(cSocket, "getlocalnames", rsctp_getlocalnames, 0);
+  rb_define_method(cSocket, "connectx", rsctp_connectx, -1);
+  rb_define_method(cSocket, "getpeernames", rsctp_getpeernames, -1);
+  rb_define_method(cSocket, "getlocalnames", rsctp_getlocalnames, -1);
   rb_define_method(cSocket, "get_status", rsctp_get_status, 0);
   rb_define_method(cSocket, "get_default_send_params", rsctp_get_default_send_params, 0);
   rb_define_method(cSocket, "get_retransmission_info", rsctp_get_retransmission_info, 0);
   rb_define_method(cSocket, "get_association_info", rsctp_get_association_info, 0);
+  rb_define_method(cSocket, "get_subscriptions", rsctp_get_subscriptions, 0);
+  rb_define_method(cSocket, "get_peer_address_params", rsctp_get_peer_address_params, 0);
   rb_define_method(cSocket, "listen", rsctp_listen, -1);
-  rb_define_method(cSocket, "peeloff!", rsctp_peeloff, 1);
+  rb_define_method(cSocket, "peeloff", rsctp_peeloff, 1);
   rb_define_method(cSocket, "recvmsg", rsctp_recvmsg, -1);
   rb_define_method(cSocket, "send", rsctp_send, 1);
 
@@ -1350,6 +1644,10 @@ void Init_socket(void){
   rb_define_method(cSocket, "sendv", rsctp_sendv, 1);
 #endif
 
+#ifdef HAVE_SCTP_RECVV
+  rb_define_method(cSocket, "recvv", rsctp_recvv, -1);
+#endif
+
   rb_define_method(cSocket, "sendmsg", rsctp_sendmsg, 1);
   rb_define_method(cSocket, "set_initmsg", rsctp_set_initmsg, 1);
   rb_define_method(cSocket, "shutdown", rsctp_shutdown, -1);
@@ -1357,12 +1655,12 @@ void Init_socket(void){
 
   rb_define_attr(cSocket, "domain", 1, 1);
   rb_define_attr(cSocket, "type", 1, 1);
-  rb_define_attr(cSocket, "sock_fd", 1, 1);
+  rb_define_attr(cSocket, "fileno", 1, 1);
   rb_define_attr(cSocket, "association_id", 1, 1);
   rb_define_attr(cSocket, "port", 1, 1);
 
-  /* 0.0.6: The version of this library */
-  rb_define_const(cSocket, "VERSION", rb_str_new2("0.0.6"));
+  /* 0.1.0: The version of this library */
+  rb_define_const(cSocket, "VERSION", rb_str_new2("0.1.0"));
 
   /* send flags */
 

data/sctp-socket.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name        = 'sctp-socket'
-  spec.version     = '0.0.6'
+  spec.version     = '0.1.0'
   spec.author      = 'Daniel Berger'
   spec.email       = 'djberg96@gmail.com'
   spec.summary     = 'Ruby bindings for SCTP sockets'
@@ -14,10 +14,10 @@ Gem::Specification.new do |spec|
 
   spec.extensions = ['ext/sctp/extconf.rb']
 
-  spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rake-compiler', '~> 1.1'
-  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rake-compiler'
+  spec.add_development_dependency 'rspec'
 
   spec.metadata = {
     'homepage_uri'          => 'https://github.com/djberg96/sctp-socket',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sctp-socket
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,64 +35,64 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2024-05-25 00:00:00.000000000 Z
+date: 2024-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '0'
 description: |2
       The sctp-socket library provides Ruby bindings for SCTP sockets. is a
       message oriented, reliable transport protocol with direct support for