agoo 2.5.1 → 2.5.2

data/ext/agoo/upgraded.h

@@ -3,9 +3,10 @@
 #ifndef __AGOO_UPGRADED_H__
 #define __AGOO_UPGRADED_H__
 
+#include <pthread.h>
+#include <stdatomic.h>
 #include <stdint.h>
-
-#include <ruby.h>
+#include <stdbool.h>
 
 struct _Con;
 struct _Subject;
@@ -14,21 +15,24 @@ typedef struct _Upgraded {
     struct _Upgraded	*next;
     struct _Upgraded	*prev;
     struct _Con		*con;
-    VALUE		handler;
-    VALUE		wrap;
-    VALUE		env;
     atomic_int		pending;
     atomic_int		ref_cnt;
     struct _Subject	*subjects;
+
+    void		*ctx;
+    void		*wrap;
+    void		*env;
+
     bool		on_empty;
     bool		on_close;
     bool		on_shut;
     bool		on_msg;
     bool		on_error;
+    void		(*on_destroy)(struct _Upgraded *up);
 } *Upgraded;
 
-extern void	upgraded_init(VALUE mod);
-extern Upgraded	upgraded_create(struct _Con *c, VALUE obj, VALUE env);
+extern Upgraded	upgraded_create(struct _Con *c, void * ctx, void *env);
+
 extern void	upgraded_release(Upgraded up);
 extern void	upgraded_release_con(Upgraded up);
 
@@ -38,6 +42,10 @@ extern void	upgraded_add_subject(Upgraded up, struct _Subject *subject);
 extern void	upgraded_del_subject(Upgraded up, struct _Subject *subject);
 extern bool	upgraded_match(Upgraded up, const char *subject);
 
-extern const char*	extract_subject(VALUE subject, int *slen);
+extern bool	upgraded_write(Upgraded up, const char *message, size_t mlen, bool bin, bool inc_ref);
+extern void	upgraded_subscribe(Upgraded up, const char *subject, int slen, bool inc_ref);
+extern void	upgraded_unsubscribe(Upgraded up, const char *subject, int slen, bool inc_ref);
+extern void	upgraded_close(Upgraded up, bool inc_ref);
+extern int	upgraded_pending(Upgraded up);
 
 #endif // __AGOO_UPGRADED_H__

data/ext/agoo/websocket.c

@@ -1,14 +1,18 @@
 // Copyright (c) 2018, Peter Ohler, All rights reserved.
 
 #include <stdint.h>
+#include <string.h>
 
 #include "base64.h"
 #include "con.h"
 #include "debug.h"
-#include "request.h"
-#include "rserver.h"
+#include "log.h"
+#include "req.h"
+#include "res.h"
 #include "sha1.h"
+#include "server.h"
 #include "text.h"
+#include "upgraded.h"
 #include "websocket.h"
 
 #define MAX_KEY_LEN	1024
