Creating and destroying a memcached_st
======================================
-.. index:: object: memcached_st
-
--------
SYNOPSIS
--------
#include <libmemcached/memcached.h>
+
+.. c:type:: memcached_st
+
+.. c:function:: memcached_st* memcached_create(memcached_st *ptr)
-.. c:function:: memcached_st *memcached_create (memcached_st *ptr);
-
-.. c:function:: void memcached_free (memcached_st *ptr);
+.. c:function:: void memcached_free(memcached_st *ptr)
-.. c:function:: memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.. c:function:: memcached_st* memcached_clone(memcached_st *destination, memcached_st *source)
-.. c:function:: void memcached_servers_reset(memcached_st);
+.. c:function:: void memcached_servers_reset(memcached_st)
Compile and link with -lmemcached
DESCRIPTION
-----------
-:c:func:`memcached_create()` is used to create a :c:type:`memcached_st`
+:c:func:`memcached_create` is used to create a :c:type:`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
-:c:type:`memcached_st` to :c:func:`memcached_create()` or
+:c:type:`memcached_st` to :c:func:`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
-:c:func:`memcached_create_with_options()` over
-:c:func:`memcached_create()`.
+:c:func:`memcached` over
+:c:func:`memcached_create`.
-:c:func:`memcached_clone()` is similar to :c:func:`memcached_create()` but
+:c:func:`memcached_clone` is similar to :c:func:`memcached_create` but
it copies the defaults and list of servers from the source
:c:type:`memcached_st`. If you pass a null as the argument for the source
-to clone, it is the same as a call to :c:func:`memcached_create()`.
+to clone, it is the same as a call to :c:func:`memcached_create`.
If the destination argument is NULL a :c:type:`memcached_st` will be allocated
for you.
-:c:func:`memcached_servers_reset()` allows you to zero out the list of
+:c:func:`memcached_servers_reset` allows you to zero out the list of
servers that the :c:type:`memcached_st` has.
To clean up memory associated with a :c:type:`memcached_st` structure you
-should pass it to :c:func:`memcached_free()` when you are finished using it.
-:c:func:`memcached_free()` is the only way to make sure all memory is
+should pass it to :c:func:`memcached_free` when you are finished using it.
+:c:func:`memcached_free` is the only way to make sure all memory is
deallocated when you finish using the structure.
You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
------
-:c:func:`memcached_create()` returns a pointer to the :c:type:`memcached_st`
+:c:func:`memcached_create` returns a pointer to the :c:type:`memcached_st`
that was created (or initialized). On an allocation failure, it returns NULL.
-:c:func:`memcached_clone()` returns a pointer to the :c:type:`memcached_st`
+:c:func:`memcached_clone` returns a pointer to the :c:type:`memcached_st`
that was created (or initialized). On an allocation failure, it returns NULL.