X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_create.rst;h=12bf92c5e5afdb8485ec75b2e9d4e428f50d6dbe;hb=da3714e6dc31ab2f9d115707ab79a838420c7b5a;hp=36a36bd7bb7c3a5a0c5a76aed3f4f226fa87a0ff;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=m6w6%2Flibmemcached diff --git a/docs/memcached_create.rst b/docs/memcached_create.rst index 36a36bd7..12bf92c5 100644 --- a/docs/memcached_create.rst +++ b/docs/memcached_create.rst @@ -2,48 +2,36 @@ Creating and destroying a memcached_st ====================================== - -Create a memcached_st structure - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcached, -lmemcached) - +.. index:: object: memcached_st -------- SYNOPSIS -------- - - -.. code-block:: perl - - #include +#include - memcached_st *memcached_create (memcached_st *ptr); +.. c:function:: memcached_st *memcached_create (memcached_st *ptr); - void memcached_free (memcached_st *ptr); +.. c:function:: void memcached_free (memcached_st *ptr); - memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); +.. c:function:: memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); - void memcached_servers_reset(memcached_st); +.. c:function:: void memcached_servers_reset(memcached_st); +Compile and link with -lmemcached ----------- DESCRIPTION ----------- - memcached_create() is used to create a \ ``memcached_st``\ structure that will then be used by other libmemcached(3) functions to communicate with the server. You should either pass a statically declared \ ``memcached_st``\ to memcached_create() or a NULL. If a NULL passed in then a structure is allocated for you. +Please note, when you write new application use memcached_create_with_options() over memcached_create(). + memcached_clone() is similar to memcached_create(3) but it copies the defaults and list of servers from the source \ ``memcached_st``\ . If you pass a null as the argument for the source to clone, it is the same as a call to memcached_create(). @@ -62,9 +50,9 @@ stack based allocation. The most common issues related to ABI safety involve heap allocated structures. -****** +------ RETURN -****** +------ memcached_create() returns a pointer to the memcached_st that was created @@ -74,21 +62,13 @@ memcached_clone() returns a pointer to the memcached_st that was created (or initialized). On an allocation failure, it returns NULL. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ - - -****** -AUTHOR -****** - - -Brian Aker, +`http://libmemcached.org/ `_ --------