sctp-socket 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0192244d6b63f84e1c1ed7eeca4a15e94a9f857bb932b2e246c929fa5d85a16c'
-  data.tar.gz: 61e37646cdb4138a8db5f43f9d8bbb9ade8094430b08a038f515edbb917b96be
+  metadata.gz: 30d42e64586703d527155f2fb7582e165ce6662fa3ddecec417b9905479454ca
+  data.tar.gz: ad2fce717f7d4c42a83db6524e7323c92b1b1edf1b73058757e6689a638cc3ce
 SHA512:
-  metadata.gz: 06f2c3e32b6197647f22be5be5f6321167a9cc0db70035acf19522a9e27364d42c5b3511fd5958d7b27f09afad569ff5f679139d9d1c7c039ba5f23067272c49
-  data.tar.gz: 76326d271f9c36450698f8bafa4b63ce7167286814e09109c9a297f2bafec3ec0ecf7948970fd95c17ffb509be79dd934d8167f377e7dac6f504eeb908d331ba
+  metadata.gz: 94b319f18b44be59f7b5434ccbd9c4e2b4b1e948d9dfcf155c29c497e13059a6016a945aca04712b0b1afaa6801043450268533c758491ce118dc615d1209c4b
+  data.tar.gz: f77fd5430cc646354117a27c3a5a2064b8af11cdc7019c7400286300065eea6b107b6b7bb7796408de0f5998661c652eb16b07460b54ef25defca5a231ffa731

data/CHANGES.md

@@ -1,12 +1,19 @@
-## 1-Dec-2020
+## 0.0.4 - 3-Dec-2020
+* Added the send method. Use this when you already have a connection.
+* Fixed a flags bug in the sendmsg method.
+* Fixed an association_id typo in the connect method.
+* The SCTP_PR_SCTP_TTL flag is automatically set if a TTL value is provided.
+* Added some constants so you can actually start passing flag values.
+
+## 0.0.3 - 1-Dec-2020
 * Added notification hooks that you can subscribe to, so now the subscribe method
   actually does something.
 
-## 29-Nov-2020
+## 0.0.2 - 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
+## 0.0.1 - 24-Nov-2020
 * Initial release.

data/README.md

@@ -59,6 +59,9 @@ end
 
 ## Known Issues
 
+Currently this has only been developed and tested on Linux. Other platforms
+will probably only be supported via community contributions.
+
 Please report any issues on the github project page.
 
   https://github.com/djberg96/sctp-socket

data/ext/sctp/socket.c

@@ -16,6 +16,19 @@ VALUE v_sndinfo_struct;
 VALUE v_adaptation_event_struct;
 VALUE v_partial_delivery_event_struct;
 VALUE v_auth_event_struct;
