nng-ruby 0.1.1 → 0.1.2

data/examples/protobuf_thread.rb

@@ -0,0 +1,236 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# NNG + Protocol Buffers 示例 (使用线程)
+# 演示 NNG 与 Protobuf 配合使用
+
+require 'nng'
+require 'google/protobuf'
+
+puts "=" * 70
+puts "NNG + Protocol Buffers 完整示例"
+puts "=" * 70
+puts
+
+# ============================================================================
+# 定义 Protobuf 消息
+# ============================================================================
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("rpc.proto", syntax: :proto3) do
+    # RPC 请求
+    add_message "RpcRequest" do
+      optional :func_code, :int32, 1
+      optional :data, :bytes, 2
+      optional :request_id, :string, 3
+    end
+
+    # RPC 响应
+    add_message "RpcResponse" do
+      optional :status, :int32, 1
+      optional :data, :bytes, 2
+      optional :error_msg, :string, 3
+    end
+
+    # 联系人
+    add_message "Contact" do
+      optional :wxid, :string, 1
+      optional :name, :string, 2
+    end
+
+    # 联系人列表
+    add_message "ContactList" do
+      repeated :contacts, :message, 1, "Contact"
+    end
+  end
+end
+
+RpcRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("RpcRequest").msgclass
+RpcResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("RpcResponse").msgclass
+Contact = Google::Protobuf::DescriptorPool.generated_pool.lookup("Contact").msgclass
+ContactList = Google::Protobuf::DescriptorPool.generated_pool.lookup("ContactList").msgclass
+
+puts "✅ Protobuf 消息定义完成"
+puts
+
+# ============================================================================
+# 示例: 获取联系人列表 (使用嵌套的 Protobuf 消息)
+# ============================================================================
+
+puts "示例: RPC 调用 - 获取联系人列表"
+puts "=" * 70
+puts
+
+url = "inproc://contacts_demo"  # 使用 inproc 避免端口冲突
+
+# 创建 server socket (必须在 client 之前)
+server_socket = NNG::Socket.new(:pair1)
+server_socket.listen(url)
+server_ready = true
+puts "✅ 服务器监听: #{url}"
+puts
+
+# 服务器线程
+server_thread = Thread.new do
+  begin
+    # 接收 RPC 请求
+    request_data = server_socket.recv
+    puts "📥 [服务器] 收到请求 (#{request_data.bytesize} bytes)"
+
+    # 反序列化 RPC 请求
+    rpc_request = RpcRequest.decode(request_data)
+    puts "📋 [服务器] 解析 RPC 请求:"
+    puts "    Function Code: 0x#{rpc_request.func_code.to_s(16)}"
+    puts "    Request ID: #{rpc_request.request_id}"
+    puts
+
+    # 构建联系人列表 (嵌套消息)
+    contacts = ContactList.new(
+      contacts: [
+        Contact.new(wxid: "wxid_001", name: "张三"),
+        Contact.new(wxid: "wxid_002", name: "李四"),
+        Contact.new(wxid: "wxid_003", name: "王五"),
+        Contact.new(wxid: "chatroom_001", name: "技术交流群")
+      ]
+    )
+
+    puts "🏗️  [服务器] 构建联系人列表:"
+    puts "    联系人数量: #{contacts.contacts.size}"
+    contacts.contacts.each_with_index do |contact, i|
+      puts "    #{i + 1}. #{contact.name} (#{contact.wxid})"
+    end
+    puts
+
+    # 序列化联系人列表 (内层)
+    contacts_data = ContactList.encode(contacts)
+    puts "📦 [服务器] 序列化联系人列表: #{contacts_data.bytesize} bytes"
+
+    # 构建 RPC 响应 (外层)
+    rpc_response = RpcResponse.new(
+      status: 0,
+      data: contacts_data,
+      error_msg: ""
+    )
+
+    # 序列化 RPC 响应
+    response_data = RpcResponse.encode(rpc_response)
+    puts "📦 [服务器] 序列化 RPC 响应: #{response_data.bytesize} bytes"
+
+    # 发送响应
+    server_socket.send(response_data)
+    puts "📤 [服务器] 响应已发送"
+    puts
+
+  rescue => e
+    puts "❌ [服务器] 错误: #{e.message}"
+  end
+end
+
+# 等待服务器准备好
+sleep 0.1
+
+# ============================================================================
+# 客户端
+# ============================================================================
+
+puts "📞 [客户端] 发起 RPC 调用..."
+puts
+
+begin
+  # 创建 client socket
+  client_socket = NNG::Socket.new(:pair1)
+  client_socket.dial(url)
+  puts "✅ [客户端] 连接: #{url}"
+  puts
+
+  # 构建 RPC 请求
+  rpc_request = RpcRequest.new(
+    func_code: 0x12,  # 假设 0x12 = FUNC_GET_CONTACTS
+    data: "",         # 本例无需参数
+    request_id: "req_#{Time.now.to_i}"
+  )
+
+  puts "🏗️  [客户端] 构建 RPC 请求:"
+  puts "    Function Code: 0x#{rpc_request.func_code.to_s(16)}"
+  puts "    Request ID: #{rpc_request.request_id}"
+  puts
+
+  # 序列化并发送
+  request_data = RpcRequest.encode(rpc_request)
+  puts "📦 [客户端] 序列化请求: #{request_data.bytesize} bytes"
+  client_socket.send(request_data)
+  puts "📤 [客户端] 请求已发送"
+  puts
+
+  # 接收响应
+  response_data = client_socket.recv
+  puts "📥 [客户端] 收到响应 (#{response_data.bytesize} bytes)"
+
+  # 反序列化 RPC 响应 (外层)
+  rpc_response = RpcResponse.decode(response_data)
+  puts "📋 [客户端] 解析 RPC 响应:"
+  puts "    Status: #{rpc_response.status}"
+  puts "    Error: #{rpc_response.error_msg}" unless rpc_response.error_msg.empty?
+  puts
+
+  if rpc_response.status == 0
+    # 反序列化联系人列表 (内层)
+    contacts = ContactList.decode(rpc_response.data)
+    puts "📋 [客户端] 解析联系人列表:"
+    puts "    总数: #{contacts.contacts.size}"
+    puts
+
+    contacts.contacts.each_with_index do |contact, i|
+      puts "    #{i + 1}. #{contact.name}"
+      puts "       WXID: #{contact.wxid}"
+    end
+  else
+    puts "❌ [客户端] RPC 调用失败: #{rpc_response.error_msg}"
+  end
+
+  # 关闭
+  client_socket.close
+
+rescue => e
+  puts "❌ [客户端] 错误: #{e.message}"
+  puts e.backtrace.first(3)
+end
+
+# 等待服务器线程完成
+server_thread.join
+server_socket.close
+
+puts
+puts "=" * 70
+puts "✅ 示例完成"
+puts "=" * 70
+puts
+puts "技术要点:"
+puts
+puts "1. 消息嵌套:"
+puts "   RpcRequest/Response 包含 bytes 类型的 data 字段"
+puts "   data 字段可以存储任意 Protobuf 消息的序列化结果"
+puts
+puts "2. 序列化过程:"
+puts "   内层: contacts → ContactList.encode → bytes"
+puts "   外层: RpcRequest { data: bytes } → RpcRequest.encode → bytes"
+puts "   发送: bytes → NNG socket.send"
+puts
+puts "3. 反序列化过程:"
+puts "   接收: NNG socket.recv → bytes"
+puts "   外层: bytes → RpcResponse.decode → RpcResponse"
+puts "   内层: RpcResponse.data → ContactList.decode → contacts"
+puts
+puts "4. 优势:"
+puts "   • 类型安全 - 编译时检查消息结构"
+puts "   • 高效序列化 - 比 JSON 小 50%+"
+puts "   • 跨语言 - Python/Java/Go/C++ 互通"
+puts "   • 向后兼容 - 可安全添加字段"
+puts "   • 自动文档 - .proto 文件即文档"
+puts
+puts "5. 实际应用:"
+puts "   • 微服务 RPC 通信"
+puts "   • 分布式系统消息传递"
+puts "   • 客户端-服务器协议"
+puts "   • 消息队列数据格式"
+puts

