sctp-socket 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c30fa4f2df555124cafe30c8440c3429b977d0d6dce57b46fbaee7510c096cb4
-  data.tar.gz: 0e008c97688b85e1a2fc27b2af11a5a6262fd755f49aa762e7d6c78fea9ca863
+  metadata.gz: 3ac0fa4ee8107cb8b16e87b7313a8a14985ef78b01720fb1957240273e186536
+  data.tar.gz: 926f171e90bcbdad7b1923490cf3cebe81448ef3610c30d77dacb46060f73f6b
 SHA512:
-  metadata.gz: 4f42d5408ad8262084b6df0e6fd199a9dd142fb806f7b603c64a117fd31e2c890ba4090d9c1e04b5491d84e9fb8a77f7d6bc4b39d2da30e982b4fe9d5c17b0a3
-  data.tar.gz: 881f42f26d2f080e2962e9ca01ea179b53ebd13bd956d42b44e626613d7f383208f250c7fb621ae9bddcf3bc95de544db63d08767a70a77d68c1c9bf3205ae75
+  metadata.gz: 57506b9decdc8652e085cc2bdb5b41167e9bb64b8ae4966856a44b208c83e2e2a0fadce33e6711223d3e2aeebabc70feef5ec85b2a66c906feb642323b646736
+  data.tar.gz: 9d37cba691620fd8cc047da402a867c8ec60767fe5e05940a1a06d9ea1d2ac98e4dc9e52f2fb77c12c0485ac46f42aafcd0b8551147e3259850928b9fb80208d

data/CHANGES.md

@@ -1,3 +1,8 @@
-## 24-Nov-2020
+## 29-Nov-2020
+* Fixed the homepage link in the gemspec metadata. Thanks go to Nick LaMuro for the patch.
+* The getlocalnames and getpeernames now return an array of addresses.
+* Added a shutdown method.
+* Added more documentation.
 
+## 24-Nov-2020
 * Initial release.

data/README.md

@@ -43,7 +43,7 @@ begin
   socket.listen
 
   while true
-    data = socket.recvmsgx
+    data = socket.recvmsg
     puts data
   end
 ensure

data/ext/sctp/socket.c

@@ -215,16 +215,20 @@ static VALUE rsctp_close(VALUE self){
   return self;
 }
 
+/*
+ *  Return an array of all addresses of a peer.
+ */
 static VALUE rsctp_getpeernames(VALUE self){
-  VALUE v_assoc_id = rb_iv_get(self, "@assocation_id"); 
   sctp_assoc_t assoc_id;
   struct sockaddr* addrs;
   int i, sock_fd, num_addrs;
+  char str[16];
+  VALUE v_array = rb_ary_new();
 
   bzero(&addrs, sizeof(addrs));
 
   sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
-  assoc_id = NUM2INT(v_assoc_id);
+  assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
 
   num_addrs = sctp_getpaddrs(sock_fd, assoc_id, &addrs);
 
@@ -234,23 +238,36 @@ static VALUE rsctp_getpeernames(VALUE self){
   }
 
   for(i = 0; i < num_addrs; i++){
-    // TODO: Create and return array of IpAddr objects
+    inet_ntop(AF_INET, &(((struct sockaddr_in *)&addrs[i])->sin_addr), str, sizeof(str));
+    rb_ary_push(v_array, rb_str_new2(str));
+    bzero(&str, sizeof(str));
   }
 
   sctp_freepaddrs(addrs);
 
-  return self;
+  return v_array;
 }
 
+/*
+ * Return an array of local addresses that are part of the association.
+ *
+ * Example:
+ *
+ *  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'])
+ */
 static VALUE rsctp_getlocalnames(VALUE self){
   sctp_assoc_t assoc_id;
   struct sockaddr* addrs;
   int i, sock_fd, num_addrs;
+  char str[16];
+  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, "@assocation_id"));
+  assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
 
   num_addrs = sctp_getladdrs(sock_fd, assoc_id, &addrs);
 
