naming + docs + router polish WIP

Author: boazsegev

fio-stl.h

@@ -35380,32 +35380,32 @@ typedef struct fio_io_listen_args {
   uint8_t hide_from_log;
 } fio_io_listen_args;
 
-typedef struct fio_listener_s fio_listener_s;
+typedef struct fio_io_listener_s fio_io_listener_s;
 /**
  * Sets up a network service on a listening socket.
  *
  * Returns a self-destructible listener handle on success or NULL on error.
  */
-SFUNC fio_listener_s *fio_io_listen(fio_io_listen_args args);
+SFUNC fio_io_listener_s *fio_io_listen(fio_io_listen_args args);
 #define fio_io_listen(...) fio_io_listen((fio_io_listen_args){__VA_ARGS__})
 
 /** Notifies a listener to stop listening. */
-SFUNC void fio_io_listen_stop(fio_listener_s *l);
+SFUNC void fio_io_listen_stop(fio_io_listener_s *l);
 
 /** Returns the listener's associated protocol. */
-SFUNC fio_io_protocol_s *fio_io_listener_protocol(fio_listener_s *l);
+SFUNC fio_io_protocol_s *fio_io_listener_protocol(fio_io_listener_s *l);
 
 /** Returns the listener's associated `udata`. */
-SFUNC void *fio_io_listener_udata(fio_listener_s *l);
+SFUNC void *fio_io_listener_udata(fio_io_listener_s *l);
 
 /** Sets the listener's associated `udata`, returning the old value. */
-SFUNC void *fio_io_listener_udata_set(fio_listener_s *l, void *new_udata);
+SFUNC void *fio_io_listener_udata_set(fio_io_listener_s *l, void *new_udata);
 
 /** Returns the URL on which the listener is listening. */
-SFUNC fio_buf_info_s fio_io_listener_url(fio_listener_s *l);
+SFUNC fio_buf_info_s fio_io_listener_url(fio_io_listener_s *l);
 
 /** Returns true if the listener protocol has an attached TLS context. */
-SFUNC int fio_io_listener_is_tls(fio_listener_s *l);
+SFUNC int fio_io_listener_is_tls(fio_io_listener_s *l);
 
 /* *****************************************************************************
 Connecting as a Client
@@ -38260,37 +38260,37 @@ static void fio___io_listen_free(void *l_) {
   FIO_MEM_FREE_(l, sizeof(*l) + l->url_len + 1);
 }
 
-SFUNC void fio_io_listen_stop(fio_listener_s *listener) {
+SFUNC void fio_io_listen_stop(fio_io_listener_s *listener) {
   if (listener)
     fio___io_listen_free((fio___io_listen_s *)listener);
 }
 
 /** Returns the URL on which the listener is listening. */
