MEMCACHED_POOL_CREATE(3)

🌸 NAME 🌸

okay so bestie, this is MEMCACHED_POOL_CREATE(3) — the manual page for memcached_pool_create, straight from the libmemcached docs ✨ (and yes, it lives in the libmemcached-awesome collection, iykyk 💅).

---

🎀 SYNOPSIS 🎀

#include <libmemcachedutil-1.0/pool.h>

Compile and link with -lmemcachedutil -lmemcached 🫶

typedef struct memcached_pool_st memcached_pool_st

memcached_pool_st *memcached_pool(const char *option_string, size_t
option_string_length)

Parameters

• option_string — configuration string
• option_string_length — length of options_string without any trailing zero byte

Returns — an allocated and initialized memcached_pool_st instance on success, or nullptr on failure 😭

---

✨ memcached_pool_destroy

memcached_st *memcached_pool_destroy(memcached_pool_st *pool)

Parameters

• pool — initialized memcached_pool_st instance to free

Returns — pointer to the 'master' memcached_st instance by legacy 👑

---

🦋 memcached_pool_fetch

memcached_st *memcached_pool_fetch(memcached_pool_st *pool, struct
timespec *relative_time, memcached_return_t *rc)

Added in version 0.53: Synonym for memcached_pool_pop ⭐

Parameters

• pool — initialized memcached_pool_st instance
• relative_time — time to block thread and wait for a connection to become available when pool size is exceeded, unless nullptr
• rc — out pointer to memcached_return_t

Returns — pointer to an available memcached_st instance 🌈

---

💜 memcached_pool_release

memcached_return_t memcached_pool_release(memcached_pool_st *pool,
memcached_st *mmc)

Added in version 0.53: Synonym for memcached_pool_push. 💅

Parameters

• pool — initialized memcached_pool_st instance
• mmc — the memcached_st instance to return to the pool

Returns — memcached_return_t indicating success ✅

---

🍓 memcached_pool_behavior_set

memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool,
memcached_behavior_t flag, uint64_t data)

Parameters

• pool — initialized memcached_pool_st instance
• flag — the behavior to change
• value — the value to set for flag

Returns — memcached_return_t indicating success ✅

---

🧚 memcached_pool_behavior_get

memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool,
memcached_behavior_t flag, uint64_t *value)

Parameters

• pool — initialized memcached_pool_st instance
• flag — the behavior to read
• value — out pointer to receive the set value of flag

Returns — memcached_return_t indicating success ✅

---

💀 memcached_pool_create

memcached_pool_st *memcached_pool_create(memcached_st *mmc, int initial,
int max)

Deprecated since version 0.46: Use memcached_pool() 🚨

---

🙈 memcached_pool_pop

memcached_st *memcached_pool_pop(memcached_pool_st *pool, bool block,
memcached_return_t *rc)

Deprecated since version 0.53: Use memcached_pool_fetch() 🚨

---

🎀 memcached_pool_push

memcached_return_t memcached_pool_push(memcached_pool_st *pool,
memcached_st *mmc)

Deprecated since version 0.53: Use memcached_pool_release() 🚨

---

💖 DESCRIPTION 💖

memcached_pool() is the main character here — you use it to create a connection pool of objects, which lets you skip the overhead of calling memcached_clone for short-lived memcached_st objects. Fr fr, it's a glow-up for your perf. If you wanna know what the configuration string should look like, go peek at libmemcached Configuration 📖.

memcached_pool_destroy() destroys the connection pool you made with memcached_pool_create() and releases every allocated resource. It hands back the pointer to the memcached_st structure that was passed as an argument to memcached_pool_create(), and it gives you ownership of that pointer back — but only if it was created with memcached_pool_create(). Otherwise, NULL is returned. 😭

memcached_pool_fetch() fetches a connection structure out of the connection pool. The relative_time argument says whether the function should block and wait for a connection structure to become available when we're trying to exceed the maximum size. And yes, you need to specify the time in relative time ⏰.

memcached_pool_release() returns a connection structure back to the pool. 🫶

memcached_pool_behavior_get() and memcached_pool_behavior_set() get/set behavior flags on all connections in the pool. All of them. Every single one. 👑

Both memcached_pool_release() and memcached_pool_fetch() are thread safe 🧵✨ — no cap.

---

👑 RETURN VALUE 👑

memcached_pool_destroy() returns the pointer (and the ownership) to the memcached_st structure used to create the pool. If connections are in use, it returns NULL 💀.

memcached_pool_pop() returns a pointer to a memcached_st structure from the pool — or NULL if an allocation cannot be satisfied.

memcached_pool_release() returns MEMCACHED_SUCCESS upon success. ✅

memcached_pool_behavior_get() and memcached_pool_behavior_get() return MEMCACHED_SUCCESS upon success. ✅

memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st instance, or MEMCACHED_NOTFOUND if no memcached_st instance was available, respectively. 😭

NOTE: 🚨 If any method returns MEMCACHED_IN_PROGRESS, then a lock on the pool could not be obtained. 💀 If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.

---

🌈 SEE ALSO 🌈

memcached(1) libmemcached(3) libmemcached_configuration(3) ‐ memcached_strerror(3)

---

and that's the whole vibe, bestie 🫶 this was version 1.1, dated Jul 24, 2025 — slay, iconic, no notes 💅✨🎀