@@ -260,12 +277,14 @@ static VALUE rsctp_getlocalnames(VALUE self){
   }
 
   for(i = 0; i < num_addrs; i++){
-    // TODO: Create and return array of IpAddr objects
+    inet_ntop(AF_INET, &(((struct sockaddr_in *)&addrs[i])->sin_addr), str, sizeof(str));
+    rb_ary_push(v_array, rb_str_new2(str));
+    bzero(&str, sizeof(str));
   }
 
   sctp_freeladdrs(addrs);
 
-  return self;
+  return v_array;
 }
 
 /*
@@ -474,12 +493,21 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
 }
 
 /*
- *  {
- *    :output_streams => 2,
- *    :input_streams  => 3,
- *    :max_attempts   => 5,
- *    :timeout        => 30
- *  }
+ * Set the initial parameters used by the socket when sending out the INIT message.
+ *
+ * Example:
+ *
+ *  socket = SCTP::Socket.new
+ *  socket.set_initmsg(:output_streams => 5, :input_streams => 5, :max_attempts => 4, :timeout => 30)
+ *
+ * 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.
+ *
+ * By default these values are set to zero (i.e. ignored).
  */
 static VALUE rsctp_set_initmsg(VALUE self, VALUE v_options){
   int sock_fd;
@@ -645,13 +673,35 @@ static VALUE rsctp_peeloff(VALUE self, VALUE v_assoc_id){
   return self;
 }
 
+static VALUE rsctp_shutdown(int argc, VALUE* argv, VALUE self){
+  int how, sock_fd;
+  VALUE v_how;
+
+  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+
+  rb_scan_args(argc, argv, "01", &v_how);
+
+  if(NIL_P(v_how)){
+    how = SHUT_RDWR;
+  }
+  else{
+    Check_Type(v_how, T_FIXNUM);
+    how = NUM2INT(v_how);
+  }
+
+  if(shutdown(sock_fd, how) < 0)
+    rb_raise(rb_eSystemCallError, "shutdown: %s", strerror(errno));
+
+  return self;
+}
+
 void Init_socket(){
   mSCTP   = rb_define_module("SCTP");
   cSocket = rb_define_class_under(mSCTP, "Socket", rb_cObject);
 
   v_sndrcv_struct = rb_struct_define(
     "SndRecvInfo", "message", "stream", "flags",
-    "ppid", "context", "ttl", "assoc_id", NULL
+    "ppid", "context", "ttl", "association_id", NULL
   );
 
   rb_define_method(cSocket, "initialize", rsctp_init, -1);
@@ -666,6 +716,7 @@ void Init_socket(){
   rb_define_method(cSocket, "recvmsg", rsctp_recvmsg, -1);
   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);
   rb_define_method(cSocket, "subscribe", rsctp_subscribe, 1);
 
   rb_define_attr(cSocket, "domain", 1, 1);
@@ -674,6 +725,6 @@ void Init_socket(){
   rb_define_attr(cSocket, "association_id", 1, 1);
   rb_define_attr(cSocket, "port", 1, 1);
 
-  /* 0.0.1: The version of this library */
-  rb_define_const(cSocket, "VERSION", rb_str_new2("0.0.1"));
+  /* 0.0.2: The version of this library */
+  rb_define_const(cSocket, "VERSION", rb_str_new2("0.0.2"));
 }

data/sctp-socket.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |spec|
   spec.name        = 'sctp-socket'
-  spec.version     = '0.0.1'
+  spec.version     = '0.0.2'
   spec.author      = 'Daniel Berger'
   spec.email       = 'djberg96@gmail.com'
   spec.summary     = 'Ruby bindings for SCTP sockets'
   spec.description = 'Ruby bindings for SCTP sockets'
-  spec.homepage    = 'https://github.com/djberg96/sctp-sockets'
+  spec.homepage    = 'https://github.com/djberg96/sctp-socket'
   spec.license     = 'Apache-2.0'
   spec.cert_chain  = ['certs/djberg96_pub.pem']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sctp-socket
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2020-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,7 +116,7 @@ files:
 - ext/sctp/socket/client.c
 - ext/sctp/socket/server.c
 - sctp-socket.gemspec
-homepage: https://github.com/djberg96/sctp-sockets
+homepage: https://github.com/djberg96/sctp-socket
 licenses:
 - Apache-2.0
 metadata: {}