MEMCACHED_POOL_BEHAVIOR_SET(3)

📦
version 1.1.4 · 13 versions
, in fedora 43

💖 NAME 💖

memcached_pool_behavior_set — ok so this is the libmemcached Documentation page for the whole connection-pool squad, and yes bestie, this is MEMCACHED_P...BEHAVIOR_SET(3) from libmemcached-awesome 🦋 she's giving pool management, she's giving thread safety, she's iconic.

✨ SYNOPSIS ✨

First things first, the includes and the link line, no skipping:

#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 — the configuration string, literally the whole vibe of your pool in text form
  • option_string_length — the 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 — an initialized memcached_pool_st instance to free

Returns

A 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: it's a synonym for memcached_pool_pop ✨

Parameters 🌸

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

Returns

A 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 — an initialized memcached_pool_st instance
  • mmc — the memcached_st instance to return to the pool

Returns

A 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 — an initialized memcached_pool_st instance
  • flag — the behavior to change
  • value — the value to set for flag

Returns

A 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 — an initialized memcached_pool_st instance
  • flag — the behavior to read
  • value — out pointer to receive the set value of flag

Returns

A 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() instead, bestie, she's retired 💀

🎀 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() instead 🥀

🎀 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() instead 🥀

🌈 DESCRIPTION 🌈

Ok so here's the tea, and it's actually really good tea ☕

memcached_pool() is used to create a connection pool of objects, and you'd use it to remove the overhead of calling memcached_clone for short lived memcached_st objects. No more cloning tax, periodt. For the details on the format of that configuration string, please see libmemcached Configuration 💅

memcached_pool_destroy() is used to destroy the connection pool created with memcached_pool_create() and release all allocated resources. It will return the pointer to the memcached_st structure passed as an argument to memcached_pool_create(), and it returns the ownership of the pointer to the caller when it was created with memcached_pool_create(), otherwise NULL is returned..

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 become available if we try to exceed the maximum size. You need to specify time in relative time, fr fr ⏳

memcached_pool_release() is used to return a connection structure back to the pool 🫶

memcached_pool_behavior_get() and memcached_pool_behavior_set() are used to get/set behavior flags on all connections in the pool. Every single one, no stragglers ✨

Both memcached_pool_release() and memcached_pool_fetch() are thread safe. Yes bestie, she's safe to share 👑

💀 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. (not me noticing the original names _get twice here — iykyk, I'm keeping it exactly as written, no notes 🌸)

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. She was busy, ok? 💅 If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned. Vibe check failed, sorry bestie 😭

🔥 SEE ALSO 🔥

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

And that's the whole page, you ate it up 🍓 This was libmemcached-awesome version 1.1, dated Jul 24, 2025 — go forth and pool responsibly, my love 💜🧚

📦 where this page comes from