nmsg 0.1.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eaf25c8d389c83267a1c4f0ce13fd6af22a17c94
+  data.tar.gz: d47c26ce0fa8f55a763dcb83bcf07e9875479f82
+SHA512:
+  metadata.gz: 9b27be1a064c4637e685ae1f36f355b2ae2bd2757376b26fea6fcba2c89e547ca47a625e1f8f9b6737892cae291c2f045e72135b408554d1c2659e18400a062f
+  data.tar.gz: 21bf0ecc1704c1ecb5289dfab969baf8f9e23b03c5f02d334343df32f3fd8ae65dec1602f1a040e0a44f7a6a3ca9a6665e2226eb444f63038bc9885ccd97660c

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Alex Brem
+
+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/Makefile

@@ -0,0 +1,13 @@
+CFLAGS ?= -I/opt/local/include -g
+LDFLAGS ?= -L/opt/local/lib -lnanomsg
+
+all: nmsg
+
+clean:
+	@cd ext/nmsg && make distclean || true
+
+nmsg: ext/nmsg/extconf.rb ext/nmsg/rubyext.c
+	@echo Building Ruby extension 'nmsg'...
+	@cd ext/nmsg && CFLAGS="${CFLAGS}" LDFLAGS="${LDFLAGS}" ruby extconf.rb && make
+
+.PHONY: all clean nmsg

data/README.md