data/ext/nng/extconf.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+# This extconf.rb is used to capture gem install options
+# It doesn't compile anything, just saves configuration
+
+def save_config(config)
+  config_file = File.join(__dir__, 'nng_config.rb')
+  File.write(config_file, <<~RUBY)
+    # frozen_string_literal: true
+    # Auto-generated by extconf.rb during gem installation
+    # DO NOT EDIT THIS FILE MANUALLY
+
+    module NNG
+      module InstallConfig
+        CONFIG = #{config.inspect}
+      end
+    end
+  RUBY
+  puts "NNG configuration saved to #{config_file}"
+end
+
+# Parse installation options
+config = {}
+
+# --with-nng-dir=/path/to/nng
+if nng_dir = with_config('nng-dir')
+  config[:nng_dir] = nng_dir
+  puts "Using NNG directory: #{nng_dir}"
+end
+
+# --with-nng-lib=/path/to/libnng.so
+if nng_lib = with_config('nng-lib')
+  config[:nng_lib] = nng_lib
+  puts "Using NNG library: #{nng_lib}"
+end
+
+# --with-nng-include=/path/to/nng/include (for future use)
+if nng_include = with_config('nng-include')
+  config[:nng_include] = nng_include
+  puts "Using NNG include directory: #{nng_include}"
+end
+
+# Save configuration
+save_config(config)
+
+# We don't actually compile anything since we use FFI
+# Just create a dummy Makefile
+File.write('Makefile', <<~MAKEFILE)
+  .PHONY: all install clean
+
+  all:
+  \t@echo "NNG Ruby uses FFI, no compilation needed"
+
+  install:
+  \t@echo "NNG configuration saved"
+
+  clean:
+  \t@echo "Nothing to clean"
+MAKEFILE
+
+puts "\nNNG Ruby gem configuration complete!"
+puts "No native compilation needed (using FFI)"
+puts ""
+if config.any?
+  puts "Custom configuration:"
+  config.each { |k, v| puts "  #{k}: #{v}" }
+else
+  puts "Using default bundled libnng.so.1.8.0"
+end

