iodine 0.2.0 → 0.2.1

data/ext/iodine/websockets.h

@@ -13,7 +13,7 @@ typedef struct Websocket ws_s;
 /**
 The protocol / service identifier for `libserver`.
 */
-extern char* WEBSOCKET_ID_STR;
+extern char *WEBSOCKET_ID_STR;
 /**
 The Websocket Handler contains all the settings required for new websocket
 connections.
@@ -31,26 +31,37 @@ typedef struct {
   overwritten once the function exits (it cannot be saved for later, but it can
   be copied).
   */
-  void (*on_message)(ws_s* ws, char* data, size_t size, uint8_t is_text);
+  void (*on_message)(ws_s *ws, char *data, size_t size, uint8_t is_text);
   /**
   The (optional) on_open callback will be called once the websocket connection
   is
   established.
   */
-  void (*on_open)(ws_s* ws);
+  void (*on_open)(ws_s *ws);
+  /**
+  The (optional) on_ready callback will be after a the underlying socket's
+  buffer changes it's state from full to available.
+
+  If the socket's buffer is never full, the callback is never called.
+
+  It should be noted that `libsock` manages the socket's buffer overflow and
+  implements and augmenting user-land buffer, allowing data to be safely written
+  to the websocket without worrying over the socket's buffer.
+  */
+  void (*on_ready)(ws_s *ws);
   /**
   The (optional) on_shutdown callback will be called if a websocket connection
   is still open while the server is shutting down (called before `on_close`).
   */
-  void (*on_shutdown)(ws_s* ws);
+  void (*on_shutdown)(ws_s *ws);
   /**
   The (optional) on_close callback will be called once a websocket connection is
   terminated or failed to be established.
   */
-  void (*on_close)(ws_s* ws);
+  void (*on_close)(ws_s *ws);
   /** The `http_request_s` to be converted ("upgraded") to a websocket
    * connection. Either a request or a response object is required.*/
-  http_request_s* request;
+  http_request_s *request;
   /**
   The (optional) HttpResponse to be used for sending the upgrade response.
 
@@ -59,13 +70,13 @@ typedef struct {
   The ownership of the response object will remain unchanged - so if you have
   created the response object, you should free it.
   */
-  http_response_s* response;
+  http_response_s *response;
   /**
   The maximum websocket message size/buffer (in bytes) for this connection.
   */
   size_t max_msg_size;
   /** Opaque user data. */
-  void* udata;
+  void *udata;
   /**
   Timeout for the websocket connections, a ping will be sent
   whenever the timeout is reached. Connections are only closed when a ping
@@ -90,31 +101,30 @@ typedef struct {
  * Returns 0 on sucess and -1 on failure. A response is always sent.
  */
 ssize_t websocket_upgrade(websocket_settings_s settings);
-#define websocket_upgrade(...) \
+#define websocket_upgrade(...)                                                 \
   websocket_upgrade((websocket_settings_s){__VA_ARGS__})
 
 /** Returns the opaque user data associated with the websocket. */
-void* websocket_get_udata(ws_s* ws);
+void *websocket_get_udata(ws_s *ws);
 /** Returns the the process specific connection's UUID (see `libsock`). */
-intptr_t websocket_get_fduuid(ws_s* ws);
+intptr_t websocket_get_fduuid(ws_s *ws);
 /** Sets the opaque user data associated with the websocket.
  * Returns the old value, if any. */
-void* websocket_set_udata(ws_s* ws, void* udata);
+void *websocket_set_udata(ws_s *ws, void *udata);
 /** Writes data to the websocket. Returns -1 on failure (0 on success). */
-int websocket_write(ws_s* ws, void* data, size_t size, uint8_t is_text);
+int websocket_write(ws_s *ws, void *data, size_t size, uint8_t is_text);
 /** Closes a websocket connection. */
-void websocket_close(ws_s* ws);
+void websocket_close(ws_s *ws);
 /**
 Performs a task on each websocket connection that shares the same process
 (except the originating `ws_s` connection which is allowed to be NULL).
  */
-void websocket_each(ws_s* ws_originator,
-                    void (*task)(ws_s* ws_target, void* arg),
-                    void* arg,
-                    void (*on_finish)(ws_s* ws_originator, void* arg));
+void websocket_each(ws_s *ws_originator,
+                    void (*task)(ws_s *ws_target, void *arg), void *arg,
+                    void (*on_finish)(ws_s *ws_originator, void *arg));
 /**
 Counts the number of websocket connections.
 */
-size_t websocket_count(ws_s* ws);
+size_t websocket_count(ws_s *ws);
 
 #endif

data/iodine.gemspec

@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest'
 
-  spec.post_install_message = "** WARNING!\n" \
-                              "Iodine 0.2.0 is NOT an upgrade - it's a total rewrite, it's written in C specifically for Ruby MRI.\n\n" \
-                              'If your application was using Iodine 0.1.x, it might not work after this "upgrade".'
+  # spec.post_install_message = "** WARNING!\n" \
+  #                             "Iodine 0.2.0 is NOT an upgrade - it's a total rewrite, it's written in C specifically for Ruby MRI.\n\n" \
+  #                             'If your application was using Iodine 0.1.x, it might not work after this "upgrade".'
 end

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -177,11 +177,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: |-
-  ** WARNING!
-  Iodine 0.2.0 is NOT an upgrade - it's a total rewrite, it's written in C specifically for Ruby MRI.
-
-  If your application was using Iodine 0.1.x, it might not work after this "upgrade".
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib