X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_create.rst;h=c63bd7614fa616d69c89055fd13dd00341efd7a4;hb=2484b956a8b10c71ead82c7ad80c19de6266e807;hp=ace146cbf8fa918480cef3272238f5a1ddd84e2a;hpb=bf12e933c3c73aa04d8de2221144cc73cc9ef3b8;p=awesomized%2Flibmemcached diff --git a/docs/memcached_create.rst b/docs/memcached_create.rst index ace146cb..c63bd761 100644 --- a/docs/memcached_create.rst +++ b/docs/memcached_create.rst @@ -1,44 +1,38 @@ -.. highlight:: perl - - -memcached_create, memcached_free, memcached_clone, memcached_servers_reset -************************************************************************** +====================================== +Creating and destroying a memcached_st +====================================== Create a memcached_st structure -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) -******** +-------- 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); -*********** +----------- DESCRIPTION -*********** +----------- memcached_create() is used to create a \ ``memcached_st``\ structure that will then @@ -64,9 +58,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 @@ -76,26 +70,26 @@ 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, -******** +-------- SEE ALSO -******** +-------- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`