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

   1 ============================
   2 Working with memcached pools
   3 ============================
   4
   5 .. index:: object: memcached_pool_st
   6
   7 --------
   8 SYNOPSIS
   9 --------
  10
  11 #include <libmemcached/memcached_pool.h>
  12
  13 .. c:function:: memcached_pool_st *memcached_pool(const char *option_string, size_t option_string_length);
  14
  15 .. c:function:: memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); DEPRECATED
  16
  17 .. c:function:: memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
  18
  19 .. c:function:: memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
  20
  21 .. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
  22
  23 .. c:function:: memcached_st *memcached_create (memcached_st *ptr);
  24
  25 .. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
  26
  27 .. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
  28
  29 Compile and link with -lmemcachedutil -lmemcached
  30
  31
  32 -----------
  33 DESCRIPTION
  34 -----------
  35
  36
  37 memcached_pool() is used to create a connection pool of objects you may use
  38 to remove the overhead of using memcached_clone for short lived
  39 \ ``memcached_st``\ objects. Please see :manpage:`libmemcached_configuration` for details on the format of the configuration string.
  40
  41 DEPRECATED memcached_pool_create() is used to create a connection pool of
  42 objects you may use to remove the overhead of using memcached_clone for
  43 short lived \ ``memcached_st``\ objects. The mmc argument should be an
  44 initialised \ ``memcached_st``\ structure, and a successfull invocation of
  45 memcached_pool_create takes full ownership of the variable (until it is
  46 released by memcached_pool_destroy).  The \ ``initial``\  argument specifies
  47 the initial size of the connection pool, and the \ ``max``\ argument
  48 specifies the maximum size the connection pool should grow to. Please note
  49 that the library will allocate a fixed size buffer scaled to the max size of
  50 the connection pool, so you should not pass MAXINT or some other large
  51 number here.
  52
  53 memcached_pool_destroy() is used to destroy the connection pool
  54 created with memcached_pool_create() and release all allocated
  55 resources. It will return the pointer to the \ ``memcached_st``\  structure
  56 passed as an argument to memcached_pool_create(), and returns the ownership
  57 of the pointer to the caller when created with memcached_pool_create,
  58 otherwise NULL is returned..
  59
  60 memcached_pool_pop() is used to grab a connection structure from the
  61 connection pool. The block argument specifies if the function should
  62 block and wait for a connection structure to be available if we try
  63 to exceed the maximum size.
  64
  65 memcached_pool_push() is used to return a connection structure back to the pool.
  66
  67 memcached_pool_behavior_set() and memcached_pool_behagior_get() is
  68 used to get/set behavior flags on all connections in the pool.
  69
  70
  71 ------
  72 RETURN
  73 ------
  74
  75
  76 memcached_pool_create() returns a pointer to the newly created
  77 memcached_pool_st structure. On an allocation failure, it returns
  78 NULL.
  79
  80 memcached_pool_destroy() returns the pointer (and ownership) to the
  81 memcached_st structure used to create the pool. If connections are in
  82 use it returns NULL.
  83
  84 memcached_pool_pop() returns a pointer to a memcached_st structure
  85 from the pool (or NULL if an allocation cannot be satisfied).
  86
  87 memcached_pool_push() returns MEMCACHED_SUCCESS upon success.
  88
  89 memcached_pool_behavior_get() and memcached_pool_behavior_get()
  90 returns MEMCACHED_SUCCESS upon success.
  91
  92
  93 ----
  94 HOME
  95 ----
  96
  97
  98 To find out more information please check:
  99 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 100
 101
 102 ------
 103 AUTHOR
 104 ------
 105
 106
 107 Brian Aker, <brian@tangent.org>
 108
 109 Trond Norbye, <trond.norbye@gmail.com>
 110
 111
 112 --------
 113 SEE ALSO
 114 --------
 115
 116 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`