memcached_pool_behavior_get3
Libmemcached documentation
Overview
memcached_pool() is used to create a connection pool of objects you may use to remove the overhead of using memcached_clone for short lived memcached_st <#_CPPv412memcached_st> objects. Please see libmemcached Configuration <> for details on the format of the configuration string.
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 <#_CPPv412memcached_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..
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.
memcached_pool_behavior_get() and memcached_pool_behavior_set() is used to get/set behavior flags on all connections in the pool.
Both memcached_pool_release() and memcached_pool_fetch() are thread safe.
Return value
memcached_pool_destroy() returns the pointer (and ownership) to the memcached_st <#_CPPv412memcached_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 <#_CPPv412memcached_st> structure from the pool (or NULL if an allocation cannot be satisfied).
memcached_pool_release() returns MEMCACHED_SUCCESS <#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE> upon success.
memcached_pool_behavior_get() and memcached_pool_behavior_get() return MEMCACHED_SUCCESS <#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE> upon success.
memcached_pool_fetch() may return MEMCACHED_TIMEOUT <#_CPPv4N18memcached_return_t17MEMCACHED_TIMEOUTE> if a timeout occurs while waiting for a free memcached_st <#_CPPv412memcached_st> instance, MEMCACHED_NOTFOUND <#_CPPv4N18memcached_return_t18MEMCACHED_NOTFOUNDE> if no memcached_st <#_CPPv412memcached_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 <#_CPPv4N18memcached_return_t27MEMCACHED_INVALID_ARGUMENTSE> will be returned.
History
- Arch Linux 2026-11-01: the text shown here
- Debian 13 (Trixie)
- Debian 12 (Bookworm)
- Debian 11 (Bullseye) to Debian 8 (Jessie)
- Debian 7 (Wheezy)
- Debian 6.0 (Squeeze)