ffi-enet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3955bec45c5e95da5d98bd7517fe6957bcca3c2647dcfa3b3c44ecc53992f615
+  data.tar.gz: 902b7cc535d3fe42fce86e50623132a20f1f3ea353f6a3abb98d36ac4cc4d8cd
+SHA512:
+  metadata.gz: 77091b2a373cf343fa83a31dcf8fd9780335de0353626d812265e7135caa129976ce59594e64729813bbf328a7a98a71c3ab9f6d9f17958a15853cea8313ae54
+  data.tar.gz: feb77626faae4c063ccb95256b6dd73343364f8a628fe042737832d42ce35985205149fb45382f5f8e0b16df83987a56928f01373a9ac7db0a5c28a778c56e15

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-13
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Cyberarm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# FFI-ENet
+
+FFI interface to the [enet](http://sauerbraten.org/enet/) networking library.
+
+Also includes a [rENet](https://github.com/Dahrkael/rENet/)-like API for easy usage.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cyberarm/ffi-enet.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/examples/echo.rb

@@ -0,0 +1,60 @@
+require_relative "../lib/ffi-enet"
+require_relative "../lib/ffi-enet/renet"
+
+Thread.abort_on_exception = true
+
+thread = Thread.new do
+  @server = ENet::Server.new(host: "localhost", port: 3000, max_clients: 32, channels: 4, download_bandwidth: 0, upload_bandwidth: 0)
+  @server.use_compression(true)
+  # server.use_compression(false)
+
+  def @server.on_connection(client)
+    puts "[SERVER][ID #{client.id}] connected from #{client.address.host}:#{client.address.port}"
+    send_packet(client, "Hello World", reliable: true, channel: 1)
+  end
+
+  def @server.on_packet_received(client, data, channel)
+    puts "[SERVER][ID #{client.id}][TOTAL PACKETS: #{client.total_sent_packets}] #{data}"
+    send_packet(client, data, reliable: true, channel: 1)
+  end
+
+  def @server.on_disconnection(client)
+    puts "[SERVER][ID #{client.id}] disconnected from #{client.address.host}"
+    send_packet(client, "Goodbye World", reliable: true, channel: 1)
+  end
+
+  loop do
+    @server.update(1_000)
+  end
+end
+
+sleep 0.5
+
+connection = ENet::Connection.new(host: "localhost", port: 3000, channels: 4, download_bandwidth: 0, upload_bandwidth: 0)
+connection.use_compression(true)
+# connection.use_compression(false)
+
+def connection.on_connection
+  puts "[CONNECTION] CONNECTED TO SERVER"
+  send_packet("Hello World!", reliable: true, channel: 0)
+end
+
+def connection.on_packet_received(data, channel)
+  puts "[CONNECTION][CHANNEL #{channel}]: #{data}"
+
+  send_packet(data, reliable: true, channel: channel)
+end
+
+def connection.on_disconnection
+  puts "[CONNECTION] DISCONNECTED FROM SERVER"
+end
+
+connection.connect(5_000)
+
+while connection.online?
+  connection.update(1_000)
+  connection.disconnect(2_000)
+  @server.shutdown
+end
+
+thread.join

data/lib/ffi-enet/renet/client.rb

@@ -0,0 +1,59 @@
+module ENet
+  class Client
+    Address = Struct.new(:host, :port)
+
+    attr_reader :_peer, :id, :address
+    attr_reader :last_send_time, :last_receive_time, :last_round_trip_time, :round_trip_time, :packets_lost, :packet_loss,
+                :total_sent_packets, :total_sent_data, :total_received_packets, :total_received_data
+
+    def self.enet_host_address_to_ipv4(address)
+      str_ptr = FFI::MemoryPointer.new(:char, 256)
+      result = LibENet.enet_address_get_host_ip(address, str_ptr, str_ptr.size)
+      raise "Failed to get IPv4 address of enet address" unless result.zero?
+
+      str_ptr.read_string
+    end
+
+    def initialize(peer)
+      @_peer = peer
+
+      @id = @_peer[:connect_id]
+      @address = Address.new(Client.enet_host_address_to_ipv4(@_peer[:address]), @_peer[:address][:port])
+
+      @last_send_time = 0
+      @last_receive_time = 0
+      @last_round_trip_time = 0
+      @round_trip_time = 0
+      @packets_lost = 0
+      @packet_loss = 0
+
+      @total_sent_packets = 0
+      @total_sent_data = 0
+      @total_received_packets = 0
+      @total_received_data = 0
+
+      update_stats
+    end
+
+    def update_stats
+      # enet Peer data
+      @last_send_time = @_peer[:last_send_time]
+      @last_receive_time = @_peer[:last_send_time]
+      @last_round_trip_time = @_peer[:last_round_trip_time]
+      @round_trip_time = @_peer[:round_trip_time]
+      @packets_lost = @_peer[:packets_lost]
+      @packet_loss = @_peer[:packet_loss] # .to_f / LibENet::ENET_PEER_PACKET_LOSS_SCALE
+
+      # enet Host data
+      @total_sent_packets += @_peer[:host][:total_sent_packets]
+      @total_sent_data += @_peer[:host][:total_sent_data]
+      @total_received_packets += @_peer[:host][:total_received_packets]
+      @total_received_data += @_peer[:host][:total_received_data]
+
+      @_peer[:host][:total_sent_packets] = 0
+      @_peer[:host][:total_sent_data] = 0
+      @_peer[:host][:total_received_packets] = 0
+      @_peer[:host][:total_received_data] = 0
+    end
+  end
+end

data/lib/ffi-enet/renet/connection.rb

@@ -0,0 +1,127 @@
+module ENet
+  class Connection
+    attr_reader :client
+
+    def initialize(host:, port:, channels: 8, download_bandwidth: 0, upload_bandwidth: 0)
+      @host = host
+      @port = port
+      @channels = channels
+      @download_bandwidth = download_bandwidth
+      @upload_bandwidth = upload_bandwidth
+
+      @enet_event = LibENet::ENetEvent.new
+      @online = false
+
+      ENet.init
+
+      @_address = LibENet::ENetAddress.new
+      if LibENet.enet_address_set_host(@_address, @host) != 0
+        raise "Failed to set host"
+      end
+      @_address[:port] = @port
+
+      @_host = LibENet.enet_host_create(nil, 1, @channels, @download_bandwidth, @upload_bandwidth)
+
+      raise "Failed to create host" if @_host.nil?
+
+      @client = nil
+    end
+
+    def online?
+      @online
+    end
+
+    def connect(timeout_ms)
+      @_connection = LibENet.enet_host_connect(@_host, @_address, @channels, 0)
+      raise "Cannot connect to remote host" if @_connection.nil?
+
+      result = LibENet.enet_host_service(@_host, @enet_event, timeout_ms)
+
+      if result.positive? && @enet_event[:type] == :ENET_EVENT_TYPE_CONNECT
+        @online = true
+        @client = Client.new(@_connection)
+
+        on_connection
+      end
+    end
+
+    def disconnect(timeout_ms)
+      connected = online?
+
+      if connected
+        LibENet.enet_peer_disconnect(@_connection, 0)
+
+        while (result = LibENet.enet_host_service(@_host, @enet_event, 0)) && result.positive?
+
+          case @enet_event[:type]
+          when :ENET_EVENT_TYPE_RECEIVE
+            LibENet.enet_packet_destroy(@enet_event[:packet])
+
+          when :ENET_EVENT_TYPE_DISCONNECT
+            connected = false
+          end
+
+          break unless connected
+        end
+
+        LibENet.enet_peer_disconnect_now(@_connection, 0) if connected
+      end
+
+      connected
+    end
+
+    def send_packet(data, reliable:, channel:)
+      return unless online?
+
+      packet = LibENet.enet_packet_create(data, data.length, reliable ? 1 : 0)
+      LibENet.enet_peer_send(@_connection, channel, packet)
+    end
+
+    def send_queued_packets
+      LibENet.enet_host_flush(@_host) if online?
+    end
+
+    def flush
+      send_queued_packets
+    end
+
+    def update(timeout_ms)
+      result = LibENet.enet_host_service(@_host, @enet_event, timeout_ms)
+
+      if result.positive?
+        case @enet_event[:type]
+        when :ENET_EVENT_TYPE_RECEIVE
+          data = @enet_event[:packet][:data].read_string(@enet_event[:packet][:length])
+
+          on_packet_received(data, @enet_event[:channel_id])
+
+          LibENet.enet_packet_destroy(@enet_event[:packet])
+
+        when :ENET_EVENT_TYPE_DISCONNECT
+          @online = false
+        end
+      elsif result.negative?
+        warn "Connection: An error occurred: #{result}"
+      end
+
+      @client.update_stats if online?
+    end
+
+    def use_compression(bool)
+      if bool
+        LibENet.enet_host_compress_with_range_coder(@_host)
+      else
+        LibENet.enet_host_compress(@_host, nil)
+      end
+    end
+
+    def on_connection
+    end
+
+    def on_packet_received(data, channel)
+    end
+
+    def on_disconnection
+    end
+  end
+end

data/lib/ffi-enet/renet/server.rb

@@ -0,0 +1,127 @@
+module ENet
+  class Server
+    def self.release(pointer)
+    end
+
+    def initialize(host:, port:, max_clients: 16, channels: 8, download_bandwidth: 0, upload_bandwidth: 0)
+      @host = host
+      @port = port
+      @max_clients = max_clients
+      @channels = channels
+      @download_bandwidth = download_bandwidth
+      @upload_bandwidth = upload_bandwidth
+
+      @enet_event = LibENet::ENetEvent.new
+      @clients = {}
+
+      ENet.init
+
+      @_address = LibENet::ENetAddress.new
+      if LibENet.enet_address_set_host(@_address, @host) != 0
+        raise "Failed to set host"
+      end
+      @_address[:port] = @port
+
+      @_host = FFI::AutoPointer.new(LibENet.enet_host_create(@_address, @max_clients, @channels, @download_bandwidth, @upload_bandwidth).to_ptr, Server.method(:release))
+      raise "Failed to create server" if @_host.nil?
+    end
+
+    def disconnect_client(client)
+      LibENet.enet_peer_disconnect(client._peer, 0)
+    end
+
+    def disconnect_client!(client)
+      LibENet.enet_peer_disconnect_now(client._peer, 0)
+
+      on_disconnection(client)
+    end
+
+    def send_packet(client, data, reliable:, channel:)
+      packet = LibENet.enet_packet_create(data, data.length, reliable ? 1 : 0)
+      LibENet.enet_peer_send(client._peer, channel, packet)
+
+      # pp [
+      #   client.packets_sent,
+      #   client.packets_received,
+      #   client.data_sent,
+      #   client.data_received,
+
+      #   client.packets_lost,
+      #   client.packet_loss,
+
+      #   client.round_trip_time,
+      #   client.last_round_trip_time,
+
+      #   client.last_receive_time,
+      #   client.last_send_time
+      # ]
+    end
+
+    def broadcast_packet(data, reliable:, channel:)
+      packet = LibENet.enet_packet_create(data, data.length, reliable ? 1 : 0)
+      LibENet.enet_host_broadcast(@_host, channel, packet)
+    end
+
+    def send_queued_packets
+      LibENet.enet_host_flush(@_host)
+    end
+
+    def flush
+      send_queued_packets
+    end
+
+    def update(timeout_ms)
+      result = LibENet.enet_host_service(@_host, @enet_event, timeout_ms)
+
+      if result.positive?
+        case @enet_event[:type]
+        when :ENET_EVENT_TYPE_CONNECT
+          client = Client.new(@enet_event[:peer])
+          @clients[client] = @enet_event[:peer]
+
+          on_connection(client)
+
+        when :ENET_EVENT_TYPE_RECEIVE
+          client = @clients.find { |k, peer| peer.to_ptr == @enet_event[:peer].to_ptr }.first
+          data = @enet_event[:packet][:data].read_string(@enet_event[:packet][:length])
+
+          client.update_stats
+          on_packet_received(client, data, @enet_event[:channel_id])
+
+          LibENet.enet_packet_destroy(@enet_event[:packet])
+
+        when :ENET_EVENT_TYPE_DISCONNECT
+          # FIXME: This might not work if peer pointer is invalid
+          client = @clients.find { |k, peer| peer.to_ptr == @enet_event[:peer].to_ptr }.first
+          @clients.delete(client)
+
+          on_disconnection(client)
+        end
+      elsif result.negative?
+        warn "Server: An error occurred: #{result}"
+      end
+    end
+
+    def shutdown
+      LibENet.enet_host_flush(@_host)
+      LibENet.enet_host_destroy(@_host)
+    end
+
+    def use_compression(bool)
+      if bool
+        LibENet.enet_host_compress_with_range_coder(@_host)
+      else
+        LibENet.enet_host_compress(@_host, nil)
+      end
+    end
+
+    def on_connection(client)
+    end
+
+    def on_packet_received(client, data, channel)
+    end
+
+    def on_disconnection(client)
+    end
+  end
+end

data/lib/ffi-enet/renet.rb

@@ -0,0 +1,34 @@
+require_relative "renet/server"
+require_relative "renet/connection"
+require_relative "renet/client"
+
+module ENet
+  @@initialized = false
+  @@at_exit_handler = false
+
+  def self.init
+    return true if @@initialized
+
+    return false if LibENet.enet_initialize != 0
+
+    @@initialized = true
+
+    unless @@at_exit_handler
+      @@at_exit_handler = true
+
+      at_exit do
+        shutdown
+      end
+    end
+
+    true
+  end
+
+  def self.shutdown
+    return unless @@initialized
+
+    LibENet.enet_deinitialize
+
+    @@initialized = false
+  end
+end

data/lib/ffi-enet/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ENet
+  VERSION = "0.1.0"
+end

data/lib/ffi-enet.rb

@@ -0,0 +1,438 @@
+require "ffi"
+require_relative "ffi-enet/version"
+
+module LibENet
+  extend FFI::Library
+  ffi_lib [
+    "#{File.expand_path(__dir__)}#{RUBY_PLATFORM.match?(/^x86_64-/) ? "/../lib64" : ""}/libenet.so",
+    "#{File.expand_path(__dir__)}#{RUBY_PLATFORM.match?(/^x64-/) ? "/../lib64" : ""}/libenet.dll",
+    "enet"
+  ]
+
+  # "Constants"
+  ENET_PROTOCOL_MINIMUM_MTU = 576
+  ENET_PROTOCOL_MAXIMUM_MTU = 4096
+  ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS = 32
+  ENET_PROTOCOL_MINIMUM_WINDOW_SIZE = 4096
+  ENET_PROTOCOL_MAXIMUM_WINDOW_SIZE = 65536
+  ENET_PROTOCOL_MINIMUM_CHANNEL_COUNT = 1
+  ENET_PROTOCOL_MAXIMUM_CHANNEL_COUNT = 255
+  ENET_PROTOCOL_MAXIMUM_PEER_ID = 0xFFF
+  ENET_PROTOCOL_MAXIMUM_FRAGMENT_COUNT = 1024 * 1024
+
+  ENET_BUFFER_MAXIMUM = (1 + 2 * ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS)
+
+  ENET_HOST_RECEIVE_BUFFER_SIZE = 256 * 1024,
+    ENET_HOST_SEND_BUFFER_SIZE = 256 * 1024,
+    ENET_HOST_BANDWIDTH_THROTTLE_INTERVAL = 1000,
+    ENET_HOST_DEFAULT_MTU = 1392,
+    ENET_HOST_DEFAULT_MAXIMUM_PACKET_SIZE = 32 * 1024 * 1024,
+    ENET_HOST_DEFAULT_MAXIMUM_WAITING_DATA = 32 * 1024 * 1024,
+
+    ENET_PEER_DEFAULT_ROUND_TRIP_TIME = 500,
+    ENET_PEER_DEFAULT_PACKET_THROTTLE = 32,
+    ENET_PEER_PACKET_THROTTLE_SCALE = 32,
+    ENET_PEER_PACKET_THROTTLE_COUNTER = 7,
+    ENET_PEER_PACKET_THROTTLE_ACCELERATION = 2,
+    ENET_PEER_PACKET_THROTTLE_DECELERATION = 2,
+    ENET_PEER_PACKET_THROTTLE_INTERVAL = 5000,
+    ENET_PEER_PACKET_LOSS_SCALE = (1 << 16),
+    ENET_PEER_PACKET_LOSS_INTERVAL = 10000,
+    ENET_PEER_WINDOW_SIZE_SCALE = 64 * 1024,
+    ENET_PEER_TIMEOUT_LIMIT = 32,
+    ENET_PEER_TIMEOUT_MINIMUM = 5000,
+    ENET_PEER_TIMEOUT_MAXIMUM = 30000,
+    ENET_PEER_PING_INTERVAL = 500,
+    ENET_PEER_UNSEQUENCED_WINDOWS = 64,
+    ENET_PEER_UNSEQUENCED_WINDOW_SIZE = 1024,
+    ENET_PEER_FREE_UNSEQUENCED_WINDOWS = 32,
+    ENET_PEER_RELIABLE_WINDOWS = 16,
+    ENET_PEER_RELIABLE_WINDOW_SIZE = 0x1000,
+    ENET_PEER_FREE_RELIABLE_WINDOWS = 8
+
+  # Enums
+  ENetEventType = enum(
+    :ENET_EVENT_TYPE_NONE,
+    :ENET_EVENT_TYPE_CONNECT,
+    :ENET_EVENT_TYPE_DISCONNECT,
+    :ENET_EVENT_TYPE_RECEIVE
+  )
+
+  ENetPeerState = enum(
+    :ENET_PEER_STATE_DISCONNECTED,
+    :ENET_PEER_STATE_CONNECTING,
+    :ENET_PEER_STATE_ACKNOWLEDGING_CONNECT,
+    :ENET_PEER_STATE_CONNECTION_PENDING,
+    :ENET_PEER_STATE_CONNECTION_SUCCEEDED,
+    :ENET_PEER_STATE_CONNECTED,
+    :ENET_PEER_STATE_DISCONNECT_LATER,
+    :ENET_PEER_STATE_DISCONNECTING,
+    :ENET_PEER_STATE_ACKNOWLEDGING_DISCONNECT,
+    :ENET_PEER_STATE_ZOMBIE
+  )
+
+  # ENetSocketOption = enum(
+  #   :ENET_SOCKOPT_NONBLOCK,
+  #   :ENET_SOCKOPT_BROADCAST,
+  #   :ENET_SOCKOPT_RCVBUF,
+  #   :ENET_SOCKOPT_SNDBUF,
+  #   :ENET_SOCKOPT_REUSEADDR,
+  #   :ENET_SOCKOPT_RCVTIMEO,
+  #   :ENET_SOCKOPT_SNDTIMEO,
+  #   :ENET_SOCKOPT_ERROR,
+  #   :ENET_SOCKOPT_NODELAY
+  # )
+
+  # ENetSocketType = enum(
+  #   :ENET_SOCKET_TYPE_STREAM,
+  #   :ENET_SOCKET_TYPE_DATAGRAM
+  # )
+
+  # Structs
+  class ENetAddress < FFI::Struct
+    layout :host, :uint32,
+      :port, :ushort
+  end
+
+  class ENetPacket < FFI::Struct
+    layout :_ref_count, :size_t,
+      :flags, :uint32,
+      :data, :pointer,
+      :length, :short,
+      :callback, :pointer,
+      :user_data, :pointer
+  end
+
+  # Why on earth would you do this? They're the same types...
+  if FFI::Platform.windows?
+    # Windows O_o
+    class ENetBuffer < FFI::Struct
+      layout :length, :size_t,
+        :data, :pointer
+    end
+  else
+    # Unix o_O
+    class ENetBuffer < FFI::Struct
+      layout :data, :pointer,
+        :length, :size_t
+    end
+  end
+
+  class ENetCompressor < FFI::Struct
+    layout :context, :pointer,
+      :compress, :pointer, # FIXME: http://sauerbraten.org/enet/structENetCompressor.html
+      :decompress, :pointer, # FIXME
+      :destroy, :pointer  # FIXME
+  end
+
+  class ENetListNode < FFI::Struct
+    layout :nxt, ENetListNode.by_ref,
+      :previous, ENetListNode.by_ref
+  end
+
+  class ENetList < FFI::Struct
+    layout :sentinel, ENetListNode
+  end
+
+  class ENetProtocolHeader < FFI::Struct
+    layout :peer_id, :ushort,
+      :sent_time, :ushort
+  end
+
+  class ENetProtocolCommandHeader < FFI::Struct
+    layout :command, :uchar,
+      :channel_id, :uchar,
+      :reliable_sequence_number, :ushort
+  end
+
+  class ENetProtocolAcknowledge < FFI::Struct
+    layout :header, ENetProtocolCommandHeader,
+      :received_reliable_sequence_number, :ushort,
+      :received_sent_time, :ushort
+  end
+
+  class ENetProtocolConnect < FFI::Struct
+    layout :header, ENetProtocolCommandHeader,
+      :outgoingPeerID, :ushort,
+      :incomingSessionID, :uchar,
+      :outgoingSessionID, :uchar,
+      :mtu, :uint32,
+      :windowSize, :uint32,
+      :channelCount, :uint32,
+      :incomingBandwidth, :uint32,
+      :outgoingBandwidth, :uint32,
+      :packetThrottleInterval, :uint32,
+      :packetThrottleAcceleration, :uint32,
+      :packetThrottleDeceleration, :uint32,
+      :connectID, :uint32,
+      :data, :uint32
+  end
+
+  class ENetProtocolVerifyConnect < FFI::Struct
+    layout :header, ENetProtocolCommandHeader,
+      :outgoingPeerID, :ushort,
+      :incomingSessionID, :uchar,
+      :outgoingSessionID, :uchar,
+      :mtu, :uint32,
+      :windowSize, :uint32,
+      :channelCount, :uint32,
+      :incomingBandwidth, :uint32,
+      :outgoingBandwidth, :uint32,
+      :packetThrottleInterval, :uint32,
+      :packetThrottleAcceleration, :uint32,
+      :packetThrottleDeceleration, :uint32,
+      :connectID, :uint32
+  end
+
+  class ENetProtocolBandwidthLimit < FFI::Struct
+    layout :header, ENetProtocolCommandHeader,
+      :incomingBandwidth, :uint32,
+      :outgoingBandwidth, :uint32
+  end
+
+  class ENetProtocolThrottleConfigure < FFI::Struct
+    layout :header, ENetProtocolCommandHeader,
+      :packetThrottleInterval, :uint32,
+      :packetThrottleAcceleration, :uint32,
+      :packetThrottleDeceleration, :uint32
+  end
+
+  class ENetProtocolDisconnect < FFI::Struct
+    layout :header, ENetProtocolCommandHeader,
+      :data, :uint32
+  end
+
+  class ENetProtocolPing < FFI::Struct
+    layout :header, ENetProtocolCommandHeader
+  end
+
+  class ENetProtocolSendReliable < FFI::Struct
+    layout :header, ENetProtocolCommandHeader,
+      :dataLength, :ushort
+  end
+
+  class ENetProtocolSendUnreliable < FFI::Struct
+    layout :header, ENetProtocolCommandHeader,
+      :unreliableSequenceNumber, :ushort,
+      :dataLength, :ushort
+  end
+
+  class ENetProtocolSendUnsequenced < FFI::Struct
+    layout :header, ENetProtocolCommandHeader,
+      :unsequencedGroup, :ushort,
+      :dataLength, :ushort
+  end
+
+  class ENetProtocolSendFragment < FFI::Struct
+    layout :header, ENetProtocolCommandHeader,
+      :startSequenceNumber, :ushort,
+      :dataLength, :ushort,
+      :fragmentCount, :uint32,
+      :fragmentNumber, :uint32,
+      :totalLength, :uint32,
+      :fragmentOffset, :uint32
+  end
+
+  class ENetProtocol < FFI::Union
+    layout :header, ENetProtocolCommandHeader,
+      :acknowledge, ENetProtocolAcknowledge,
+      :connect, ENetProtocolConnect,
+      :verifyConnect, ENetProtocolVerifyConnect,
+      :disconnect, ENetProtocolDisconnect,
+      :ping, ENetProtocolPing,
+      :sendReliable, ENetProtocolSendReliable,
+      :sendUnreliable, ENetProtocolSendUnreliable,
+      :sendUnsequenced, ENetProtocolSendUnsequenced,
+      :sendFragment, ENetProtocolSendFragment,
+      :bandwidthLimit, ENetProtocolBandwidthLimit,
+      :throttleConfigure, ENetProtocolThrottleConfigure
+  end
+
+  if FFI::Platform.windows?
+    typedef(:uint64, :ENetSocket)
+  else
+    typedef(:int, :ENetSocket) # FIXME: Test this on Linux
+  end
+
+  class ENetHost < FFI::Struct
+    layout :socket, :ENetSocket,
+      :address, ENetAddress,
+      :incoming_bandwidth, :uint32,
+      :outgoing_bandwidth, :uint32,
+      :bandwidth_throttle_epoch, :uint32,
+      :mtu, :uint32,
+      :random_seed, :uint32,
+      :recalculate_bandwidth_limits, :int,
+      :peers, :pointer, # Array of ENetPeer
+      :peer_count, :size_t,
+      :channel_limit, :size_t,
+      :service_time, :uint32,
+      :dispatch_queue, :pointer, # ENetList
+      :total_queued, :uint32,
+      :packet_size, :size_t,
+      :header_flags, :ushort,
+      :commands, [ENetProtocol, ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS],
+      :command_count, :size_t,
+      :buffers, [ENetBuffer, ENET_BUFFER_MAXIMUM],
+      :buffer_count, :size_t,
+      :checksum, :pointer, # ENetChecksumCallback
+      :compressor, ENetCompressor,
+      :packet_data, [:uchar, 2 * ENET_PROTOCOL_MAXIMUM_MTU], # NOTE: This may be wrong size/offset/length... using a 1d array here, instead of [2][ENET_PROTOCOL_MAXIMUM_MTU]; FFI docs don't seem to show how to do a multidimentional array.
+      :received_address, ENetAddress,
+      :received_data, :string,
+      :received_data_length, :size_t,
+      :total_sent_data, :uint32,
+      :total_sent_packets, :uint32,
+      :total_received_data, :uint32,
+      :total_received_packets, :uint32,
+      :intercept, :pointer, # ENetInterceptCallback
+      :connected_peers, :size_t,
+      :bandwidth_limited_peers, :size_t,
+      :duplicate_peers, :size_t,
+      :maximum_packet_size, :size_t,
+      :maximum_waiting_data, :size_t
+  end
+
+  # FIXME: Layout is wrong due to doxygen alphabetizing fields...
+  class ENetPeer < FFI::Struct
+    layout :dispatchList, ENetListNode,
+      :host, ENetHost,
+      :outgoing_peer_id, :ushort,
+      :incoming_peer_id, :ushort,
+      :connect_id, :uint32,
+      :outgoing_session_id, :uchar,
+      :incoming_session_id, :uchar,
+      :address, ENetAddress,
+      :data, :pointer,
+      :state, ENetPeerState,
+      :channels, :pointer, # ENetChannel
+      :channel_count, :size_t,
+      :incoming_bandwidth, :uint32,
+      :outgoing_bandwidth, :uint32,
+      :incoming_bandwidth_throttle_epoch, :uint32,
+      :outgoing_bandwidth_throttle_epoch, :uint32,
+      :incoming_data_total, :uint32,
+      :outgoing_data_total, :uint32,
+      :last_send_time, :uint32,
+      :last_receive_time, :uint32,
+      :next_timeout, :uint32,
+      :earliest_timeout, :uint32,
+      :packet_loss_epoch, :uint32,
+      :packets_sent, :uint32,
+      :packets_lost, :uint32,
+      :packet_loss, :uint32, # mean packet loss of reliable packets as a ratio with respect to the constant ENET_PEER_PACKET_LOSS_SCALE
+      :packet_loss_variance, :uint32,
+      :packet_throttle, :uint32,
+      :packet_throttle_limit, :uint32,
+      :packet_throttle_counter, :uint32,
+      :packet_throttle_epoch, :uint32,
+      :packet_throttle_acceleration, :uint32,
+      :packet_throttle_deceleration, :uint32,
+      :packet_throttle_interval, :uint32,
+      :ping_interval, :uint32,
+      :timeout_limit, :uint32,
+      :timeout_minimum, :uint32,
+      :timeout_maximum, :uint32,
+      :last_round_trip_time, :uint32,
+      :lowest_round_trip_time, :uint32,
+      :last_round_trip_time_variance, :uint32,
+      :highest_round_trip_time_variance, :uint32,
+      :round_trip_time, :uint32, # mean round trip time (RTT), in milliseconds, between sending a reliable packet and receiving its acknowledgement
+      :round_trip_time_variance, :uint32,
+      :mtu, :uint32,
+      :window_size, :uint32,
+      :reliable_data_in_transit, :uint32,
+      :outgoing_reliable_sequence_number, :ushort,
+      :acknowledgements, ENetList,
+      :sent_reliable_commands, ENetList,
+      :outgoing_send_reliable_commands, ENetList,
+      :outgoing_commands, ENetList,
+      :dispatched_commands, ENetList,
+      :flags, :ushort,
+      :reserved, :ushort,
+      :incoming_unsequenced_group, :ushort,
+      :outgoing_unsequenced_group, :ushort,
+      :unsequenced_window, [:uint32, ENET_PEER_UNSEQUENCED_WINDOW_SIZE / 32],
+      :event_data, :uint32,
+      :total_waiting_data, :size_t
+  end
+
+  class ENetEvent < FFI::Struct
+    layout :type, ENetEventType,
+      :peer, ENetPeer.by_ref,
+      :channel_id, :uchar,
+      :data, :uint32,
+      :packet, ENetPacket.by_ref
+  end
+
+  # Global
+  attach_function :enet_deinitialize, [], :void
+  attach_function :enet_initialize, [], :void
+  attach_function :enet_initialize_with_callbacks, [:uint32, :pointer], :void # FIXME
+  attach_function :enet_linked_version, [], :int
+
+  # Address
+  attach_function :enet_address_get_host, [ENetAddress.by_ref, :pointer, :size_t], :int
+  attach_function :enet_address_get_host_ip, [ENetAddress.by_ref, :pointer, :size_t], :int
+  attach_function :enet_address_set_host, [ENetAddress.by_ref, :string], :int
+  attach_function :enet_address_set_host_ip, [ENetAddress.by_ref, :string], :int
+
+  # Host
+  attach_function :enet_host_bandwidth_limit, [ENetHost, :uint32, :uint32], :void
+  attach_function :enet_host_broadcast, [ENetHost, :uchar, :pointer], :void
+  attach_function :enet_host_channel_limit, [ENetHost, :size_t], :void
+  attach_function :enet_host_check_events, [ENetHost, ENetEvent.by_ref], :int
+  attach_function :enet_host_compress, [ENetHost, ENetCompressor.by_ref], :int
+  attach_function :enet_host_compress_with_range_coder, [ENetHost], :int
+  attach_function :enet_host_connect, [ENetHost, ENetAddress.by_ref, :size_t, :uint32], ENetPeer.by_ref
+  attach_function :enet_host_create, [ENetAddress.by_ref, :size_t, :size_t, :uint32, :uint32], ENetHost
+  attach_function :enet_host_destroy, [ENetHost], :void
+  attach_function :enet_host_flush, [ENetHost], :void
+  attach_function :enet_host_service, [ENetHost, ENetEvent.by_ref, :uint32], :int, blocking: true
+
+  # Packet
+  attach_function :enet_crc32, [:pointer, :size_t], :uint32
+  attach_function :enet_packet_create, [:string, :size_t, :uint32], ENetPacket.by_ref
+  attach_function :enet_packet_destroy, [ENetPacket.by_ref], :void
+  attach_function :enet_packet_resize, [ENetHost, :size_t], :int
+
+  # Peer
+  attach_function :enet_peer_disconnect, [ENetPeer.by_ref, :uint32], :void
+  attach_function :enet_peer_disconnect_later, [ENetPeer.by_ref, :uint32], :void
+  attach_function :enet_peer_disconnect_now, [ENetPeer.by_ref, :uint32], :void
+  attach_function :enet_peer_ping, [ENetPeer.by_ref], :void
+  attach_function :enet_peer_ping_interval, [ENetPeer.by_ref, :uint32], :void
+  attach_function :enet_peer_receive, [ENetPeer.by_ref, :uchar], ENetPacket.by_ref # FIXME
+  attach_function :enet_peer_reset, [ENetPeer.by_ref], :void
+  attach_function :enet_peer_send, [ENetPeer.by_ref, :ushort, ENetPacket.by_ref], :int
+  attach_function :enet_peer_throttle_configure, [ENetPeer.by_ref, :uint32, :uint32, :uint32], :void
+  attach_function :enet_peer_timeout, [ENetPeer.by_ref, :uint32, :uint32, :uint32], :void
+
+  # Range Coder
+  attach_function :enet_range_coder_compress, [:pointer, ENetBuffer.by_ref, :size_t, :size_t, :uchar, :size_t], :size_t
+  attach_function :enet_range_coder_create, [], :pointer
+  attach_function :enet_range_coder_decompress, [:pointer, :ushort, :size_t, :ushort, :size_t], :size_t
+  attach_function :enet_range_coder_destroy, [:pointer], :void
+
+  # Socket
+  # typedef(:int, :ENetSocket)
+
+  # attach_function :enet_socket_accept, [:ENetSocket, ENetAddress.by_ref], :ENetSocket
+  # attach_function :enet_socket_bind, [:ENetSocket, ENetAddress.by_ref], :int
+  # attach_function :enet_socket_connect, [:ENetSocket, ENetAddress.by_ref], :int
+  # attach_function :enet_socket_create, [:uint32], :ENetSocket
+  # attach_function :enet_socket_destroy, [:ENetSocket], :void
+  # attach_function :enet_socket_get_address, [:ENetSocket, ENetAddress.by_ref], :int
+  # attach_function :enet_socket_get_option, [:ENetSocket, ENetSocketOption, :int], :int
+  # attach_function :enet_socket_listen, [:ENetSocket, :int], :int
+  # attach_function :enet_socket_receive, [:ENetSocket, ENetAddress.by_ref, ENetBuffer.by_ref, :size_t], :int
+  # attach_function :enet_socket_send, [:ENetSocket, ENetAddress.by_ref, ENetBuffer.by_ref, :size_t], :int
+  # attach_function :enet_socket_set_option, [:ENetSocket, ENetSocketOption, :pointer], :int
+  # attach_function :enet_socket_shutdown, [:ENetSocket, ENetSocketShutdown], :int
+  # attach_function :enet_socket_wait, [:ENetSocket, :pointer, :uint32], :int
+  # attach_function :enet_socketset_select, [:ENetSocket, ENetSocketSet.by_ref, ENetSocketSet.by_ref, :uint32], :int
+
+  # Time
+  attach_function :enet_time_get, [], :uint32
+  attach_function :enet_time_set, [:uint32], :void
+end

data/sig/enet.rbs

@@ -0,0 +1,4 @@
+module Enet
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: ffi-enet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cyberarm
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: FFI interface to the enet networking library. Includes rENet-like API
+  to simplify enet usage.
+email:
+- matthewlikesrobots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/echo.rb
+- lib/ffi-enet.rb
+- lib/ffi-enet/renet.rb
+- lib/ffi-enet/renet/client.rb
+- lib/ffi-enet/renet/connection.rb
+- lib/ffi-enet/renet/server.rb
+- lib/ffi-enet/version.rb
+- lib64/libenet.dll
+- lib64/libenet.so
+- sig/enet.rbs
+homepage: https://github.com/cyberarm/ffi-enet
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/cyberarm/ffi-enet
+  source_code_uri: https://github.com/cyberarm/ffi-enet
+  changelog_uri: https://github.com/cyberarm/ffi-enet/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- lib64
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: FFI interface to the enet networking library.
+test_files: []