@@ -0,0 +1,13 @@
+nmsg
+====
+
+Native Ruby binding for the [nanomsg](http://nanomsg.org/) library.
+
+**This is incomplete and most likely a bugs galore. So please don't use this right now!**
+
+## TODO
+
+- [nn_setsockopt](http://nanomsg.org/v0.4/nn_setsockopt.3.html)
+- [nn_getsockopt](http://nanomsg.org/v0.4/nn_getsockopt.3.html)
+- add exceptions ([nn_errno](http://nanomsg.org/v0.4/nn_errno.3.html), [nn_strerror](http://nanomsg.org/v0.4/nn_strerror.3.html))
+- TESTS

data/examples/push_pull.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require_relative '../ext/nmsg/nmsg'
+
+addr = ARGV.shift || "inproc://6581"
+
+Thread.abort_on_exception = true
+
+@mutex = Mutex.new
+@sent = @received = 0
+@threads = []
+
+MAX_MSG = 50
+
+15.times do
+  @mutex.synchronize do
+    Thread.new do
+      push = Nmsg::Socket.new(Nmsg::AF_SP, Nmsg::NN_PUSH)
+      eid = push.connect(addr)
+      loop do
+        cnt = @mutex.synchronize { @sent += 1 }
+        Thread.current.exit if cnt > MAX_MSG
+        push.send_msg_block("#{Thread.current.object_id}: #{cnt}")
+      end
+    end
+  end
+end
+
+pull = Nmsg::Socket.new(Nmsg::AF_SP, Nmsg::NN_PULL)
+pull.bind addr
+
+loop do
+  ev = pull.poll Nmsg::NN_POLLIN, 50
+  raise "Error: nn_poll" if ev.nil?
+  if ev
+    @received += 1
+    puts "pulled data from thread #{pull.recv_msg}"
+  else
+    break if @received == MAX_MSG
+  end
+end
+
+@threads.each &:join
+pull.close

data/examples/rep.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require_relative '../ext/nmsg/nmsg'
+
+socket = Nmsg::Socket.new Nmsg::AF_SP, Nmsg::NN_REP
+puts "fd: #{socket.get_fd}  sysfd: #{socket.get_sysfd}"
+
+addr = ARGV.shift || "tcp://127.0.0.1:4000"
+endpoint_id = socket.bind addr
+puts "address: #{addr}  endpoint id: #{endpoint_id}"
+
+trap("SIGINT") do
+  puts "Exiting..."
+  socket.shutdown endpoint_id
+  socket.close
+  exit!
+end
+
+loop do
+  ev = socket.poll Nmsg::NN_POLLIN, 1000
+  raise "Error: nn_poll" if ev.nil?
+  if ev
+    data = socket.recv_msg
+    puts "=> HAI [#{data}]"
+    sleep Random.rand(1.0/Random.rand(1...100))
+    socket.send_msg data.reverse
+    puts "<= KTHXBAI [#{data}]"
+  end
+end

data/examples/req.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require_relative '../ext/nmsg/nmsg'
+
+socket = Nmsg::Socket.new Nmsg::AF_SP, Nmsg::NN_REQ
+puts "fd: #{socket.get_fd}  sysfd: #{socket.get_sysfd}"
+
+addr = ARGV.shift || "tcp://127.0.0.1:4000"
+endpoint_id = socket.connect addr
+puts "address: #{addr}  endpoint id: #{endpoint_id}"
+
+trap("SIGINT") do
+  puts "Exiting..."
+  socket.shutdown endpoint_id
+  socket.close
+  exit!
+end
+
+sent = false
+msg = ''
+loop do
+  puts "loop (sent: #{sent})"
+  unless sent
+    ev = socket.poll Nmsg::NN_POLLOUT, 1000
+    next if ev.nil?
+    if ev
+      msg = (0...8).map { ('a'..'z').to_a[rand(26)] }.join
+      sent = socket.send_msg_block msg
+    end
+    if sent
+      puts "message sent: #{msg}"
+    else
+      sleep 1
+    end
+  else
+    ev = socket.poll Nmsg::NN_POLLIN, 1000
+    next if ev.nil?
+    if ev
+      data = socket.recv_msg
+      puts "message received: #{data}" if data
+      raise "Error: Wrong message! (expected '#{msg.reverse}' and got '#{data}')" unless data && data.reverse.eql?(msg)
+      sent = false
+    end
+  end
+end

data/ext/nmsg/extconf.rb

@@ -0,0 +1,9 @@
+require 'mkmf'
+
+$CFLAGS << " #{ENV['CFLAGS']}"
+$LDFLAGS << " #{ENV['LDFLAGS']}"
+
+have_header('ruby/thread.h') && have_func('rb_thread_call_without_gvl', 'ruby/thread.h') # Ruby 2.0+
+
+have_library('nanomsg')
+create_makefile('nmsg')

data/ext/nmsg/rubyext.c

@@ -0,0 +1,285 @@
+//
+// nmsg /|\ https://github.com/localhost/nmsg
+//          a Ruby binding for nanomsg (http://nanomsg.org)
+//
+// Copyright (c) 2014 Alex Brem
+//
+// 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.
+//
+
+#include <ruby.h>
+
+#ifdef HAVE_RB_THREAD_CALL_WITHOUT_GVL
+# include <ruby/thread.h>
+#endif
+
+#include <string.h>
+#include <stdint.h>
+
+// core
+#include <nanomsg/nn.h>
+
+// protocols
+#include <nanomsg/pair.h>
+#include <nanomsg/reqrep.h>
+#include <nanomsg/pubsub.h>
+#include <nanomsg/survey.h>
+#include <nanomsg/pipeline.h>
+#include <nanomsg/bus.h>
+
+// transports
+#include <nanomsg/inproc.h>
+#include <nanomsg/ipc.h>
+#include <nanomsg/tcp.h>
+
+#define GET_SOCKET(self) \
+    Socket *S; \
+    Data_Get_Struct(self, Socket, S)
+
+static VALUE mNmsg, cSocket;
+
+typedef struct {
+    int fd;
+} Socket;
+
+static void rb_socket_free(Socket *S) {
+    if (S->fd > 0)
+        nn_shutdown(S->fd, 0);
+    xfree(S);
+}
+
+VALUE rb_socket_alloc(VALUE klass) {
+    Socket *S = ALLOC(Socket);
+    S->fd = -1;
+    return Data_Wrap_Struct(klass, NULL, rb_socket_free, S);
+}
+
+VALUE rb_socket_initialize(VALUE self, VALUE domain, VALUE protocol) {
+    GET_SOCKET(self);
+    if (!S)
+        return Qnil;
+
+    S->fd = nn_socket(NUM2INT(domain), NUM2INT(protocol));
+    return self;
+}
+
+VALUE rb_socket_bind(VALUE self, VALUE addr) {
+    GET_SOCKET(self);
+    if (!S || S->fd == -1)
+        return Qnil;
+
+    const char *addr_c = StringValueCStr(addr);
+    const int endpoint_id = nn_bind(S->fd, addr_c);
+    return (endpoint_id == -1) ? Qnil : INT2NUM(endpoint_id);
+}
+
+VALUE rb_socket_connect(VALUE self, VALUE addr) {
+    GET_SOCKET(self);
+    if (!S || S->fd == -1)
+        return Qnil;
+
+    const char *addr_c = StringValueCStr(addr);
+    const int endpoint_id = nn_connect(S->fd, addr_c);
+    return (endpoint_id == -1) ? Qnil : INT2NUM(endpoint_id);
+}
+
+VALUE rb_socket_poll(VALUE self, VALUE mask, VALUE timeout) {
+    GET_SOCKET(self);
+    if (!S || S->fd == -1)
+        return Qnil;
+
+    if (timeout == Qnil)
+        timeout = INT2NUM(0);
+
+    struct nn_pollfd pfd;
+    pfd.fd = S->fd;
+    pfd.events = NUM2INT(mask);
+
+    const int res = nn_poll(&pfd, 1, NUM2INT(timeout));
+    if (res == -1) // error
+        return Qnil;
+    else if (res == 0) // timeout
+        return Qfalse;
+
+    return (pfd.revents & NUM2INT(mask)) ? Qtrue : Qfalse;
+}
+
+VALUE rb_socket_recv_msg(VALUE self) {
+    GET_SOCKET(self);
+    if (!S || S->fd == -1)
+        return Qnil;
+
+    void *buffer;
+    const int nbytes = nn_recv(S->fd, &buffer, NN_MSG, NN_DONTWAIT);
+    if (nbytes < 0)
+        return Qnil;
+
+    VALUE rs = rb_tainted_str_new(buffer, nbytes);
+    nn_freemsg(buffer);
+
+    return rs;
+}
+
+VALUE rb_socket_send_msg(VALUE self, VALUE obj) {
+    GET_SOCKET(self);
+    if (!S || S->fd == -1)
+        return Qnil;
+
+    const int msg_bytes = RSTRING_LEN(obj);
+    const char *data = RSTRING_PTR(obj);
+    void *msg = nn_allocmsg(msg_bytes, 0);
+    if (!msg)
+        return Qnil;
+    memcpy(msg, data, msg_bytes);
+
+    const int nbytes = nn_send(S->fd, &msg, NN_MSG, NN_DONTWAIT);
+    if (nbytes < 0) {
+        nn_freemsg(msg);
+        return Qnil;
+    }
+
+    return (nbytes == msg_bytes) ? Qtrue : Qfalse;
+}
+
+#ifdef HAVE_RB_THREAD_CALL_WITHOUT_GVL
+
+struct nogvl_msg {
+    int fd;
+    void **msg;
+};
+
+static void *nogvl_send_msg(void *p) {
+    struct nogvl_msg *wrapper = p;
+    return (void *)(intptr_t)nn_send(wrapper->fd, wrapper->msg, NN_MSG, 0);
+}
+
+VALUE rb_socket_send_msg_block(VALUE self, VALUE obj) {
+    GET_SOCKET(self);
+    if (!S || S->fd == -1)
+        return Qnil;
+
+    const int msg_bytes = RSTRING_LEN(obj);
+    const char *data = RSTRING_PTR(obj);
+    void *msg = nn_allocmsg(msg_bytes, 0);
+    if (!msg)
+        return Qnil;
+    memcpy(msg, data, msg_bytes);
+
+    struct nogvl_msg wrapper = { S->fd, &msg };
+    const int nbytes = (int)rb_thread_call_without_gvl(nogvl_send_msg, &wrapper, RUBY_UBF_IO, 0);
+    if (nbytes < 0) {
+        nn_freemsg(msg);
+        return Qnil;
+    }
+
+    return (nbytes == msg_bytes) ? Qtrue : Qfalse;
+}
+
+#endif // HAVE_RB_THREAD_CALL_WITHOUT_GVL
+
+VALUE rb_socket_close(VALUE self) {
+    GET_SOCKET(self);
+    if (S && S->fd > 0) {
+        nn_close(S->fd);
+        S->fd = -1;
+    }
+
+    return self;
+}
+
+VALUE rb_socket_shutdown(VALUE self, VALUE how) {
+    GET_SOCKET(self);
+    if (S && S->fd > 0) {
+        nn_shutdown(S->fd, NUM2INT(how));
+        S->fd = -1;
+    }
+
+    return self;
+}
+
+VALUE rb_socket_get_fd(VALUE self) {
+    GET_SOCKET(self);
+    return rb_int_new(S->fd);
+}
+
+VALUE rb_socket_get_sysfd(VALUE self) {
+    GET_SOCKET(self);
+
+    int optval;
+    size_t optval_len = sizeof(int);
+    const int res = nn_getsockopt(S->fd, NN_SOL_SOCKET, NN_RCVFD, (void *)&optval, &optval_len);
+    return INT2NUM((res == 0) ? optval : -1);
+}
+
+VALUE rb_socket_term(VALUE klass) {
+    nn_term();
+    return klass;
+}
+
+VALUE rb_socket_device(VALUE klass, VALUE so1, VALUE so2) {
+    Socket *S1;
+    Data_Get_Struct(so1, Socket, S1);
+
+    Socket tmp = { .fd = -1 };
+    Socket *S2 = &tmp;
+
+    if (so2 != Qnil) // FIXME
+        Data_Get_Struct(so2, Socket, S2);
+
+    return nn_device(S1->fd, S2->fd);
+}
+
+void Init_nmsg() {
+    mNmsg = rb_define_module("Nmsg");
+
+    cSocket = rb_define_class_under(mNmsg, "Socket", rb_cObject);
+    rb_define_alloc_func(cSocket, rb_socket_alloc);
+
+    rb_define_method(cSocket, "initialize", rb_socket_initialize, 2);
+    rb_define_method(cSocket, "bind", rb_socket_bind, 1);
+    rb_define_method(cSocket, "connect", rb_socket_connect, 1);
+    rb_define_method(cSocket, "poll", rb_socket_poll, 2);
+    rb_define_method(cSocket, "recv_msg", rb_socket_recv_msg, 0);
+    rb_define_method(cSocket, "send_msg", rb_socket_send_msg, 1);
+
+#ifdef HAVE_RB_THREAD_CALL_WITHOUT_GVL
+    rb_define_method(cSocket, "send_msg_block", rb_socket_send_msg_block, 1);
+#endif
+
+    rb_define_method(cSocket, "close", rb_socket_close, 0);
+    rb_define_method(cSocket, "shutdown", rb_socket_shutdown, 1);
+
+    rb_define_method(cSocket, "get_fd", rb_socket_get_fd, 0);
+    rb_define_method(cSocket, "get_sysfd", rb_socket_get_sysfd, 0);
+
+    rb_define_singleton_method(cSocket, "device", rb_socket_device, 2);
+    rb_define_singleton_method(cSocket, "term", rb_socket_term, 0);
+
+    for (int i = 0, value;; ++i) {
+        const char *name = nn_symbol(i, &value);
+        if (!name)
+            break;
+        if (strncmp("NN_", name, 3) == 0 || strncmp("AF_", name, 3) == 0)
+            rb_const_set(mNmsg, rb_intern(name), INT2NUM(value));
+    }
+
+    // nanomsg events (missing from nn_symbol)
+    rb_const_set(mNmsg, rb_intern("NN_POLLIN"), INT2NUM(NN_POLLIN));
+    rb_const_set(mNmsg, rb_intern("NN_POLLOUT"), INT2NUM(NN_POLLOUT));
+}

data/nmsg.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name          = 'nmsg'
+  s.version       = '0.1.1.pre'
+  s.license       = 'MIT'
+  s.author        = 'Alex Brem'
+  s.email         = 'alex@fluktuation.net'
+  s.homepage      = 'https://github.com/localhost/nmsg'
+  s.summary       = %Q{native nanomsg binding}
+  s.description   = %Q{native binding for the nanomsg c library}
+
+  s.files         = [
+    'README.md', 'LICENSE', 'Makefile', 'Gemfile', 'nmsg.gemspec',
+    'examples/req.rb', 'examples/rep.rb', 'examples/push_pull.rb',
+    'ext/nmsg/extconf.rb', 'ext/nmsg/rubyext.c'
+  ]
+
+  s.require_paths = ['lib']
+  s.extensions    = ["ext/nmsg/extconf.rb"]
+  s.has_rdoc      = false
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: nmsg
+version: !ruby/object:Gem::Version
+  version: 0.1.1.pre
+platform: ruby
+authors:
+- Alex Brem
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-05 00:00:00.000000000 Z
+dependencies: []
+description: native binding for the nanomsg c library
+email: alex@fluktuation.net
+executables: []
+extensions:
+- ext/nmsg/extconf.rb
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- Makefile
+- README.md
+- examples/push_pull.rb
+- examples/rep.rb
+- examples/req.rb
+- ext/nmsg/extconf.rb
+- ext/nmsg/rubyext.c
+- nmsg.gemspec
+homepage: https://github.com/localhost/nmsg
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: native nanomsg binding
+test_files: []