-SFUNC fio_buf_info_s fio_io_listener_url(fio_listener_s *listener) {
+SFUNC fio_buf_info_s fio_io_listener_url(fio_io_listener_s *listener) {
   fio___io_listen_s *l = (fio___io_listen_s *)listener;
   return FIO_BUF_INFO2(l->url, l->url_len);
 }
 
 /** Returns true if the listener protocol has an attached TLS context. */
-SFUNC int fio_io_listener_is_tls(fio_listener_s *listener) {
+SFUNC int fio_io_listener_is_tls(fio_io_listener_s *listener) {
   fio___io_listen_s *l = (fio___io_listen_s *)listener;
   return !!l->tls_ctx;
 }
 
 /** Returns the listener's associated protocol. */
-SFUNC fio_io_protocol_s *fio_io_listener_protocol(fio_listener_s *listener) {
+SFUNC fio_io_protocol_s *fio_io_listener_protocol(fio_io_listener_s *listener) {
   fio___io_listen_s *l = (fio___io_listen_s *)listener;
   return l->protocol;
 }
 
 /** Returns the listener's associated `udata`. */
-SFUNC void *fio_io_listener_udata(fio_listener_s *listener) {
+SFUNC void *fio_io_listener_udata(fio_io_listener_s *listener) {
   fio___io_listen_s *l = (fio___io_listen_s *)listener;
   return l->udata;
 }
 
 /** Sets the listener's associated `udata`, returning the old value. */
-SFUNC void *fio_io_listener_udata_set(fio_listener_s *listener,
+SFUNC void *fio_io_listener_udata_set(fio_io_listener_s *listener,
                                       void *new_udata) {
   void *old;
   fio___io_listen_s *l = (fio___io_listen_s *)listener;
@@ -38389,18 +38389,19 @@ int fio_io_listen___(void); /* IDE marker */
  *
  * See the `fio_listen` Macro for details.
  */
-SFUNC fio_listener_s *fio_io_listen FIO_NOOP(struct fio_io_listen_args args) {
+SFUNC fio_io_listener_s *fio_io_listen
+FIO_NOOP(struct fio_io_listen_args args) {
   fio___io_listen_s *l = NULL;
   void *built_tls = NULL;
   int should_free_tls = !args.tls;
   FIO_STR_INFO_TMP_VAR(url_alt, 2048);
   if (!args.protocol) {
     FIO_LOG_ERROR("fio_io_listen requires a protocol to be assigned.");
-    return (fio_listener_s *)l;
+    return (fio_io_listener_s *)l;
   }
   if (args.on_root && !fio_io_is_master()) {
     FIO_LOG_ERROR("fio_io_listen called with `on_root` by a non-root worker.");
-    return (fio_listener_s *)l;
+    return (fio_io_listener_s *)l;
   }
   if (!args.url) {
     args.url = getenv("ADDRESS");
@@ -38473,7 +38474,7 @@ SFUNC fio_listener_s *fio_io_listen FIO_NOOP(struct fio_io_listen_args args) {
   l->fd = fio_sock_open2(l->url, FIO_SOCK_SERVER | FIO_SOCK_TCP);
   if (l->fd == -1) {
     fio___io_listen_free(l);
-    return (fio_listener_s *)(l = NULL);
+    return (fio_io_listener_s *)(l = NULL);
   }
   if (fio_io_is_running()) {
     fio_io_defer(fio___io_listen_attach_task_deferred, l, NULL);
@@ -38484,7 +38485,7 @@ SFUNC fio_listener_s *fio_io_listen FIO_NOOP(struct fio_io_listen_args args) {
         (void *)l);
   }
   fio_state_callback_add(FIO_CALL_AT_EXIT, fio___io_listen_free, l);
-  return (fio_listener_s *)l;
+  return (fio_io_listener_s *)l;
 }
 
 /* *****************************************************************************
@@ -47173,7 +47174,7 @@ SFUNC int fio_http_route FIO_NOOP(fio_http_listener_s *l,
     goto invalid_listener_error;
   p = FIO_PTR_FROM_FIELD(fio___http_protocol_s,
                          state[FIO___HTTP_PROTOCOL_ACCEPT].protocol,
-                         fio_io_listener_protocol((fio_listener_s *)l));
+                         fio_io_listener_protocol((fio_io_listener_s *)l));
   r = &p->router;
   if (!u || !u[0]) {
     url = "/";
@@ -47245,9 +47246,13 @@ SFUNC int fio_http_route FIO_NOOP(fio_http_listener_s *l,
     s.public_folder = FIO_STR_INFO2((char *)s.tls, s.public_folder.len);
     s.public_folder.buf[s.public_folder.len] = 0;
   }
-  /* make sure we're not leaking memory when overwriting */
-  if (r->s.tls && (char *)r->s.tls == r->s.public_folder.buf)
-    FIO_MEM_FREE_(r->s.tls, r->s.public_folder.len + 1);
+  /* make sure we're not leaking memory when overwriting an existing route */
+  if (r->s.on_http) {
+    if (r->s.on_stop != p->settings.on_stop || r->s.udata != p->settings.udata)
+      r->s.on_stop(&r->s);
+    if (r->s.tls && (char *)r->s.tls == r->s.public_folder.buf)
+      FIO_MEM_FREE_(r->s.tls, r->s.public_folder.len + 1);
+  }
   r->s = s;
   return err;
 
@@ -47276,6 +47281,8 @@ FIO_SFUNC fio_http_settings_s *fio___http_route_settings(
   uint8_t *pos = (uint8_t *)path->buf;
   const uint8_t *n = pos;
   pos += (*pos == (uint8_t)'/');
+  if (!*pos)
+    return r;
   for (uint8_t c, hi, lo;
        route && ((c = *pos) >= (sizeof(*r) / sizeof(void *)));
        ++pos) {
@@ -47284,8 +47291,7 @@ FIO_SFUNC fio_http_settings_s *fio___http_route_settings(
       r = &route->s;
       n = pos;
     } else if (c == (uint8_t)'%' && (hi = fio_c2i(pos[1])) < 16) {
-      /* decrypt route? */
-      if ((lo = fio_c2i(pos[2])) < 16) {
+      if ((lo = fio_c2i(pos[2])) < 16) { /* decrypt route */
         c = (hi << 4) | lo;
         pos += 2;
         if (c < (sizeof(*r) / sizeof(void *)))
@@ -47348,7 +47354,7 @@ SFUNC fio_http_settings_s *fio_http_route_settings(fio_http_listener_s *l,
     return r;
   p = FIO_PTR_FROM_FIELD(fio___http_protocol_s,
                          state[FIO___HTTP_PROTOCOL_ACCEPT].protocol,
-                         fio_io_listener_protocol((fio_listener_s *)l));
+                         fio_io_listener_protocol((fio_io_listener_s *)l));
   r = fio___http_route_settings(&p->router, &path);
   return r;
 }
@@ -47681,7 +47687,7 @@ SFUNC fio_http_settings_s *fio_http_listener_settings(fio_http_listener_s *l) {
   fio___http_protocol_s *p =
       FIO_PTR_FROM_FIELD(fio___http_protocol_s,
                          state[FIO___HTTP_PROTOCOL_ACCEPT].protocol,
-                         fio_io_listener_protocol((fio_listener_s *)l));
+                         fio_io_listener_protocol((fio_io_listener_s *)l));
   return &p->settings;
 }
 

fio-stl.md

@@ -9674,15 +9674,15 @@ uint64_t fiobj2hash(FIOBJ target_hash, FIOBJ value);
 
 Calculates an object's hash value for a specific hash map object.
 
-#### `fiobj_hash_set2`
+#### `fiobj_hash_set`
 
 ```c
 FIOBJ fiobj_hash_set2(FIOBJ hash, FIOBJ key, FIOBJ value);
 ```
 
 Inserts a value to a hash map, with a default hash value calculation.
 
-#### `fiobj_hash_set_if_missing2`
+#### `fiobj_hash_set_if_missing`
 
 ```c
 FIOBJ fiobj_hash_set_if_missing2(FIOBJ hash, FIOBJ key, FIOBJ value);
@@ -9692,42 +9692,42 @@ Inserts a value to a hash map, with a default hash value calculation.
 
 If the key already exists in the Hash Map, the value will be freed instead.
 
-#### `fiobj_hash_get2`
+#### `fiobj_hash_get`
 
 ```c
 FIOBJ fiobj_hash_get2(FIOBJ hash, FIOBJ key);
 ```
 
 Finds a value in a hash map, with a default hash value calculation.
 
-#### `fiobj_hash_remove2`
+#### `fiobj_hash_remove`
 
 ```c
 int fiobj_hash_remove2(FIOBJ hash, FIOBJ key, FIOBJ *old);
 ```
 
 Removes a value from a hash map, with a default hash value calculation.
 
-#### `fiobj_hash_set3`
+#### `fiobj_hash_set2`
 
 ```c
-FIOBJ fiobj_hash_set3(FIOBJ hash, const char *key, size_t len, FIOBJ value);
+FIOBJ fiobj_hash_set2(FIOBJ hash, const char *key, size_t len, FIOBJ value);
 ```
 
 Sets a value in a hash map, allocating the key String and automatically calculating the hash value.
 
-#### `fiobj_hash_get3`
+#### `fiobj_hash_get2`
 
 ```c
-FIOBJ fiobj_hash_get3(FIOBJ hash, const char *buf, size_t len);
+FIOBJ fiobj_hash_get2(FIOBJ hash, const char *buf, size_t len);
 ```
 
 Finds a String value in a hash map, using a temporary String as the key and automatically calculating the hash value.
 
-#### `fiobj_hash_remove3`
+#### `fiobj_hash_remove2`
 
 ```c
-int fiobj_hash_remove3(FIOBJ hash, const char *buf, size_t len, FIOBJ *old);
+int fiobj_hash_remove2(FIOBJ hash, const char *buf, size_t len, FIOBJ *old);
 ```
 
 Removes a String value in a hash map, using a temporary String as the key and automatically calculating the hash value.
@@ -9792,8 +9792,8 @@ If `dest` is an existing String, the formatted JSON data will be appended to the
 
 ```c
 FIOBJ result = fiobj_json_parse2("{\"name\":\"John\",\"surname\":\"Smith\",\"ID\":1}",40, NULL);
-FIO_ASSERT( fiobj2cstr(fiobj_hash_get3(result, "name", 4)).len == 4 &&
-            !memcmp(fiobj2cstr(fiobj_hash_get3(result, "name", 4)).buf, "John", 4), "result error");
+FIO_ASSERT( fiobj2cstr(fiobj_hash_get2(result, "name", 4)).len == 4 &&
+            !memcmp(fiobj2cstr(fiobj_hash_get2(result, "name", 4)).buf, "John", 4), "result error");
 
 FIOBJ_STR_TEMP_VAR(json_str); /* places string on the stack */
 fiobj2json(json_str, result, 1);
@@ -10494,7 +10494,7 @@ Returns the last millisecond when the IO reactor polled for events.
 ### Listening to Incoming Connections
 
 ```c
-void *fio_io_listen(fio_io_listen_args args);
+fio_io_listener_s *fio_io_listen(fio_io_listen_args args);
 /* Named arguments using macro. */
 #define fio_io_listen(...) fio_io_listen((fio_io_listen_args){__VA_ARGS__})
 
@@ -10566,47 +10566,47 @@ fio_io_listen(.protocol = &MY_PROTOCOL);
 #### `fio_io_listen_stop`
 
 ```c
-void fio_io_listen_stop(void *listener);
+void fio_io_listen_stop(fio_io_listener_s *listener);
 ```
 
 Notifies a listener to stop listening.
 
 #### `fio_io_listener_is_tls`
 
 ```c
-int fio_io_listener_is_tls(void *listener);
+int fio_io_listener_is_tls(fio_io_listener_s *listener);
 ```
 
 Returns true if the listener protocol has an attached TLS context.
 
 #### `fio_io_listener_protocol`
 
 ```c
-fio_io_protocol_s *fio_io_listener_protocol(void *listener);
+fio_io_protocol_s *fio_io_listener_protocol(fio_io_listener_s *listener);
 ```
 
 Returns the listener's associated protocol.
 
 #### `fio_io_listener_udata`
 
 ```c
-void *fio_io_listener_udata(void *listener);
+void *fio_io_listener_udata(fio_io_listener_s *listener);
 ```
 
 Returns the listener's associated `udata`.
 
 #### `fio_io_listener_udata_set`
 
 ```c
-void *fio_io_listener_udata_set(void *listener, void *new_udata);
+void *fio_io_listener_udata_set(fio_io_listener_s *listener, void *new_udata);
 ```
 
 Sets the listener's associated `udata`, returning the old value.
 
 #### `fio_io_listener_url`
 
 ```c
-fio_buf_info_s fio_io_listener_url(void *listener);
+fio_buf_info_s fio_io_listener_url(fio_io_listener_s *listener);
 ```
 
 Returns the URL on which the listener is listening.