data/lib/nng/ffi.rb

@@ -7,33 +7,102 @@ module NNG
   module FFI
     extend ::FFI::Library
 
-    # Try to load libnng from various locations
-    @lib_paths = [
-      File.expand_path('../../ext/nng/libnng.so.1.8.0', __dir__),
-      '/usr/local/lib/libnng.so',
-      '/usr/lib/libnng.so',
-      '/usr/lib/x86_64-linux-gnu/libnng.so'
-    ]
+    # Load install-time configuration if available
+    @install_config = {}
+    config_file = File.expand_path('../../ext/nng/nng_config.rb', __dir__)
+    if File.exist?(config_file)
+      require config_file
+      @install_config = NNG::InstallConfig::CONFIG rescue {}
+    end
+
+    # Build library search paths with priority order:
+    # 1. ENV['NNG_LIB_PATH'] - Direct path to library file
+    # 2. ENV['NNG_LIB_DIR'] - Directory containing libnng.so*
+    # 3. Install config (from gem install --with-nng-*)
+    # 4. Bundled library
+    # 5. System default paths
+    def self.build_lib_paths
+      paths = []
+
+      # Priority 1: Direct library path from environment
+      if ENV['NNG_LIB_PATH'] && !ENV['NNG_LIB_PATH'].empty?
+        paths << ENV['NNG_LIB_PATH']
+        puts "NNG: Using library from NNG_LIB_PATH: #{ENV['NNG_LIB_PATH']}" if ENV['NNG_DEBUG']
+      end
+
+      # Priority 2: Library directory from environment
+      if ENV['NNG_LIB_DIR'] && !ENV['NNG_LIB_DIR'].empty?
+        dir = ENV['NNG_LIB_DIR']
+        # Search for libnng.so* in the directory
+        Dir.glob(File.join(dir, 'libnng.so*')).each { |lib| paths << lib }
+        puts "NNG: Searching in NNG_LIB_DIR: #{dir}" if ENV['NNG_DEBUG']
+      end
+
+      # Priority 3: Install-time configuration
+      if @install_config[:nng_lib]
+        paths << @install_config[:nng_lib]
+        puts "NNG: Using library from install config: #{@install_config[:nng_lib]}" if ENV['NNG_DEBUG']
+      elsif @install_config[:nng_dir]
+        nng_dir = @install_config[:nng_dir]
+        # Try common subdirectories
+        %w[lib lib64 lib/x86_64-linux-gnu].each do |subdir|
+          lib_dir = File.join(nng_dir, subdir)
+          Dir.glob(File.join(lib_dir, 'libnng.so*')).each { |lib| paths << lib }
+        end
+        puts "NNG: Searching in install config dir: #{nng_dir}" if ENV['NNG_DEBUG']
+      end
 
+      # Priority 4: Bundled library
+      bundled_lib = File.expand_path('../../ext/nng/libnng.so.1.8.0', __dir__)
+      paths << bundled_lib
+
+      # Priority 5: System default paths
+      paths += [
+        '/usr/local/lib/libnng.so',
+        '/usr/lib/libnng.so',
+        '/usr/lib/x86_64-linux-gnu/libnng.so',
+        '/usr/lib/aarch64-linux-gnu/libnng.so'
+      ]
+
+      paths.uniq
+    end
+
+    @lib_paths = build_lib_paths
     @loaded_lib_path = nil
+
     @lib_paths.each do |path|
       if File.exist?(path)
         begin
           ffi_lib path
           @loaded_lib_path = path
+          puts "NNG: Successfully loaded library from: #{path}" if ENV['NNG_DEBUG']
           break
-        rescue LoadError
+        rescue LoadError => e
+          puts "NNG: Failed to load #{path}: #{e.message}" if ENV['NNG_DEBUG']
           next
         end
       end
     end
 
-    raise LoadError, "Could not find libnng.so in any of: #{@lib_paths.join(', ')}" unless @loaded_lib_path
+    unless @loaded_lib_path
+      error_msg = "Could not find libnng.so in any of the following locations:\n"
+      error_msg += @lib_paths.map { |p| "  - #{p}" }.join("\n")
+      error_msg += "\n\nYou can specify a custom path using:\n"
+      error_msg += "  - Environment variable: export NNG_LIB_PATH=/path/to/libnng.so\n"
+      error_msg += "  - Environment variable: export NNG_LIB_DIR=/path/to/lib\n"
+      error_msg += "  - Gem install option: gem install nng-ruby -- --with-nng-dir=/path/to/nng\n"
+      error_msg += "  - Gem install option: gem install nng-ruby -- --with-nng-lib=/path/to/libnng.so"
+      raise LoadError, error_msg
+    end
 
     def self.loaded_lib_path
       @loaded_lib_path
     end
 
+    def self.install_config
+      @install_config
+    end
+
     # ============================================================================
     # Constants
     # ============================================================================

data/lib/nng/socket.rb

@@ -108,7 +108,10 @@ module NNG
     def get_option(name, type: :int)
       check_closed
 
-      value_ptr = ::FFI::MemoryPointer.new(type)
+      # :ms is actually :int32 (nng_duration)
+      ptr_type = type == :ms ? :int32 : type
+      value_ptr = ::FFI::MemoryPointer.new(ptr_type)
+
       ret = case type
             when :bool
               FFI.nng_getopt_bool(@socket, name, value_ptr)
@@ -134,7 +137,7 @@ module NNG
         FFI.nng_strfree(str_ptr)
         result
       else
-        value_ptr.read(type)
+        value_ptr.read(ptr_type)
       end
     end
 

data/lib/nng/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NNG
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/nng.gemspec

@@ -5,8 +5,8 @@ require_relative 'lib/nng/version'
 Gem::Specification.new do |spec|
   spec.name          = 'nng-ruby'
   spec.version       = NNG::VERSION
-  spec.authors       = ['Claude Code']
-  spec.email         = ['noreply@anthropic.com']
+  spec.authors       = ['QingYi']
+  spec.email         = ['qingyi.mail@gmail.com']
 
   spec.summary       = 'Ruby bindings for NNG (nanomsg-next-generation)'
   spec.description   = 'Complete Ruby bindings for NNG, a lightweight messaging library. ' \
@@ -41,9 +41,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'rake-compiler', '~> 1.0'
 
-  # Extensions (none - we use FFI)
-  # spec.extensions = []
+  # Extension configuration (for capturing install-time options)
+  # We use FFI so no actual compilation, but extconf.rb captures --with-nng-* options
+  spec.extensions = ['ext/nng/extconf.rb']
 
   # Post-install message
   spec.post_install_message = <<~MSG

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: nng-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- Claude Code
+- QingYi
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -79,14 +79,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Complete Ruby bindings for NNG, a lightweight messaging library. Supports
   all scalability protocols (Pair, Push/Pull, Pub/Sub, Req/Rep, Surveyor/Respondent,
   Bus) and transports (TCP, IPC, Inproc, WebSocket, TLS). Includes bundled libnng
   shared library.
 email:
-- noreply@anthropic.com
+- qingyi.mail@gmail.com
 executables: []
-extensions: []
+extensions:
+- ext/nng/extconf.rb
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
@@ -95,8 +110,14 @@ files:
 - README.md
 - Rakefile
 - examples/pair.rb
+- examples/protobuf_advanced.rb
+- examples/protobuf_demo.rb
+- examples/protobuf_example.rb
+- examples/protobuf_simple.rb
+- examples/protobuf_thread.rb
 - examples/pubsub.rb
 - examples/reqrep.rb
+- ext/nng/extconf.rb
 - ext/nng/libnng.so.1.8.0
 - lib/nng.rb
 - lib/nng/errors.rb
@@ -119,7 +140,7 @@ post_install_message: |
   │ Thank you for installing nng-ruby gem!                    │
   │                                                           │
   │ NNG (nanomsg-next-generation) Ruby bindings               │
-  │ Version: 0.1.1                                        │
+  │ Version: 0.1.2                                        │
   │                                                           │
   │ Quick start:                                              │
   │   require 'nng'                                           │