X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libmemcached%2Fmemcached_dump.html;h=06e40e4c1353ef74dd77082b89e08c68bface509;hb=7a6ebf3a611e2e43aa496885f301c6826a49d25c;hp=abfada0691ec9be4b7b82c11f87cb6312ca667a9;hpb=d517b40976d8e986cada6b8b896e8f12cd179fa6;p=m6w6%2Flibmemcached diff --git a/libmemcached/memcached_dump.html b/libmemcached/memcached_dump.html index abfada06..06e40e4c 100644 --- a/libmemcached/memcached_dump.html +++ b/libmemcached/memcached_dump.html @@ -21,10 +21,10 @@ - - - - + + + + @@ -85,8 +85,7 @@ -

libmemcached

- -

libmemcachedutil

- -

libhashkit

- -

Client Applications

- -

Copyright

@@ -185,6 +172,10 @@
  • + + Edit on GitHub + +
    • @@ -198,39 +189,78 @@

    Dumping data from a server¶

    -

    Get a list of keys found on memcached servers

    -

    SYNOPSIS¶

    -

    #include <libmemcached/memcached.h>

    -
    -
    -memcached_return_t memcached_dump(memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)¶
    -
    - -
    +

    SYNOPSIS¶

    +
    +
    #include <libmemcached/memcached.h>
    +
    Compile and link with -lmemcached
    +
    +
    -typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context)¶
    -
    +typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context)¶
    +
    +++ + + + + + +
    Parameters:
      +
    • ptr -- pointer to memcached_st object
      • +
    • key -- key string being dumped
      • +
    • key_length -- length of the key without any terminating zero
      • +
    • context -- pointer to the user supplied context
      • +
    +
    Returns:

    memcached_return_t indicating success

    +
    +
    + +
    +
    +memcached_return_t memcached_dump(memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)¶
    +
    +++ + + + + + +
    Parameters: +
    Returns:

    memcached_return_t indicating success

    +
    +
    -

    Compile and link with -lmemcached

    DESCRIPTION¶

    -

    memcached_dump() is used to get a list of keys found in memcached(1) -servers. Because memcached(1) does not guarantee to dump all keys you can not +

    memcached_dump() is used to get a list of keys found in memcached(1) +servers. Because memcached does not guarantee to dump all keys you can not assume you have fetched all keys from the server. The function takes an array of callbacks that it will use to execute on keys as they are found.

    Currently the binary protocol is not tested.

    RETURN VALUE¶

    -

    A value of type memcached_return_t is returned +

    A value of type memcached_return_t is returned. On success that value will be MEMCACHED_SUCCESS. Use memcached_strerror() to translate this value to a printable string.

    SEE ALSO¶

    +