sctp-socket 0.1.4 → 0.2.1

data/lib/sctp/server.rb

@@ -0,0 +1,207 @@
+require 'socket'
+require 'sctp/socket'
+
+module SCTP
+  # SCTP::Server provides a TCPServer-like interface for SCTP sockets.
+  #
+  # Unlike TCP which uses accept() to create new sockets for each connection,
+  # SCTP can operate in one-to-many mode where a single socket handles
+  # multiple associations. This server class provides both modes:
+  #
+  # 1. One-to-many mode (default): All connections share the server socket
+  # 2. One-to-one mode: Uses peeloff() to create individual sockets per association
+  #
+  # Example usage:
+  #
+  #   # Basic one-to-many server
+  #   server = SCTP::Server.new(['127.0.0.1'], 9999)
+  #   loop do
+  #     data, info = server.recvmsg
+  #     puts "Received: #{data} from association #{info.association_id}"
+  #     server.sendmsg("Echo: #{data}", association_id: info.association_id)
+  #   end
+  #
+  #   # One-to-one server with peeloff
+  #   server = SCTP::Server.new(['127.0.0.1'], 9999, one_to_one: true)
+  #   loop do
+  #     client = server.accept  # Returns a new SCTP::Socket for the association
+  #     Thread.new(client) do |c|
+  #       data, info = c.recvmsg
+  #       c.sendmsg("Echo: #{data}")
+  #       c.close
+  #     end
+  #   end
+  #
+  class Server
+    attr_reader :socket, :addresses, :port, :one_to_one
+
+    # Create a new SCTP server.
+    #
+    # @param addresses [Array<String>, String, nil] IP addresses to bind to.
+    #   If nil, binds to all available addresses.
+    # @param port [Integer] Port number to bind to
+    # @param one_to_one [Boolean] If true, uses one-to-one mode with peeloff.
+    #   If false (default), uses one-to-many mode.
+    # @param backlog [Integer] Listen backlog (default: 128)
+    # @param socket_options [Hash] Additional socket options
+    def initialize(addresses = nil, port = 0, one_to_one: false, backlog: 128, **socket_options)
+      @addresses = Array(addresses) if addresses
+      @port = port
+      @one_to_one = one_to_one
+      @backlog = backlog
+      @socket_options = socket_options
+      @pending_associations = {}
+
+      # Create the main server socket
+      if one_to_one
+        @socket = SCTP::Socket.new(2, 1)  # AF_INET, SOCK_STREAM
+      else
+        @socket = SCTP::Socket.new(2, 5)  # AF_INET, SOCK_SEQPACKET
+      end
+
+      setup_socket
+      bind_and_listen
+    end
+
+    # Accept a new association (one-to-one mode only).
+    #
+    # In one-to-many mode, this method is not used. Instead, use recvmsg
+    # to receive data from any association.
+    #
+    # @return [SCTP::Socket] A new socket for the accepted association
+    # @raise [RuntimeError] If not in one-to-one mode
+    def accept
+      raise "accept() only available in one-to-one mode" unless @one_to_one
+
+      # Wait for a message to establish an association
+      data, info = @socket.recvmsg
+      association_id = info.association_id
+
+      # Check if we already have a peeled-off socket for this association
+      if @pending_associations[association_id]
+        client_socket = @pending_associations.delete(association_id)
+      else
+        # Peeloff a new socket for this association
+        client_socket = @socket.peeloff(association_id)
+      end
+
+      # Store the initial message in the client socket for retrieval
+      client_socket.instance_variable_set(:@initial_message, [data, info])
+
+      # Add a method to retrieve the initial message
+      def client_socket.initial_message
+        @initial_message
+      end
+
+      client_socket
+    end
+
+    # Receive a message from any association (one-to-many mode).
+    #
+    # @param flags [Integer] Receive flags (default: 0)
+    # @return [Array<String, Struct>] Message data and info struct
+    def recvmsg(flags = 0)
+      @socket.recvmsg(flags)
+    end
+
+    # Send a message to a specific association (one-to-many mode).
+    #
+    # @param data [String] Data to send
+    # @param options [Hash] Send options including :association_id
+    # @return [Integer] Number of bytes sent
+    def sendmsg(data, **options)
+      @socket.sendmsg(options.merge(message: data))
+    end
+
+    # Get local addresses bound to this server.
+    #
+    # @return [Array<String>] Local addresses
+    def addr
+      @socket.getlocalnames
+    end
+
+    # Get the local port number.
+    #
+    # @return [Integer] Port number
+    def local_port
+      @socket.port
+    end
+
+    # Check if the server is closed.
+    #
+    # @return [Boolean] true if closed, false otherwise
+    def closed?
+      @socket.closed?
+    end
+
+    # Close the server socket.
+    #
+    # @param options [Hash] Close options (e.g., linger: seconds)
+    def close(**options)
+      @socket.close(options) unless closed?
+    end
+
+    # Get server socket information.
+    #
+    # @return [String] String representation of the server
+    def to_s
+      if closed?
+        "#<SCTP::Server:closed>"
+      else
+        mode = @one_to_one ? "one-to-one" : "one-to-many"
+        "#<SCTP::Server:#{addr.join(',')}:#{local_port} (#{mode})>"
+      end
+    end
+
+    alias_method :inspect, :to_s
+
+    private
+
+    def setup_socket
+      # Apply any socket options provided
+      @socket_options.each do |option, value|
+        case option
+        when :reuse_addr
+          # SCTP typically doesn't need SO_REUSEADDR like TCP
+          # but we can support it for compatibility
+        when :autoclose
+          @socket.autoclose = value
+        when :nodelay
+          @socket.nodelay = value
+        when :init_msg
+          @socket.set_initmsg(value)
+        when :subscriptions
+          @socket.subscribe(value)
+        else
+          # For any other options, try to call them as methods
+          if @socket.respond_to?("#{option}=")
+            @socket.send("#{option}=", value)
+          end
+        end
+      end
+
+      # Set up default subscriptions for server operation
+      @socket.subscribe(
+        data_io: true,
+        association: true,
+        address: true,
+        send_failure: true,
+        shutdown: true
+      )
+    end
+
+    def bind_and_listen
+      if @addresses && !@addresses.empty?
+        @socket.bindx(port: @port, addresses: @addresses, reuse_addr: true)
+      else
+        # Bind to all available addresses
+        @socket.bindx(port: @port, reuse_addr: true)
+      end
+
+      @socket.listen(@backlog)
+
+      # Update port if it was auto-assigned (port 0)
+      @port = @socket.port if @port == 0
+    end
+  end
+end

