libmemcached
-libmemcachedutil
- -libhashkit
- -Client Applications
- -Copyright
@@ -159,7 +147,7 @@Compile and link with -lmemcached
-memcached(const char *string, size_t string_length)¶memcached(const char *string, size_t string_length)¶| Parameters: |
|
+
|---|---|
| Returns: | allocated and initialized |
+
libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)¶libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)¶| Parameters: |
|
+
|---|---|
| Returns: |
|
+
--SERVER=<servername>:<optional_port>/?<optional_weight>--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.
@@ -214,7 +238,7 @@ server getting a default weight of 1.--SOCKET=\"<filepath>/?<optional_weight>\"--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.
@@ -222,32 +246,32 @@ of 1.--VERIFY-KEY--VERIFY-KEY
Verify that keys that are being used fit within the design of the protocol being used.
--REMOVE_FAILED_SERVERSEnable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.
--REMOVE_FAILED_SERVERS
+Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.
--BINARY-PROTOCOL--BINARY-PROTOCOL
Force all connections to use the binary protocol.
--BUFFER-REQUESTSPlease see MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
--BUFFER-REQUESTS
+Please see MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
--CONFIGURE-FILE=--CONFIGURE-FILE=
Provide a configuration file to be used to load requests. Beware that by
using a configuration file libmemcached will reset memcached_st based
on information only contained in the file.
--CONNECT-TIMEOUT=See memcached_behavior_set() for MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
--CONNECT-TIMEOUT=
+See memcached_behavior_set() for MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
--DISTRIBUTION=--DISTRIBUTION=
Set the distribution model used by the client.
See memcached_behavior_set() for more details.
--HASH=--HASH=
Set the hashing algorithm used for placing keys on servers.
--HASH-WITH-NAMESPACE--HASH-WITH-NAMESPACE
When enabled the prefix key will be added to the key when determining which server to store the data in.
--NOREPLY--NOREPLY
Enable "no reply" for all calls that support this. It is highly recommended that you use this option with the binary protocol only.
--NUMBER-OF-REPLICAS=--NUMBER-OF-REPLICAS=
Set the number of servers that keys will be replicated to.
--RANDOMIZE-REPLICA-READ--RANDOMIZE-REPLICA-READ
Select randomly the server within the replication pool to read from.
--SORT-HOSTS--SORT-HOSTS
When adding new servers always calculate their distribution based on sorted naming order.
--SUPPORT-CASSee memcached_behavior_set() for MEMCACHED_BEHAVIOR_SUPPORT_CAS
--SUPPORT-CAS
+See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SUPPORT_CAS
--USE-UDPSee memcached_behavior_set() for MEMCACHED_BEHAVIOR_USE_UDP
--USE-UDP
+--NAMESPACE=--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.
@@ -330,13 +354,13 @@ accomplished by prepending the namespace value to all keys.--POOL-MIN--POOL-MIN
Initial size of pool.
--POOL-MAX--POOL-MAX
Maximize size of the pool.
--TCP-NODELAYSee memcached_behavior_set() for MEMCACHED_BEHAVIOR_TCP_NODELAY
--TCP-NODELAY
+See memcached_behavior_set() for MEMCACHED_BEHAVIOR_TCP_NODELAY
--TCP-KEEPALIVE--TCP-KEEPALIVE
See memcached_behavior_set() for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
--RETRY-TIMEOUT=See memcached_behavior_set() for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
--RETRY-TIMEOUT=
+See memcached_behavior_set() for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
--SERVER-FAILURE-LIMIT=See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
--SERVER-FAILURE-LIMIT=
+See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
--SND-TIMEOUT=See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SND_TIMEOUT
--SND-TIMEOUT=
+See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SND_TIMEOUT
--SOCKET-RECV-SIZE=See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
--SOCKET-RECV-SIZE=
+See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
--SOCKET-SEND-SIZE=See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
--SOCKET-SEND-SIZE=
+See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
--POLL-TIMEOUT=--POLL-TIMEOUT=
Set the timeout used by poll(3).
--IO-BYTES-WATERMARK=--IO-BYTES-WATERMARK=
--IO-KEY-PREFETCH=--IO-KEY-PREFETCH=
--IO-MSG-WATERMARK=--IO-MSG-WATERMARK=
--TCP-KEEPIDLE--TCP-KEEPIDLE
--RCV-TIMEOUT=--RCV-TIMEOUT=
INCLUDEINCLUDE
Include a file in configuration.
Unlike --CONFIGURE-FILE= this will not reset memcached_st.
RESETRESET
Reset memcached_st and continue to process.
ENDEND
End configuration processing.
ERRORERROR
End configuration processing and throw an error.
--CONFIGURE-
RETURN VALUE¶
-memcached() returns a pointer to the memcached_st that was created (or
+
memcached() returns a pointer to the memcached_st that was created (or
initialized). On an allocation failure, it returns NULL.
@@ -476,9 +500,9 @@ initialized). On an allocation failure, it returns NULL.
@@ -494,7 +518,7 @@ initialized). On an allocation failure, it returns NULL.
Next
- Previous
+ Previous