projects / awesomized / libmemcached / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree | github
raw | inline | side by side
Merge in additional for last disconnected server.
[awesomized/libmemcached] / docs / libmemcached_configuration.rst
diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst
index a6b4b606874d82a058878ae84ffc11099f706efe..74902aab7663d987a00aa95d6fdf4e05b3c1028b 100644 (file)
--- a/docs/libmemcached_configuration.rst
+++ b/docs/libmemcached_configuration.rst
@@ -2,13 +2,15 @@
 Configuring Libmemcached
 ========================
 
 Configuring Libmemcached
 ========================
 
+.. index:: object: memcached_st
+
 -------- 
 SYNOPSIS 
 --------
 
 -------- 
 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)
 
 
 .. c:function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)
 
@@ -24,7 +26,6 @@ Libmemcached implements a custom language for configuring and modifying
 servers. By passing in an option string you can generate a memcached_st object
 that you can use in your application directly.
 
 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:: --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.
@@ -33,9 +34,9 @@ Provide a servername to be used by the client. Providing a weight will cause wei
 
 Verify that keys that are being used fit within the design of the protocol being used.
 
 
 Verify that keys that are being used fit within the design of the protocol being used.
 
-.. describe:: --AUTO-EJECT_HOSTS
+.. describe:: --REMOVE_FAILED_SERVERS
 
 
-Enable the behavior MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS.
+Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.
 
 .. describe:: --BINARY-PROTOCOL
 
 
 .. describe:: --BINARY-PROTOCOL
 
@@ -61,27 +62,66 @@ Set the distribution model used by the client.  See :manpage:`` for more details
 
 Set the hashing alogrthm used for placing keys on servers.
 
 
 Set the hashing alogrthm used for placing keys on servers.
 
-.. describe:: --HASH-WITH-PREFIX_KEY
+.. describe:: --HASH-WITH-NAMESPACE
 
 
-.. describe:: --IO-BYTES-WATERMARK=
-
-.. describe:: --IO-KEY-PREFETCH=
-
-.. describe:: --IO-MSG-WATERMARK=
+When enabled the prefix key will be added to the key when determining which
+server to store the data in.
 
 .. describe:: --NOREPLY
 
 
 .. describe:: --NOREPLY
 
+Enable "no reply" for all calls that support this. It is highly recommended
+that you use this option with the binary protocol only.
+
 .. describe:: --NUMBER-OF-REPLICAS=
 
 Set the nummber of servers that keys will be replicated to.
 
 .. describe:: --NUMBER-OF-REPLICAS=
 
 Set the nummber of servers that keys will be replicated to.
 
-.. describe:: --POLL-TIMEOUT=
-
 .. describe:: --RANDOMIZE-REPLICA-READ
 
 Select randomly the server within the replication pool to read from.
 
 .. describe:: --RANDOMIZE-REPLICA-READ
 
 Select randomly the server within the replication pool to read from.
 
-.. describe:: --RCV-TIMEOUT=
+.. describe:: --SORT-HOSTS
+
+When adding new servers always calculate their distribution based on sorted naming order.
+
+.. describe:: --SUPPORT-CAS
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SUPPORT_CAS
+
+.. describe:: --USE-UDP
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_USE_UDP
+
+.. describe:: --NAMESPACE=
+
+A namespace is a container that provides context for keys, only other
+requests that know the namespace can access these values. This is
+accomplished by prepending the namespace value to all keys.
+
+
+********************** 
+Mecached Pool Options: 
+**********************
+
+.. describe:: --POOL-MIN
+
+Initial size of pool.
+
+.. describe:: --POOL-MAX
+
+Maximize size of the pool.
+
+************
+I/O Options:
+************
+
+.. describe:: --TCP-NODELAY
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY
+
+.. describe:: --TCP-KEEPALIVE
+
+See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
 
 .. describe:: --RETRY-TIMEOUT=
 
 
 .. describe:: --RETRY-TIMEOUT=
 
@@ -103,29 +143,26 @@ See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
 
 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
 
 
 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
 
-.. describe:: --SORT-HOSTS
-
-When adding new servers always calculate their distribution based on sorted naming order.
+.. describe:: --POLL-TIMEOUT=
 
 
-.. describe:: --SUPPORT-CAS
+That sets the value of the timeout used by :manpage: `poll()`.
 
 
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SUPPORT_CAS
+.. describe:: --IO-BYTES-WATERMARK=
 
 
-.. describe:: --TCP-NODELAY
+.. describe:: --IO-KEY-PREFETCH=
 
 
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY
+.. describe:: --IO-MSG-WATERMARK=
 
 
-.. describe:: --TCP-KEEPALIVE
+.. describe:: --TCP-KEEPIDLE
 
 
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
+.. describe:: --RCV-TIMEOUT=
 
 
-.. describe:: --TCP-KEEPIDLE
 
 
-.. describe:: --USE-UDP
 
 
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_USE_UDP
+******
+Other:
+******
 
 
-.. describe:: --PREFIX-KEY=
 
 .. describe:: INCLUDE
 
 
 .. describe:: INCLUDE
 
@@ -149,17 +186,34 @@ RETURN
 ------
 
 
 ------
 
 
-memcached_create_with_options() returns a pointer to the memcached_st that was
+memcached() returns a pointer to the memcached_st that was
 created (or initialized).  On an allocation failure, it returns NULL.
 
 
 created (or initialized).  On an allocation failure, it returns NULL.
 
 
+
+------- 
+EXAMPLE 
+-------
+
+
+.. code-block:: c
+
+   const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
+   memcached_st *memc= memcached(config_string, strlen(config_string);
+   {
+    ...
+   }
+   memcached_free(memc);
+
+
+
 ----
 HOME
 ----
 
 
 To find out more information please check:
 ----
 HOME
 ----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 
 
 
 
Resurrection of libmemcached