git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/memcached_pool.rst

   1 ============================
   2 Working with memcached pools
   3 ============================
   4
   5 --------
   6 SYNOPSIS
   7 --------
   8
   9 #include <libmemcached/memcached_pool.h>
  10   Compile and link with -lmemcachedutil -lmemcached
  11
  12 .. c:type:: struct memcached_pool_st
  13
  14   typedef struct memcached_pool_st memcached_pool_st;
  15
  16 .. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length)
  17
  18 .. c:function:: memcached_st* memcached_pool_destroy(memcached_pool_st* pool)
  19
  20 .. c:function:: memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc)
  21 .. versionadded:: 0.53
  22    Synonym for memcached_pool_pop
  23
  24 .. c:function:: memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc)
  25 .. versionadded:: 0.53
  26    Synonym for memcached_pool_push.
  27
  28 .. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
  29
  30 .. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
  31
  32
  33 .. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)
  34 .. deprecated:: 0.46
  35    Use :c:func:`memcached_pool`
  36
  37 .. c:function:: memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc)
  38 .. deprecated:: 0.53
  39    Use :c:func:`memcached_pool_fetch`
  40
  41 .. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)
  42 .. deprecated:: 0.53
  43    Use :c:func:`memcached_pool_release`
  44
  45
  46 -----------
  47 DESCRIPTION
  48 -----------
  49
  50
  51 :c:func:`memcached_pool` is used to create a connection pool of objects you
  52 may use to remove the overhead of using memcached_clone for short lived
  53 :c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration`
  54 for details on the format of the configuration string.
  55
  56 :c:func:`memcached_pool_destroy` is used to destroy the connection pool
  57 created with :c:func:`memcached_pool_create` and release all allocated
  58 resources. It will return the pointer to the :c:type:`memcached_st` structure
  59 passed as an argument to :c:func:`memcached_pool_create`, and returns the
  60 ownership of the pointer to the caller when created with
  61 :c:func:`memcached_pool_create`, otherwise NULL is returned..
  62
  63 :c:func:`memcached_pool_fetch` is used to fetch a connection structure from the
  64 connection pool. The relative_time argument specifies if the function should
  65 block and wait for a connection structure to be available if we try
  66 to exceed the maximum size. You need to specify time in relative time.
  67
  68 :c:func:`memcached_pool_release` is used to return a connection structure back
  69 to the pool.
  70
  71 :c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_set`
  72 is used to get/set behavior flags on all connections in the pool.
  73
  74 Both :c:func:`memcached_pool_release` and :c:func:`memcached_pool_fetch` are
  75 thread safe.
  76
  77 ------
  78 RETURN
  79 ------
  80
  81 :c:func:`memcached_pool_destroy` returns the pointer (and ownership) to the
  82 :c:type:`memcached_st` structure used to create the pool. If connections are in
  83 use it returns NULL.
  84
  85 :c:func:`memcached_pool_pop` returns a pointer to a :c:type:`memcached_st`
  86 structure from the pool (or NULL if an allocation cannot be satisfied).
  87
  88 :c:func:`memcached_pool_release` returns :c:type:`MEMCACHED_SUCCESS` upon success.
  89
  90 :c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get`
  91 returns :c:type:`MEMCACHED_SUCCESS` upon success.
  92
  93 If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not
  94 be obtained. If any of the parameters passed to any of these functions is
  95 invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
  96
  97 memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while
  98 waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was
  99 available.
 100
 101
 102
 103 --------
 104 SEE ALSO
 105 --------
 106
 107 .. only:: man
 108
 109     :manpage:`memcached(1)`
 110     :manpage:`libmemcached(3)`
 111     :manpage:`libmemcached_configuration(3)`
 112     :manpage:`memcached_strerror(3)`
 113
 114 .. only:: html
 115
 116     * :manpage:`memcached(1)`
 117     * :doc:`libmemcached`
 118     * :doc:`libmemcached_configuration`
 119     * :doc:`memcached_strerror`