@@ -164,11 +168,11 @@ bool
 ws_create_req(Con c, long mlen) {
     uint8_t	op = 0x0F & *c->buf;
     
-    if (NULL == (c->req = request_create(mlen))) {
+    if (NULL == (c->req = req_create(mlen))) {
 	log_cat(&error_cat, "Out of memory attempting to allocate request.");
 	return true;
     }
-    if (NULL == c->up || Qnil == c->up->handler) {
+    if (NULL == c->up || the_server.ctx_nil_value == c->up->ctx) {
 	return true;
     }
     memset(c->req, 0, sizeof(struct _Req));
@@ -187,21 +191,21 @@ ws_create_req(Con c, long mlen) {
     c->req->up = c->up;
     c->req->res = NULL;
     if (c->up->on_msg) {
-	c->req->hook = hook_create(NONE, NULL, (void*)c->up->handler, PUSH_HOOK, &the_rserver.eval_queue);
+	c->req->hook = hook_create(NONE, NULL, c->up->ctx, PUSH_HOOK, &the_server.eval_queue);
     }
     return false;
 }
 
 void
 ws_req_close(Con c) {
-    if (NULL != c->up && Qnil != c->up->handler && c->up->on_close) {
-	Req	req = request_create(0);
+    if (NULL != c->up && the_server.ctx_nil_value != c->up->ctx && c->up->on_close) {
+	Req	req = req_create(0);
 	    
 	req->up = c->up;
 	req->method = ON_CLOSE;
-	req->hook = hook_create(NONE, NULL, (void*)c->up->handler, PUSH_HOOK, &the_rserver.eval_queue);
+	req->hook = hook_create(NONE, NULL, c->up->ctx, PUSH_HOOK, &the_server.eval_queue);
 	atomic_fetch_add(&c->up->ref_cnt, 1);
-	queue_push(&the_rserver.eval_queue, (void*)req);
+	queue_push(&the_server.eval_queue, (void*)req);
     }
 }
 

data/lib/agoo/base.rb

@@ -0,0 +1,84 @@
+
+module Agoo
+
+  # Maybe not the best class name but this class implements the base methds
+  # for a Rack WebSocket/SSE handler. A handler does not have to inherit from
+  # this class but the class does identify the methods supported.
+  class Base
+    attr_accessor :connection
+    
+    def initialize(env)
+      # Nothing needs to be done on initialize although the #call env is
+      # available if desired for some reason on creaton. After #on_open is
+      # called the same env can be accessed through the client.
+    end
+
+    # Called when the WebSocket or SSE connection has been established. The
+    # client represents the connection and cab be used to send messages to the
+    # JavaScript WebSocket or SSE listener.
+    def on_open(client)
+      # save the client to support a send later on.
+      @connection = client
+    end
+
+    # Called when the WebSocket or SSE connection is closed.
+    def on_close(client)
+      @connection = nil
+    end
+
+    # This indicates the send delivery queue is empty. Useful if attempting to
+    # restrict the sends to one at a time.
+    def on_drained(client)
+    end
+
+    # Called when the JavaScript listener sends a WebSocket message.
+    def on_message(client, data)
+      # Handle a received message.
+    end
+
+    # Called when an error occurs on the WebSocket or SSE connection.
+    def on_error(client, err_msg)
+      # Handle an error.
+    end
+
+    # Sends a message to the WebSocket or SSE listener.
+    def send_message(msg)
+      check_connection
+      connection.write(msg)
+    end
+
+    # Closes the WebSocket or SSE connection. Note the connection can also be
+    # closed by the JavaScript listener.
+    def close
+      check_connection
+      connection.close
+    end
+
+    # The #subscribe, #unsubscribe, and #publish methods are not part of the
+    # Rack SPEC but add added here to demonstrate the publish and subscribe
+    # add-on that Agoo and Iodine provide. If you think it is something that
+    # should be included in the Rack SPEC we can add that. It was left out as
+    # it made the API more complex and
+    def subscribe(subject)
+      check_connection
+      connection.subscribe(subject)
+    end
+
+    def unsubscribe(subject=nil)
+      check_connection
+      connection.unsubscribe(subject)
+    end
+
+    def publish(subject, message)
+      check_connection
+      connection.publish(subject, message)
+    end
+
+    private
+    
+    def check_connection
+      raise StandardError.new('Not connected') if connection.nil?
+    end
+  end
+
+end

data/lib/agoo/client.rb

@@ -0,0 +1,25 @@
+module Agoo
+
+  # A WebSocket/SSE middleware class. If a WebSocket connection has been
+  # requested by a JavaScript listener then a success status (200) is returned
+  # by the call method otherwise a 404 status is returned.
+  class Client
+
+    attr_accessor :handler_class
+    
+    def initialize(handler_class)
+      @handler_class = handler_class
+    end
+    
+    def call(env)
+      unless env['rack.upgrade?'].nil?
+	env['rack.upgrade'] = @handler_class.new(env)
+	[ 200, { }, [ ] ]
+      else
+	[ 404, { }, [ ] ]
+      end
+    end
+
+  end
+end
+

data/lib/agoo/version.rb

@@ -1,5 +1,5 @@
 
 module Agoo
   # Agoo version.
-  VERSION = '2.5.1'
+  VERSION = '2.5.2'
 end

data/test/bind_test.rb

@@ -31,7 +31,7 @@ class BindTest < Minitest::Test
 			    eval: true,
 			  })
 
-      addr = ''
+      addr = '127.0.0.1'
       Socket.ip_address_list.each { |ai|
 	if ai.ipv4? && '127.0.0.1' != ai.ip_address
 	  addr = ai.ip_address
@@ -52,7 +52,7 @@ class BindTest < Minitest::Test
       localhost_test
       ipv4_test(addr)
       ipv6_test(addr6)
-      restrict_test
+      restrict_test unless '127.0.0.1' == addr
       named_test(name)
     ensure
       Agoo::shutdown

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agoo
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -61,10 +61,21 @@ files:
 - ext/agoo/error_stream.c
 - ext/agoo/error_stream.h
 - ext/agoo/extconf.rb
+- ext/agoo/foo/agoo.c
+- ext/agoo/foo/con.c
+- ext/agoo/foo/con.h
+- ext/agoo/foo/page.c
+- ext/agoo/foo/pub.c
+- ext/agoo/foo/pub.h
+- ext/agoo/foo/rserver.c
+- ext/agoo/foo/server.c
+- ext/agoo/foo/server.h
+- ext/agoo/foo/upgraded.c
 - ext/agoo/hook.c
 - ext/agoo/hook.h
 - ext/agoo/http.c
 - ext/agoo/http.h
+- ext/agoo/kinds.h
 - ext/agoo/log.c
 - ext/agoo/log.h
 - ext/agoo/log_queue.h
@@ -77,6 +88,8 @@ files:
 - ext/agoo/queue.h
 - ext/agoo/rack_logger.c
 - ext/agoo/rack_logger.h
+- ext/agoo/req.c
+- ext/agoo/req.h
 - ext/agoo/request.c
 - ext/agoo/request.h
 - ext/agoo/res.c
@@ -87,8 +100,12 @@ files:
 - ext/agoo/rhook.h
 - ext/agoo/rlog.c
 - ext/agoo/rlog.h
+- ext/agoo/rresponse.c
+- ext/agoo/rresponse.h
 - ext/agoo/rserver.c
 - ext/agoo/rserver.h
+- ext/agoo/rupgraded.c
+- ext/agoo/rupgraded.h
 - ext/agoo/seg.h
 - ext/agoo/server.c
 - ext/agoo/server.h
@@ -102,12 +119,13 @@ files:
 - ext/agoo/subject.h
 - ext/agoo/text.c
 - ext/agoo/text.h
-- ext/agoo/types.h
 - ext/agoo/upgraded.c
 - ext/agoo/upgraded.h
 - ext/agoo/websocket.c
 - ext/agoo/websocket.h
 - lib/agoo.rb
+- lib/agoo/base.rb
+- lib/agoo/client.rb
 - lib/agoo/version.rb
 - lib/rack/handler/agoo.rb
 - test/base_handler_test.rb
@@ -149,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Linux or macOS
 rubyforge_project: agoo
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: An HTTP server