isomorfeus-iodine 0.7.49 → 0.7.50

data/ext/{iodine → iodine_ext}/websockets.h

@@ -1,185 +1,185 @@
-/*
-copyright: Boaz Segev, 2016-2019
-license: MIT
-
-Feel free to copy, use and enjoy according to the license provided.
-*/
-#ifndef H_WEBSOCKETS_H
-#define H_WEBSOCKETS_H
-
-#include <http.h>
-
-/* support C++ */
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/** used internally: attaches the Websocket protocol to the socket. */
-void websocket_attach(intptr_t uuid, http_settings_s *http_settings,
-                      websocket_settings_s *args, void *data, size_t length);
-
-/* *****************************************************************************
-Websocket information
-***************************************************************************** */
-
-/** Returns the opaque user data associated with the websocket. */
-void *websocket_udata_get(ws_s *ws);
-
-/**
- * Sets the opaque user data associated with the websocket.
- *
- * Returns the old value, if any.
- */
-void *websocket_udata_set(ws_s *ws, void *udata);
-
-/**
- * Returns the underlying socket UUID.
- *
- * This is only relevant for collecting the protocol object from outside of
- * websocket events, as the socket shouldn't be written to.
- */
-intptr_t websocket_uuid(ws_s *ws);
-
-/**
- * Returns 1 if the WebSocket connection is in Client mode (connected to a
- * remote server) and 0 if the connection is in Server mode (a connection
- * established using facil.io's HTTP server).
- */
-uint8_t websocket_is_client(ws_s *ws);
-
-/* *****************************************************************************
-Websocket Connection Management (write / close)
-***************************************************************************** */
-
-/** Writes data to the websocket. Returns -1 on failure (0 on success). */
-int websocket_write(ws_s *ws, fio_str_info_s msg, uint8_t is_text);
-/** Closes a websocket connection. */
-void websocket_close(ws_s *ws);
-
-/* *****************************************************************************
-Websocket Pub/Sub
-=================
-
-API for websocket pub/sub that can be used to publish messages across process
-boundries.
-
-Supports pub/sub engines (see {pubsub.h}) that can connect to a backend service
-such as Redis.
-
-The default pub/sub engine (if `NULL` or unspecified) will publish the messages
-to the process cluster (all the processes in `fio_run`).
-
-To publish to a channel, use the API provided in {pubsub.h}.
-***************************************************************************** */
-
-/** Possible arguments for the {websocket_subscribe} function. */
-struct websocket_subscribe_s {
-  /** the websocket receiving the message. REQUIRED. */
-  ws_s *ws;
-  /** the channel where the message was published. */
-  fio_str_info_s channel;
-  /**
-   * The callback that handles pub/sub notifications.
-   *
-   * Default: send directly to websocket client.
-   */
-  void (*on_message)(ws_s *ws, fio_str_info_s channel, fio_str_info_s msg,
-                     void *udata);
-  /**
-   * An optional cleanup callback for the `udata`.
-   */
-  void (*on_unsubscribe)(void *udata);
-  /** User opaque data, passed along to the notification. */
-  void *udata;
-  /** An optional callback for pattern matching. */
-  fio_match_fn match;
-  /**
-   * When using client forwarding (no `on_message` callback), this indicates if
-   * messages should be sent to the client as binary blobs, which is the safest
-   * approach.
-   *
-   * Default: tests for UTF-8 data encoding and sends as text if valid UTF-8.
-   * Messages above ~32Kb are always assumed to be binary.
-   */
-  unsigned force_binary : 1;
-  /**
-   * When using client forwarding (no `on_message` callback), this indicates if
-   * messages should be sent to the client as text.
-   *
-   * `force_binary` has precedence.
-   *
-   * Default: see above.
-   *
-   */
-  unsigned force_text : 1;
-};
-
-/**
- * Subscribes to a channel. See {struct websocket_subscribe_s} for possible
- * arguments.
- *
- * Returns a subscription ID on success and 0 on failure.
- *
- * All subscriptions are automatically revoked once the websocket is closed.
- *
- * If the connections subscribes to the same channel more than once, messages
- * will be merged. However, another subscription ID will be assigned, since two
- * calls to {websocket_unsubscribe} will be required in order to unregister from
- * the channel.
- */
-uintptr_t websocket_subscribe(struct websocket_subscribe_s args);
-
-#define websocket_subscribe(wbsckt, ...)                                       \
-  websocket_subscribe((struct websocket_subscribe_s){.ws = wbsckt, __VA_ARGS__})
-
-/**
- * Unsubscribes from a channel.
- *
- * Failures are silent.
- *
- * All subscriptions are automatically revoked once the websocket is closed. So
- * only use this function to unsubscribe while the websocket is open.
- */
-void websocket_unsubscribe(ws_s *ws, uintptr_t subscription_id);
-
-/** Optimize generic broadcasts, for use in websocket_optimize4broadcasts. */
-#define WEBSOCKET_OPTIMIZE_PUBSUB (-32)
-/** Optimize text broadcasts, for use in websocket_optimize4broadcasts. */
-#define WEBSOCKET_OPTIMIZE_PUBSUB_TEXT (-33)
-/** Optimize binary broadcasts, for use in websocket_optimize4broadcasts. */
-#define WEBSOCKET_OPTIMIZE_PUBSUB_BINARY (-34)
-
-/**
- * Enables (or disables) broadcast optimizations.
- *
- * This is performed automatically by the `websocket_subscribe` function.
- * However, this function is provided for enabling the pub/sub metadata based
- * optimizations for external connections / subscriptions.
- *
- * This function allows enablement (or disablement) of these optimizations:
- *
- * * WEBSOCKET_OPTIMIZE_PUBSUB - optimize all direct transmission messages,
- *                               best attempt to detect Text vs. Binary data.
- * * WEBSOCKET_OPTIMIZE_PUBSUB_TEXT - optimize direct pub/sub text messages.
- * * WEBSOCKET_OPTIMIZE_PUBSUB_BINARY - optimize direct pub/sub binary messages.
- *
- * Note: to disable an optimization it should be disabled the same amount of
- * times it was enabled - multiple optimization enablements for the same type
- * are merged, but reference counted (disabled when reference is zero).
- *
- * Note2: The pub/sub metadata type ID will match the optimnization type
- * requested (i.e., `WEBSOCKET_OPTIMIZE_PUBSUB`) and the optimized data is a
- * FIOBJ String containing a pre-encoded WebSocket packet ready to be sent.
- * i.e.:
- *
- *     FIOBJ pre_wrapped = (FIOBJ)fio_message_metadata(msg,
- *                               WEBSOCKET_OPTIMIZE_PUBSUB);
- *     fiobj_send_free((intptr_t)msg->udata1, fiobj_dup(pre_wrapped));
- */
-void websocket_optimize4broadcasts(intptr_t type, int enable);
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-#endif
+/*
+copyright: Boaz Segev, 2016-2019
+license: MIT
+
+Feel free to copy, use and enjoy according to the license provided.
+*/
+#ifndef H_WEBSOCKETS_H
+#define H_WEBSOCKETS_H
+
+#include <http.h>
+
+/* support C++ */
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** used internally: attaches the Websocket protocol to the socket. */
+void websocket_attach(intptr_t uuid, http_settings_s *http_settings,
+                      websocket_settings_s *args, void *data, size_t length);
+
+/* *****************************************************************************
+Websocket information
+***************************************************************************** */
+
+/** Returns the opaque user data associated with the websocket. */
+void *websocket_udata_get(ws_s *ws);
+
+/**
+ * Sets the opaque user data associated with the websocket.
+ *
+ * Returns the old value, if any.
+ */
+void *websocket_udata_set(ws_s *ws, void *udata);
+
+/**
+ * Returns the underlying socket UUID.
+ *
+ * This is only relevant for collecting the protocol object from outside of
+ * websocket events, as the socket shouldn't be written to.
+ */
+intptr_t websocket_uuid(ws_s *ws);
+
+/**
+ * Returns 1 if the WebSocket connection is in Client mode (connected to a
+ * remote server) and 0 if the connection is in Server mode (a connection
+ * established using facil.io's HTTP server).
+ */
+uint8_t websocket_is_client(ws_s *ws);
+
+/* *****************************************************************************
+Websocket Connection Management (write / close)
+***************************************************************************** */
+
+/** Writes data to the websocket. Returns -1 on failure (0 on success). */
+int websocket_write(ws_s *ws, fio_str_info_s msg, uint8_t is_text);
+/** Closes a websocket connection. */
+void websocket_close(ws_s *ws);
+
+/* *****************************************************************************
+Websocket Pub/Sub
+=================
+
+API for websocket pub/sub that can be used to publish messages across process
+boundries.
+
+Supports pub/sub engines (see {pubsub.h}) that can connect to a backend service
+such as Redis.
+
+The default pub/sub engine (if `NULL` or unspecified) will publish the messages
+to the process cluster (all the processes in `fio_run`).
+
+To publish to a channel, use the API provided in {pubsub.h}.
+***************************************************************************** */
+
+/** Possible arguments for the {websocket_subscribe} function. */
+struct websocket_subscribe_s {
+  /** the websocket receiving the message. REQUIRED. */
+  ws_s *ws;
+  /** the channel where the message was published. */
+  fio_str_info_s channel;
+  /**
+   * The callback that handles pub/sub notifications.
+   *
+   * Default: send directly to websocket client.
+   */
+  void (*on_message)(ws_s *ws, fio_str_info_s channel, fio_str_info_s msg,
+                     void *udata);
+  /**
+   * An optional cleanup callback for the `udata`.
+   */
+  void (*on_unsubscribe)(void *udata);
+  /** User opaque data, passed along to the notification. */
+  void *udata;
+  /** An optional callback for pattern matching. */
+  fio_match_fn match;
+  /**
+   * When using client forwarding (no `on_message` callback), this indicates if
+   * messages should be sent to the client as binary blobs, which is the safest
+   * approach.
+   *
+   * Default: tests for UTF-8 data encoding and sends as text if valid UTF-8.
+   * Messages above ~32Kb are always assumed to be binary.
+   */
+  unsigned force_binary : 1;
+  /**
+   * When using client forwarding (no `on_message` callback), this indicates if
+   * messages should be sent to the client as text.
+   *
+   * `force_binary` has precedence.
+   *
+   * Default: see above.
+   *
+   */
+  unsigned force_text : 1;
+};
+
+/**
+ * Subscribes to a channel. See {struct websocket_subscribe_s} for possible
+ * arguments.
+ *
+ * Returns a subscription ID on success and 0 on failure.
+ *
+ * All subscriptions are automatically revoked once the websocket is closed.
+ *
+ * If the connections subscribes to the same channel more than once, messages
+ * will be merged. However, another subscription ID will be assigned, since two
+ * calls to {websocket_unsubscribe} will be required in order to unregister from
+ * the channel.
+ */
+uintptr_t websocket_subscribe(struct websocket_subscribe_s args);
+
+#define websocket_subscribe(wbsckt, ...)                                       \
+  websocket_subscribe((struct websocket_subscribe_s){.ws = wbsckt, __VA_ARGS__})
+
+/**
+ * Unsubscribes from a channel.
+ *
+ * Failures are silent.
+ *
+ * All subscriptions are automatically revoked once the websocket is closed. So
+ * only use this function to unsubscribe while the websocket is open.
+ */
+void websocket_unsubscribe(ws_s *ws, uintptr_t subscription_id);
+
+/** Optimize generic broadcasts, for use in websocket_optimize4broadcasts. */
+#define WEBSOCKET_OPTIMIZE_PUBSUB (-32)
+/** Optimize text broadcasts, for use in websocket_optimize4broadcasts. */
+#define WEBSOCKET_OPTIMIZE_PUBSUB_TEXT (-33)
+/** Optimize binary broadcasts, for use in websocket_optimize4broadcasts. */
+#define WEBSOCKET_OPTIMIZE_PUBSUB_BINARY (-34)
+
+/**
+ * Enables (or disables) broadcast optimizations.
+ *
+ * This is performed automatically by the `websocket_subscribe` function.
+ * However, this function is provided for enabling the pub/sub metadata based
+ * optimizations for external connections / subscriptions.
+ *
+ * This function allows enablement (or disablement) of these optimizations:
+ *
+ * * WEBSOCKET_OPTIMIZE_PUBSUB - optimize all direct transmission messages,
+ *                               best attempt to detect Text vs. Binary data.
+ * * WEBSOCKET_OPTIMIZE_PUBSUB_TEXT - optimize direct pub/sub text messages.
+ * * WEBSOCKET_OPTIMIZE_PUBSUB_BINARY - optimize direct pub/sub binary messages.
+ *
+ * Note: to disable an optimization it should be disabled the same amount of
+ * times it was enabled - multiple optimization enablements for the same type
+ * are merged, but reference counted (disabled when reference is zero).
+ *
+ * Note2: The pub/sub metadata type ID will match the optimnization type
+ * requested (i.e., `WEBSOCKET_OPTIMIZE_PUBSUB`) and the optimized data is a
+ * FIOBJ String containing a pre-encoded WebSocket packet ready to be sent.
+ * i.e.:
+ *
+ *     FIOBJ pre_wrapped = (FIOBJ)fio_message_metadata(msg,
+ *                               WEBSOCKET_OPTIMIZE_PUBSUB);
+ *     fiobj_send_free((intptr_t)msg->udata1, fiobj_dup(pre_wrapped));
+ */
+void websocket_optimize4broadcasts(intptr_t type, int enable);
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif

