summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2017-11-06 18:01:58 +0100
committerJosé Bollo <jose.bollo@iot.bzh>2017-11-06 18:01:58 +0100
commitfafe08c7608f3950ed20b54d7e01e1beeb7306b7 (patch)
tree5365e27a9156096ac97fad59fca4ad7092565ae4
parentd35293b1f03edc446900dcdcce941c83178271d7 (diff)
afb-session: add comments
Change-Id: I88026384d3f5e98659fba2bb774e41e931d45f51 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
-rw-r--r--src/afb-session.c83
1 files changed, 64 insertions, 19 deletions
diff --git a/src/afb-session.c b/src/afb-session.c
index 68de6723..63c9f595 100644
--- a/src/afb-session.c
+++ b/src/afb-session.c
@@ -65,18 +65,6 @@ static struct {
char initok[37];
} sessions;
-/**
- * Get the index of the 'key' in the cookies array.
- * @param key the key to scan
- * @return the index of the list for key within cookies
- */
-static int cookeyidx(const void *key)
-{
- intptr_t x = (intptr_t)key;
- unsigned r = (unsigned)((x >> 5) ^ (x >> 15));
- return r & COOKEYMASK;
-}
-
/* generate a uuid */
static void new_uuid(char uuid[37])
{
@@ -420,50 +408,107 @@ const char *afb_session_token (struct afb_session *session)
return session->token;
}
-/* Set, get, replace, remove a cookie key */
+/**
+ * Get the index of the 'key' in the cookies array.
+ * @param key the key to scan
+ * @return the index of the list for key within cookies
+ */
+static int cookeyidx(const void *key)
+{
+ intptr_t x = (intptr_t)key;
+ unsigned r = (unsigned)((x >> 5) ^ (x >> 15));
+ return r & COOKEYMASK;
+}
+
+/**
+ * Set, get, replace, remove a cookie of 'key' for the 'session'
+ *
+ * The behaviour of this function depends on its parameters:
+ *
+ * @param session the session
+ * @param key the key of the cookie
+ * @param makecb the creation function
+ * @param freecb the release function
+ * @param closure an argument
+ * @param replace a boolean enforcing replecement of the previous value
+ *
+ * @return the value of the cookie
+ *
+ * The 'key' is a pointer and compared as pointers.
+ *
+ * For getting the current value of the cookie:
+ *
+ * afb_session_cookie(session, key, NULL, NULL, NULL, 0)
+ *
+ * For storing the value of the cookie
+ *
+ * afb_session_cookie(session, key, NULL, NULL, value, 1)
+ */
void *afb_session_cookie(struct afb_session *session, const void *key, void *(*makecb)(void *closure), void (*freecb)(void *item), void *closure, int replace)
{
int idx;
void *value;
- struct cookie *cookie;
+ struct cookie *cookie, **prv;
+ /* get key hashed index */
idx = cookeyidx(key);
+
+ /* lock session and search for the cookie of 'key' */
lock(session);
- cookie = session->cookies[idx];
+ prv = &session->cookies[idx];
for (;;) {
+ cookie = *prv;
if (!cookie) {
+ /* 'key' not found, create value using 'closure' and 'makecb' */
value = makecb ? makecb(closure) : closure;
+ /* store the the only if it has some meaning */
if (replace || makecb || freecb) {
cookie = malloc(sizeof *cookie);
if (!cookie) {
errno = ENOMEM;
- if (freecb)
+ /* calling freecb if there is no makecb may have issue */
+ if (makecb && freecb)
freecb(value);
value = NULL;
} else {
cookie->key = key;
cookie->value = value;
cookie->freecb = freecb;
- cookie->next = session->cookies[idx];
- session->cookies[idx] = cookie;
+ cookie->next = NULL;
+ *prv = cookie;
}
}
break;
} else if (cookie->key == key) {
+ /* cookie of key found */
if (!replace)
+ /* not replacing, get the value */
value = cookie->value;
else {
+ /* create value using 'closure' and 'makecb' */
value = makecb ? makecb(closure) : closure;
+
+ /* free previous value is needed */
if (cookie->value != value && cookie->freecb)
cookie->freecb(cookie->value);
+
+ /* store the value and its releaser */
cookie->value = value;
cookie->freecb = freecb;
+
+ /* but if both are NULL drop the cookie */
+ if (!value && !freecb) {
+ *prv = cookie->next;
+ free(cookie);
+ }
}
break;
} else {
- cookie = cookie->next;
+ prv = &(cookie->next);
}
}
+
+ /* unlock the session and return the value */
unlock(session);
return value;
}