Configuring Libmemcached
========================
+.. highlightlang:: c
+
--------
SYNOPSIS
--------
+#include <libmemcached/memcached.h>
-.. c:function:: memcached_st *memcached_create_with_options(const char *string, size_t string_length)
-
+.. c:function:: memcached_st *memcached(const char *string, size_t string_length)
.. c:function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)
Compile and link with -lmemcached
-
-----------
DESCRIPTION
-----------
Libmemcached implements a custom language for configuring and modifying
-servers. By passing in an option string you can generate a memcached_st object
+servers. By passing in an option string you can generate a ``memcached_st`` object
that you can use in your application directly.
.. describe:: --SERVER=<servername>:<optional_port>/?<optional_weight>
Provide a servername to be used by the client. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
+.. describe:: --SOCKET=<filepath>/?<optional_weight>
+
+Provide a filepath to a UNIX socket file. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
+
.. describe:: --VERIFY-KEY
Verify that keys that are being used fit within the design of the protocol being used.
------
-memcached_create_with_options() returns a pointer to the memcached_st that was
+:c:func:`memcached()` returns a pointer to the memcached_st that was
created (or initialized). On an allocation failure, it returns NULL.
.. code-block:: c
const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
- memcached_st *memc= memcached_create_with_options(config_string, strlen(config_string);
+ memcached_st *memc= memcached(config_string, strlen(config_string);
{
...
}
To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_