data/isomorfeus-iodine.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w(lib ext)
 
-  spec.extensions = %w(ext/iodine/extconf.rb)
+  spec.extensions = %w(ext/iodine_ext/extconf.rb)
 
   spec.required_ruby_version = '>= 3.1.0'
 
@@ -34,7 +34,6 @@ Gem::Specification.new do |spec|
   spec.requirements << 'TLS requires OpenSSL >= 1.1.0.'
   spec.requirements << 'Or Windows with Ruby >= 3.0.0 build with MingW and MingW as compiler.'
 
-  # spec.add_development_dependency 'bundler', '>= 1.10', '< 2.0'
   spec.add_development_dependency 'rake', '~> 13.0', '< 14.0'
   spec.add_development_dependency 'minitest', '>=5', '< 6.0'
   spec.add_development_dependency 'rspec', '>=3.9.0', '< 4.0'

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '0.7.49'.freeze
+  VERSION = '0.7.50'.freeze
 end

data/lib/iodine.rb

@@ -3,7 +3,7 @@ require 'socket'  # TCPSocket is used internally for Hijack support
 # require 'openssl' # For SSL/TLS support using OpenSSL
 
 require 'iodine/version'
-require 'iodine/iodine' # loading a binary C extension
+require 'iodine_ext' # loading a binary C extension
 
 # Iodine is an HTTP / WebSocket server as well as an Evented Network Tool Library. In essense, Iodine is a Ruby port for the [facil.io](http://facil.io) C library.
 #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isomorfeus-iodine
 version: !ruby/object:Gem::Version