+VALUE v_sockaddr_in_struct;
+
+VALUE convert_sockaddr_in_to_struct(struct sockaddr_in* addr){
+  char ipbuf[16];
+
+  inet_ntop(addr->sin_family, &(((struct sockaddr_in *)addr)->sin_addr), ipbuf, sizeof(ipbuf));
+
+  return rb_struct_new(v_sockaddr_in_struct,
+    INT2NUM(addr->sin_family),
+    INT2NUM(ntohs(addr->sin_port)),
+    rb_str_new2(ipbuf)
+  );
+}
 
 // Helper function to get a hash value via string or symbol.
 VALUE rb_hash_aref2(VALUE v_hash, const char* key){
@@ -35,8 +48,15 @@ VALUE rb_hash_aref2(VALUE v_hash, const char* key){
  * a domain (aka family) value and socket type. By default these are AF_INET
  * and SOCK_SEQPACKET, respectively.
  *
+ * There are only two supported families: SOCK_SEQPACKET for the creation
+ * of a one-to-many socket, and SOCK_STREAM for the creation of a
+ * one-to-one socket.
+ *
  * Example:
  *
+ *   require 'socket'
+ *   require 'sctp/socket'
+ *
  *   socket1 = SCTP::Socket.new
  *   socket2 = SCTP::Socket.new(Socket::AF_INET, Socket::SOCK_STREAM)
  */
@@ -202,7 +222,7 @@ static VALUE rsctp_connect(int argc, VALUE* argv, VALUE self){
   if(sctp_connectx(sock_fd, (struct sockaddr *) addrs, num_ip, &assoc) < 0)
     rb_raise(rb_eSystemCallError, "sctp_connectx: %s", strerror(errno));
 
-  rb_iv_set(self, "@assocation_id", INT2NUM(assoc));
+  rb_iv_set(self, "@association_id", INT2NUM(assoc));
 
   return self;
 }
@@ -296,6 +316,99 @@ static VALUE rsctp_getlocalnames(VALUE self){
   return v_array;
 }
 
+/*
+ * Send a message on an already-connected socket to a specific association.
+ *
+ * Example:
+ *
+ *   socket = SCTP::Socket.new
+ *   socket.connect(:port => 42000, :addresses => ['10.0.4.5', '10.0.5.5'])
+ *
+ *   socket.send(:message => "Hello World")
+ *   socket.send(:message => "Hello World", :association_id => 37)
+ *
+ */
+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;
+  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;
+
+  Check_Type(v_options, T_HASH);
+
+  v_msg        = rb_hash_aref2(v_options, "message");
+  v_stream     = rb_hash_aref2(v_options, "stream");
+  v_ppid       = rb_hash_aref2(v_options, "ppid");
+  v_context    = rb_hash_aref2(v_options, "context");
+  v_send_flags = rb_hash_aref2(v_options, "send_flags");
+  v_ctrl_flags = rb_hash_aref2(v_options, "control_flags");
+  v_ttl        = rb_hash_aref2(v_options, "ttl");
+  v_assoc_id   = rb_hash_aref2(v_options, "association_id");
+
+  if(NIL_P(v_stream))
+    stream = 0;
+  else
+    stream = NUM2INT(v_stream);
+
+  if(NIL_P(v_send_flags))
+    send_flags = 0;
+  else
+    send_flags = NUM2INT(v_send_flags);
+
+  if(NIL_P(v_ctrl_flags))
+    ctrl_flags = 0;
+  else
+    ctrl_flags = NUM2INT(v_ctrl_flags);
+
+  if(NIL_P(v_ttl)){
+    ttl = 0;
+  }
+  else{
+    ttl = NUM2INT(v_ttl);
+    send_flags |= SCTP_PR_SCTP_TTL;
+  }
+
+  if(NIL_P(v_ppid))
+    ppid = 0;
+  else
+    ppid = NUM2INT(v_ppid);
+
+  if(NIL_P(v_context))
+    context = 0;
+  else
+    context = NUM2INT(v_context);
+
+  if(NIL_P(v_assoc_id))
+    assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  else
+    assoc_id = NUM2INT(v_assoc_id);
+
+  info.sinfo_stream = stream;
+  info.sinfo_flags = send_flags;
+  info.sinfo_ppid = ppid;
+  info.sinfo_context = context;
+  info.sinfo_timetolive = ttl;
+  info.sinfo_assoc_id = assoc_id;
+
+  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+
+  num_bytes = sctp_send(
+    sock_fd,
+    StringValueCStr(v_msg),
+    RSTRING_LEN(v_msg),
+    &info,
+    ctrl_flags
+  );
+
+  if(num_bytes < 0)
+    rb_raise(rb_eSystemCallError, "sctp_send: %s", strerror(errno));
+
+  return INT2NUM(num_bytes);
+}
+
 /*
  * Transmit a message to an SCTP endpoint. The following hash of options
  * is permitted:
@@ -351,12 +464,15 @@ static VALUE rsctp_sendmsg(VALUE self, VALUE v_options){
   if(NIL_P(v_flags))
     flags = 0;
   else
-    flags = NUM2INT(v_stream);
+    flags = NUM2INT(v_flags);
 
-  if(NIL_P(v_ttl))
+  if(NIL_P(v_ttl)){
     ttl = 0;
-  else
+  }
+  else{
     ttl = NUM2INT(v_ttl);
+    flags |= SCTP_PR_SCTP_TTL;
+  }
 
   if(NIL_P(v_ppid))
     ppid = 0;
@@ -634,7 +750,8 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
     UINT2NUM(sndrcvinfo.sinfo_context),
     UINT2NUM(sndrcvinfo.sinfo_timetolive),
     UINT2NUM(sndrcvinfo.sinfo_assoc_id),
-    v_notification
+    v_notification,
+    convert_sockaddr_in_to_struct(&clientaddr)
   );
 }
 
@@ -693,7 +810,7 @@ static VALUE rsctp_set_initmsg(VALUE self, VALUE v_options){
  * as follows:
  *
  *   :association
- *   - A change has occurred to an assocation, either a new one has begun or an existing one has end.
+ *   - A change has occurred to an association, either a new one has begun or an existing one has end.
  *
  *   :address
  *   - The state of one of the peer's addresses has experienced a change.
@@ -853,7 +970,7 @@ void Init_socket(){
 
   v_sndrcv_struct = rb_struct_define(
     "SendReceiveInfo", "message", "stream", "flags",
-    "ppid", "context", "ttl", "association_id", "notification", NULL
+    "ppid", "context", "ttl", "association_id", "notification", "client", NULL
   );
 
   v_assoc_change_struct = rb_struct_define(
@@ -895,6 +1012,10 @@ void Init_socket(){
     "AuthEvent", "type", "length", "key_number", "indication", "association_id", NULL
   );
 
+  v_sockaddr_in_struct = rb_struct_define(
+    "SockAddrIn", "family", "port", "address", NULL
+  );
+
   rb_define_method(cSocket, "initialize", rsctp_init, -1);
 
   rb_define_method(cSocket, "bind", rsctp_bind, -1);
@@ -905,6 +1026,7 @@ void Init_socket(){
   rb_define_method(cSocket, "listen", rsctp_listen, -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);
   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);
@@ -916,6 +1038,25 @@ void Init_socket(){
   rb_define_attr(cSocket, "association_id", 1, 1);
   rb_define_attr(cSocket, "port", 1, 1);
 
-  /* 0.0.2: The version of this library */
-  rb_define_const(cSocket, "VERSION", rb_str_new2("0.0.3"));
+  /* 0.0.4: The version of this library */
+  rb_define_const(cSocket, "VERSION", rb_str_new2("0.0.4"));
+
+  /* send flags */
+
+  /* Message is unordered */
+  rb_define_const(cSocket, "SCTP_UNORDERED", INT2NUM(SCTP_UNORDERED));
+
+  /* Override the primary address */
+  rb_define_const(cSocket, "SCTP_ADDR_OVER", INT2NUM(SCTP_ADDR_OVER));
+
+  /* Send an ABORT to peer */
+  rb_define_const(cSocket, "SCTP_ABORT", INT2NUM(SCTP_ABORT));
+
+  /* Start a shutdown procedure */
+  rb_define_const(cSocket, "SCTP_EOF", INT2NUM(SCTP_EOF));
+
+  /* Send to all associations */
+  rb_define_const(cSocket, "SCTP_SENDALL", INT2NUM(SCTP_SENDALL));
+
+  rb_define_const(cSocket, "MSG_NOTIFICATION", INT2NUM(MSG_NOTIFICATION));
 }

data/sctp-socket.gemspec

@@ -1,10 +1,9 @@
 Gem::Specification.new do |spec|
   spec.name        = 'sctp-socket'
-  spec.version     = '0.0.3'
+  spec.version     = '0.0.4'
   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-socket'
   spec.license     = 'Apache-2.0'
   spec.cert_chain  = ['certs/djberg96_pub.pem']
@@ -15,8 +14,14 @@ Gem::Specification.new do |spec|
 
   spec.extensions = ['ext/sctp/extconf.rb']
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rake-compiler'
-  spec.add_development_dependency 'rspec'
+  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.description = <<-EOF
+    The sctp-socket library provides Ruby bindings for SCTP sockets. is a
+    message oriented, reliable transport protocol with direct support for
+    multihoming.
+  EOF
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sctp-socket
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,65 +35,68 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Ruby bindings for SCTP sockets
+        version: '3.9'
+description: |2
+      The sctp-socket library provides Ruby bindings for SCTP sockets. is a
+      message oriented, reliable transport protocol with direct support for
+      multihoming.
 email: djberg96@gmail.com
 executables: []
 extensions: