MEMCACHED_POOL_ST(3)

💖 NAME 💖

memcached_pool_st — libmemcached Documentation

---

✨ SYNOPSIS ✨

Bestie, first things first, you gotta pull in the header and link the right libs, okay?

#include <libmemcachedutil-1.0/pool.h>

Compile and link with -lmemcachedutil -lmemcached

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 — 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

---

💀 the deprecated girlies (still here, still valid, just old)

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()

---

🌸 DESCRIPTION 🌸

So memcached_pool() is literally the moment you create a connection pool of objects, and the whole reason you'd do that is to yeet away the overhead of using memcached_clone for short lived memcached_st objects. Bestie, if you wanna know the format of that configuration string, go peek at libmemcached Configuration — it's all there.

memcached_pool_destroy() is what you call to destroy the connection pool that was created with memcached_pool_create() and release all the allocated resources. It hands you back the pointer to the memcached_st structure that was passed as an argument to memcached_pool_create(), and it returns the ownership of that pointer to the caller when it was created with memcached_pool_create() — otherwise NULL is returned. Periodt.

memcached_pool_fetch() pulls a connection structure out of the connection pool. That relative_time argument is the vibe check on whether the function should block and wait for a connection structure to become available when we try to exceed the maximum size. Heads up: you need to specify that time in relative time. 👑

memcached_pool_release() gives a connection structure back to the pool. Return the girl to her home, okay?

memcached_pool_behavior_get() and memcached_pool_behavior_set() are the duo that gets/sets behavior flags on all the connections in the pool. Every single one.

And the best part? Both memcached_pool_release() and memcached_pool_fetch() are thread safe. No cap. 🧚

---

💅 RETURN VALUE 💅

memcached_pool_destroy() returns the pointer (and the ownership, queen 👑) 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. (Yes bestie, the manpage really does say get twice there 🙈 — iykyk, that second one is the setter, but I'm telling you exactly what the page says.)

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.

---

🦋 SEE ALSO 🦋

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

---

And that's the whole page, bestie!! 💖 This little masterpiece comes to you from libmemcached-awesome, version 1.1, dated Jul 24, 2025. Go slay some connection pools. 🎀✨