-  version: 0.7.49
+  version: 0.7.50
 platform: ruby
 authors:
 - Jan Biedermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
+date: 2022-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -116,7 +116,7 @@ email:
 executables:
 - iodine
 extensions:
-- ext/iodine/extconf.rb
+- ext/iodine_ext/extconf.rb
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
@@ -146,6 +146,7 @@ files:
 - examples/async_task.ru
 - examples/config.ru
 - examples/echo.ru
+- examples/etag.ru
 - examples/hello.ru
 - examples/pubsub_engine.ru
 - examples/redis.ru
@@ -154,80 +155,80 @@ files:
 - examples/tcp_client.rb
 - examples/x-sendfile.ru
 - exe/iodine
-- ext/iodine/extconf.rb
-- ext/iodine/fio.c
-- ext/iodine/fio.h
-- ext/iodine/fio_cli.c
-- ext/iodine/fio_cli.h
-- ext/iodine/fio_json_parser.h
-- ext/iodine/fio_siphash.c
-- ext/iodine/fio_siphash.h
-- ext/iodine/fio_tls.h
-- ext/iodine/fio_tls_missing.c
-- ext/iodine/fio_tls_openssl.c
-- ext/iodine/fio_tmpfile.h
-- ext/iodine/fiobj.h
-- ext/iodine/fiobj4fio.h
-- ext/iodine/fiobj_ary.c
-- ext/iodine/fiobj_ary.h
-- ext/iodine/fiobj_data.c
-- ext/iodine/fiobj_data.h
-- ext/iodine/fiobj_hash.c
-- ext/iodine/fiobj_hash.h
-- ext/iodine/fiobj_json.c
-- ext/iodine/fiobj_json.h
-- ext/iodine/fiobj_mem.h
-- ext/iodine/fiobj_mustache.c
-- ext/iodine/fiobj_mustache.h
-- ext/iodine/fiobj_numbers.c
-- ext/iodine/fiobj_numbers.h
-- ext/iodine/fiobj_str.c
-- ext/iodine/fiobj_str.h
-- ext/iodine/fiobject.c
-- ext/iodine/fiobject.h
-- ext/iodine/hpack.h
-- ext/iodine/http.c
-- ext/iodine/http.h
-- ext/iodine/http1.c
-- ext/iodine/http1.h
-- ext/iodine/http1_parser.h
-- ext/iodine/http_internal.c
-- ext/iodine/http_internal.h
-- ext/iodine/http_mime_parser.h
-- ext/iodine/iodine.c
-- ext/iodine/iodine.h
-- ext/iodine/iodine_caller.c
-- ext/iodine/iodine_caller.h
-- ext/iodine/iodine_connection.c
-- ext/iodine/iodine_connection.h
-- ext/iodine/iodine_defer.c
-- ext/iodine/iodine_defer.h
-- ext/iodine/iodine_fiobj2rb.h
-- ext/iodine/iodine_helpers.c
-- ext/iodine/iodine_helpers.h
-- ext/iodine/iodine_http.c
-- ext/iodine/iodine_http.h
-- ext/iodine/iodine_json.c
-- ext/iodine/iodine_json.h
-- ext/iodine/iodine_mustache.c
-- ext/iodine/iodine_mustache.h
-- ext/iodine/iodine_pubsub.c
-- ext/iodine/iodine_pubsub.h
-- ext/iodine/iodine_rack_io.c
-- ext/iodine/iodine_rack_io.h
-- ext/iodine/iodine_store.c
-- ext/iodine/iodine_store.h
-- ext/iodine/iodine_tcp.c
-- ext/iodine/iodine_tcp.h
-- ext/iodine/iodine_tls.c
-- ext/iodine/iodine_tls.h
-- ext/iodine/mustache_parser.h
-- ext/iodine/redis_engine.c
-- ext/iodine/redis_engine.h
-- ext/iodine/resp_parser.h
-- ext/iodine/websocket_parser.h
-- ext/iodine/websockets.c
-- ext/iodine/websockets.h
+- ext/iodine_ext/extconf.rb
+- ext/iodine_ext/fio.c
+- ext/iodine_ext/fio.h
+- ext/iodine_ext/fio_cli.c
+- ext/iodine_ext/fio_cli.h
+- ext/iodine_ext/fio_json_parser.h
+- ext/iodine_ext/fio_siphash.c
+- ext/iodine_ext/fio_siphash.h
+- ext/iodine_ext/fio_tls.h
+- ext/iodine_ext/fio_tls_missing.c
+- ext/iodine_ext/fio_tls_openssl.c
+- ext/iodine_ext/fio_tmpfile.h
+- ext/iodine_ext/fiobj.h
+- ext/iodine_ext/fiobj4fio.h
+- ext/iodine_ext/fiobj_ary.c
+- ext/iodine_ext/fiobj_ary.h
+- ext/iodine_ext/fiobj_data.c
+- ext/iodine_ext/fiobj_data.h
+- ext/iodine_ext/fiobj_hash.c
+- ext/iodine_ext/fiobj_hash.h
+- ext/iodine_ext/fiobj_json.c
+- ext/iodine_ext/fiobj_json.h
+- ext/iodine_ext/fiobj_mem.h
+- ext/iodine_ext/fiobj_mustache.c
+- ext/iodine_ext/fiobj_mustache.h
+- ext/iodine_ext/fiobj_numbers.c
+- ext/iodine_ext/fiobj_numbers.h
+- ext/iodine_ext/fiobj_str.c
+- ext/iodine_ext/fiobj_str.h
+- ext/iodine_ext/fiobject.c
+- ext/iodine_ext/fiobject.h
+- ext/iodine_ext/hpack.h
+- ext/iodine_ext/http.c
+- ext/iodine_ext/http.h
+- ext/iodine_ext/http1.c
+- ext/iodine_ext/http1.h
+- ext/iodine_ext/http1_parser.h
+- ext/iodine_ext/http_internal.c
+- ext/iodine_ext/http_internal.h
+- ext/iodine_ext/http_mime_parser.h
+- ext/iodine_ext/iodine.c
+- ext/iodine_ext/iodine.h
+- ext/iodine_ext/iodine_caller.c
+- ext/iodine_ext/iodine_caller.h
+- ext/iodine_ext/iodine_connection.c
+- ext/iodine_ext/iodine_connection.h
+- ext/iodine_ext/iodine_defer.c
+- ext/iodine_ext/iodine_defer.h
+- ext/iodine_ext/iodine_fiobj2rb.h
+- ext/iodine_ext/iodine_helpers.c
+- ext/iodine_ext/iodine_helpers.h
+- ext/iodine_ext/iodine_http.c
+- ext/iodine_ext/iodine_http.h
+- ext/iodine_ext/iodine_json.c
+- ext/iodine_ext/iodine_json.h
+- ext/iodine_ext/iodine_mustache.c
+- ext/iodine_ext/iodine_mustache.h
+- ext/iodine_ext/iodine_pubsub.c
+- ext/iodine_ext/iodine_pubsub.h
+- ext/iodine_ext/iodine_rack_io.c
+- ext/iodine_ext/iodine_rack_io.h
+- ext/iodine_ext/iodine_store.c
+- ext/iodine_ext/iodine_store.h
+- ext/iodine_ext/iodine_tcp.c
+- ext/iodine_ext/iodine_tcp.h
+- ext/iodine_ext/iodine_tls.c
+- ext/iodine_ext/iodine_tls.h
+- ext/iodine_ext/mustache_parser.h
+- ext/iodine_ext/redis_engine.c
+- ext/iodine_ext/redis_engine.h
+- ext/iodine_ext/resp_parser.h
+- ext/iodine_ext/websocket_parser.h
+- ext/iodine_ext/websockets.c
+- ext/iodine_ext/websockets.h
 - isomorfeus-iodine.gemspec
 - lib/iodine.rb
 - lib/iodine/connection.rb
@@ -246,7 +247,7 @@ metadata:
   github_repo: ssh://github.com/isomorfeus/gems
   source_code_uri: https://github.com/isomorfeus/isomorfeus-iodine
 post_install_message: |-
-  Thank you for installing Iodine 0.7.49.
+  Thank you for installing Iodine 0.7.50.
   Remember: if iodine supports your business, it's only fair to give value back (code contributions / donations) to Bo, see https://github.com/boazsegev/iodine
 rdoc_options: []
 require_paths: