MEMCACHED_POOL_FETCH(3)

💖 MEMCACHED_POOL_FETCH 💖

okay bestie, pull up a chair, we're talking about libmemcached-awesome today, and specifically the page for memcached_pool_fetch (that's the (3) one, library-land, iykyk). this is your connection pool era and honestly? iconic.

---

✨ NAME ✨

memcached_pool_fetch — libmemcached Documentation

like literally, that's the whole name section. no notes. 💅

---

🦋 SYNOPSIS 🦋

first things first, the vibes you need to import:

#include <libmemcachedutil-1.0/pool.h>

and when you compile + link, you gotta do it like this, no cap:

Compile and link with -lmemcachedutil -lmemcached

then we got the little type declaration, the moment everyone waits for:

typedef struct memcached_pool_st memcached_pool_st

---

🌸 memcached_pool

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

---

💀 deprecated era (still here tho)

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

Deprecated since version 0.46: Use memcached_pool()

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_return_t memcached_pool_push(memcached_pool_st *pool,
memcached_st *mmc)

Deprecated since version 0.53: Use memcached_pool_release()

🚨 bestie listen, those three are deprecated, okay? they still exist but they're giving "old money that didn't invest well". use the new ones.

---

👑 DESCRIPTION 👑

so memcached_pool() is how you create a connection pool of objects, and the whole point is to remove the overhead of using memcached_clone for short lived memcached_st objects. basically, stop making new ones, reuse your faves. 🫶 for the details on the format of the configuration string, go see libmemcached Configuration.

memcached_pool_destroy() is the goodbye-girl function — it destroys the connection pool created with memcached_pool_create() and releases all allocated resources. it will return the pointer to the memcached_st structure passed as an argument to memcached_pool_create(), and returns the ownership of the pointer to the caller when created with memcached_pool_create(), otherwise NULL is returned.. (yes the double period is in the original, we respect the lore 💅)

memcached_pool_fetch() is used to fetch a connection structure from the connection pool. the relative_time argument specifies if the function should block and wait for a connection structure to be available if we try to exceed the maximum size. you need to specify time in relative time.

memcached_pool_release() is used to return a connection structure back to the pool. give it back, it's not yours anymore, it's the pool's turn with the brain cell.

memcached_pool_behavior_get() and memcached_pool_behavior_set() is used to get/set behavior flags on all connections in the pool.

and the best part: both memcached_pool_release() and memcached_pool_fetch() are thread safe. slay. 🔥

---

💅 RETURN VALUE 💅

memcached_pool_destroy() returns the pointer (and 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, 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.

like, no cap, watch your args. 🙈

---

🌟 SEE ALSO 🌟

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

---

and that's the whole page, bestie!! 🎀 this one's from libmemcached-awesome, version 1.1, dated Jul 24, 2025. go forth and pool responsibly. mwah 💖✨