sctp-socket 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0475ccb484ff3e6e758c037edf11b16fdb833e49aee961a98532dfb67c84f799
-  data.tar.gz: 70f7add0defeeb84a1ab6bb38ed3aeabb5f643bb05dea06a00a11c1934f588ed
+  metadata.gz: a483264dd5712655f641ade00e03177756f25340c2fd398bed3ad453bc6a9cdb
+  data.tar.gz: 719857e2ce3a5db341aa317f23ec0bf2fa674dd9b427b502f99e3515cb786dac
 SHA512:
-  metadata.gz: e5e40484afdf170570c38ab9331c99ae4a6f42ba217d97e91ecd5bfbf9296c2ef95f219498fba13b524ad08a1f00271de8be6f358f2982a4c5e45fdc190f0951
-  data.tar.gz: f9b9dac418aeae1c79916e732d7310049812c2456c0f4f1c578641f145c2c72b73fbceb655954ad99b03c3c69a890cab9a7455930199902a40aed9de239754a8
+  metadata.gz: 3dd98e9076f37396a55339fa20f1097ab5c582a418d885d8599b320b5cf722acb3c296b8afb798faadbee67519ee9368e87596c60d8658ef35a23a01d76c0d82
+  data.tar.gz: 4c7adf403e6075eb53129e9f4b92a97e3887518afa15458bf8b74fa7765478c54001d5f5f6cd997c2a4e44e1cba8783ee329ff9c3125f62fb9ae87e53c7e06b7

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 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

data/ext/sctp/socket.c

@@ -23,6 +23,8 @@ 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)
@@ -180,6 +182,7 @@ static VALUE rsctp_bindx(int argc, VALUE* argv, VALUE self){
   if(port == 0){
     struct sockaddr_in sin;
     socklen_t len = sizeof(sin);
+    bzero(&sin, len);
 
     if(getsockname(fileno, (struct sockaddr *)&sin, &len) == -1)
       rb_raise(rb_eSystemCallError, "getsockname: %s", strerror(errno));
@@ -913,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),
@@ -994,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;
     }
   }
 
@@ -1025,10 +1037,10 @@ 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).
  */
@@ -1089,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:
  * 
@@ -1206,7 +1215,7 @@ static VALUE rsctp_listen(int argc, VALUE* argv, VALUE self){
  *   while true
  *     info = socket.recvmsg
  *     assoc_fileno = socket.peeloff(info.association_id)
- *     # ... Do something with this new
+ *     # ... Do something with this new fileno
  *   end
  */
 static VALUE rsctp_peeloff(VALUE self, VALUE v_assoc_id){
@@ -1224,6 +1233,21 @@ static VALUE rsctp_peeloff(VALUE self, VALUE v_assoc_id){
   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 fileno;
   socklen_t size;
@@ -1253,6 +1277,19 @@ 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 fileno;
   socklen_t size;
@@ -1279,6 +1316,18 @@ 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, fileno;
   VALUE v_how;
@@ -1301,6 +1350,16 @@ static VALUE rsctp_shutdown(int argc, VALUE* argv, VALUE self){
   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 fileno;
   socklen_t size;
@@ -1389,6 +1448,26 @@ 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;
@@ -1422,6 +1501,34 @@ static VALUE rsctp_get_subscriptions(VALUE self){
   );
 }
 
+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);
@@ -1442,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(
@@ -1470,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
   );
@@ -1506,6 +1617,11 @@ void Init_socket(void){
     "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, "bindx", rsctp_bindx, -1);
@@ -1518,6 +1634,7 @@ void Init_socket(void){
   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, "recvmsg", rsctp_recvmsg, -1);
@@ -1542,8 +1659,8 @@ void Init_socket(void){
   rb_define_attr(cSocket, "association_id", 1, 1);
   rb_define_attr(cSocket, "port", 1, 1);
 
-  /* 0.0.7: The version of this library */
-  rb_define_const(cSocket, "VERSION", rb_str_new2("0.0.7"));
+  /* 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.7'
+  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.7
+  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-28 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