data/sctp-socket.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name        = 'sctp-socket'
-  spec.version     = '0.1.4'
+  spec.version     = '0.2.1'
   spec.author      = 'Daniel Berger'
   spec.email       = 'djberg96@gmail.com'
   spec.summary     = 'Ruby bindings for SCTP sockets'
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.cert_chain  = ['certs/djberg96_pub.pem']
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|.github)/})
   end
 
   spec.extensions = ['ext/sctp/extconf.rb']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sctp-socket
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2025-02-01 00:00:00.000000000 Z
+date: 2025-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,8 +103,6 @@ extensions:
 - ext/sctp/extconf.rb
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
-- ".github/workflows/ruby.yml"
 - ".gitignore"
 - CHANGES.md
 - Gemfile
@@ -114,12 +112,13 @@ files:
 - Rakefile
 - certs/djberg96_pub.pem
 - examples/client_example.rb
+- examples/client_for_server_test.rb
+- examples/sctp_server_example.rb
 - examples/server_example.rb
+- examples/server_using_sctp_server.rb
 - ext/sctp/extconf.rb
 - ext/sctp/socket.c
-- ext/sctp/socket.h
-- ext/sctp/socket/client.c
-- ext/sctp/socket/server.c
+- lib/sctp/server.rb
 - sctp-socket.gemspec
 homepage: https://github.com/djberg96/sctp-socket
 licenses:

data/.github/FUNDING.yml

@@ -1,4 +0,0 @@
-# These are supported funding model platforms
-
-github: djberg96
-open_collective: daniel-berger

data/.github/workflows/ruby.yml

@@ -1,59 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches: [ main ]
-    paths-ignore:
-      - '**/*.md'
-  pull_request:
-    branches: [ main ]
-    paths-ignore:
-      - '**/*.md'
-  workflow_dispatch:
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['3.2', '3.3']
-    steps:
-    - uses: actions/checkout@v4
-    - name: Install SCTP headers
-      run: |
-          sudo apt-get install libsctp-dev lksctp-tools
-          sudo ip link add dummy1 type dummy
-          sudo ip link add dummy2 type dummy
-          sudo ip addr add 1.1.1.1/24 dev dummy1
-          sudo ip addr add 1.1.1.2/24 dev dummy2
-          sudo ip link set dummy1 up
-          sudo ip link set dummy2 up
-    - name: Setup Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Run Specs
-      run: bundle exec rake
-  freebsd:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - name: Test in FreeBSD
-      id: test
-      uses: vmactions/freebsd-vm@v1
-      with:
-        usesh: true
-        prepare: |
-          pkg install -y llvm ruby devel/ruby-gems sctplib git-tiny
-
-        run: |
-          git config --global --add safe.directory /home/runner/work/sctp-socket/sctp-socket
-          kldload sctp
-          ifconfig lo1 create
-          ifconfig lo1 1.1.1.1/24 up
-          ifconfig lo2 create
-          ifconfig lo2 1.1.1.2/24 up
-          gem install bundler --no-document
-          bundle install --quiet
-          bundle exec rake

data/ext/sctp/socket/client.c

@@ -1,7 +0,0 @@
-#include <sctp/socket.h>
-
-VALUE cClient;
-
-void Init_client(){
-  cClient = rb_define_class_under(cSocket, "Client", rb_cObject);
-}

data/ext/sctp/socket/server.c

@@ -1,7 +0,0 @@
-#include <sctp/socket.h>
-
-VALUE cServer;
-
-void Init_server(){
-  cServer = rb_define_class_under(cSocket, "Server", rb_cObject);
-}

data/ext/sctp/socket.h

@@ -1,18 +0,0 @@
-#ifndef SCTP_SOCKET_INCLUDED
-#define SCTP_SOCKET_INCLUDED
-
-#include <ruby.h>
-#include <netinet/sctp.h>
-
-VALUE rb_hash_aref2(VALUE, const char*);
-
-void Init_socket();
-void Init_server();
-void Init_client();
-
-extern VALUE mSCTP;
-extern VALUE cSocket;
-extern VALUE cClient;
-extern VALUE cServer;
-
-#endif