From: Michael Wallner Date: Thu, 6 Feb 2020 18:42:12 +0000 (+0100) Subject: update docs X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=e39eedb1ea4fdc8af01989629a4cba2b4f8c84b6;p=m6w6%2Flibmemcached update docs --- diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 00000000..d1de30c9 --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 537dd05d0f6918803de0f9cf9b88897e +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_sources/bin/memaslap.rst.txt b/_sources/bin/memaslap.rst.txt new file mode 100644 index 00000000..61060675 --- /dev/null +++ b/_sources/bin/memaslap.rst.txt @@ -0,0 +1,1252 @@ +================================================== +memaslap - Load testing and benchmarking a server +================================================== + + +-------- +SYNOPSIS +-------- + +memaslap [options] + +.. program:: memaslap + +.. option:: --help + +.. envvar:: MEMCACHED_SERVERS + +----------- +DESCRIPTION +----------- + + +:program:`memaslap` is a load generation and benchmark tool for memcached +servers. It generates configurable workload such as threads, concurrencies, +connections, run time, overwrite, miss rate, key size, value size, get/set +proportion, expected throughput, and so on. Furthermore, it also testss data +verification, expire-time verification, UDP, binary protocol, facebook test, +replication test, multi-get and reconnection, etc. + +Memaslap manages network connections like memcached with +libevent. Each thread of memaslap is bound with a CPU core, all +the threads don't communicate with each other, and there are several socket +connections in each thread. Each connection keeps key size distribution, +value size distribution, and command distribution by itself. + +You can specify servers via the :option:`memslap --servers` option or via the +environment variable :envvar:`MEMCACHED_SERVERS`. + + +-------- +FEATURES +-------- + + +Memslap is developed to for the following purposes: + + +Manages network connections with libevent asynchronously. + + + +Set both TCP and UDP up to use non-blocking IO. + + + +Improves parallelism: higher performance in multi-threads environments. + + + +Improves time efficiency: faster processing speed. + + + +Generates key and value more efficiently; key size distribution and value size distribution are configurable. + + + +Supports get, multi-get, and set commands; command distribution is configurable. + + + +Supports controllable miss rate and overwrite rate. + + + +Supports data and expire-time verification. + + + +Supports dumping statistic information periodically. + + + +Supports thousands of TCP connections. + + + +Supports binary protocol. + + + +Supports facebook test (set with TCP and multi-get with UDP) and replication test. + + + + +------- +DETAILS +------- + + +Effective implementation of network. +____________________________________ + + +For memaslap, both TCP and UDP use non-blocking network IO. All +the network events are managed by libevent as memcached. The network module +of memaslap is similar to memcached. Libevent can ensure +memaslap can handle network very efficiently. + + +Effective implementation of multi-threads and concurrency +_________________________________________________________ + + +Memslap has the similar implementation of multi-threads to +memcached. Memslap creates one or more self-governed threads; +each thread is bound with one CPU core if the system testss setting CPU +core affinity. + +In addition, each thread has a libevent to manage the events of the network; +each thread has one or more self-governed concurrencies; and each +concurrency has one or more socket connections. All the concurrencies don’t +communicate with each other even though they are in the same thread. + +Memslap can create thousands of socket connections, and each +concurrency has tens of socket connections. Each concurrency randomly or +sequentially selects one socket connection from its socket connection pool +to run, so memaslap can ensure each concurrency handles one +socket connection at any given time. Users can specify the number of +concurrency and socket connections of each concurrency according to their +expected workload. + + +Effective implementation of generating key and value +____________________________________________________ + + +In order to improve time efficiency and space efficiency, +memaslap creates a random characters table with 10M characters. All the +suffixes of keys and values are generated from this random characters table. + +Memslap uses the offset in the character table and the length +of the string to identify a string. It can save much memory. +Each key contains two parts, a prefix and a suffix. The prefix is an +uint64_t, 8 bytes. In order to verify the data set before, +memaslap need to ensure each key is unique, so it uses the prefix to identify +a key. The prefix cannot include illegal characters, such as ‘\r’, ‘\n’, +‘\0’ and ‘ ‘. And memaslap has an algorithm to ensure that. + +Memslap doesn’t generate all the objects (key-value pairs) at +the beginning. It only generates enough objects to fill the task window +(default 10K objects) of each concurrency. Each object has the following +basic information, key prefix, key suffix offset in the character table, key +length, value offset in the character table, and value length. + +In the work process, each concurrency sequentially or randomly selects an +object from the window to do set operation or get operation. At the same +time, each concurrency kicks objects out of its window and adds new object +into it. + + +Simple but useful task scheduling +_________________________________ + + +Memslap uses libevent to schedule all the concurrencies of +threads, and each concurrency schedules tasks based on the local task +window. Memslap assumes that if each concurrency keeps the same +key distribution, value distribution and commands distribution, from +outside, memaslap keeps all the distribution as a whole. +Each task window includes a lot of objects, each object stores its basic +information, such as key, value, expire time, and so on. At any time, all +the objects in the window keep the same and fixed key and value +distribution. If an object is overwritten, the value of the object will be +updated. Memslap verifies the data or expire-time according to +the object information stored in the task window. + +Libevent selects which concurrency to handle based on a specific network +event. Then the concurrency selects which command (get or set) to operate +based on the command distribution. If it needs to kick out an old object and +add a new object, in order to keep the same key and value distribution, the +new object must have the same key length and value length. + +If memcached server has two cache layers (memory and SSD), running +memaslap with different window sizes can get different cache +miss rates. If memaslap adds enough objects into the windows at +the beginning, and the cache of memcached cannot store all the objects +initialized, then memaslap will get some objects from the second +cache layer. It causes the first cache layer to miss. So the user can +specify the window size to get the expected miss rate of the first cache +layer. + + +Useful implementation of multi-servers , UDP, TCP, multi-get and binary protocol +________________________________________________________________________________ + + +Because each thread is self-governed, memaslap can assign +different threads to handle different memcached servers. This is just one of +the ways in which memaslap tests multiple servers. The only +limitation is that the number of servers cannot be greater than the number +of threads. The other way to test multiple servers is for replication +test. Each concurrency has one socket connection to each memcached server. +For the implementation, memaslap can set some objects to one +memcached server, and get these objects from the other servers. + +By default, Memslap does single get. If the user specifies +multi-get option, memaslap will collect enough get commands and +pack and send the commands together. + +Memslap testss both the ASCII protocol and binary protocol, +but it runs on the ASCII protocol by default. +Memslap by default runs on the TCP protocol, but it also +tests UDP. Because UDP is unreliable, dropped packages and out-of-order +packages may occur. Memslap creates a memory buffer to handle +these problems. Memslap tries to read all the response data of +one command from the server and reorders the response data. If some packages +get lost, the waiting timeout mechanism can ensure half-baked packages will +be discarded and the next command will be sent. + + + +----- +USAGE +----- + + +Below are some usage samples: + + +memaslap -s 127.0.0.1:11211 -S 5s + + + +memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b + + + +memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2 + + + +memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k + + + +memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40 + + + +memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m + + + +memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2 + + + +The user must specify one server at least to run memaslap. The +rest of the parameters have default values, as shown below: + +Thread number = 1 Concurrency = 16 + +Run time = 600 seconds Configuration file = NULL + +Key size = 64 Value size = 1024 + +Get/set = 9:1 Window size = 10k + +Execute number = 0 Single get = true + +Multi-get = false Number of sockets of each concurrency = 1 + +Reconnect = false Data verification = false + +Expire-time verification = false ASCII protocol = true + +Binary protocol = false Dumping statistic information + +periodically = false + +Overwrite proportion = 0% UDP = false + +TCP = true Limit throughput = false + +Facebook test = false Replication test = false + +Key size, value size and command distribution. +______________________________________________ + + +All the distributions are read from the configuration file specified by user +with “—cfg_cmd” option. If the user does not specify a configuration file, +memaslap will run with the default distribution (key size = 64, +value size = 1024, get/set = 9:1). For information on how to edit the +configuration file, refer to the “Configuration File” section. + +The minimum key size is 16 bytes; the maximum key size is 250 bytes. The +precision of proportion is 0.001. The proportion of distribution will be +rounded to 3 decimal places. + +The minimum value size is 1 bytes; the maximum value size is 1M bytes. The +precision of proportion is 0.001. The proportion of distribution will be +rounded to 3 decimal places. +Currently, memaslap only testss set and get commands. And it +testss 100% set and 100% get. For 100% get, it will preset some objects to +the server. + + +Multi-thread and concurrency +____________________________ + + +The high performance of memaslap benefits from the special +schedule of thread and concurrency. It’s important to specify the proper +number of them. The default number of threads is 1; the default number of +concurrency is 16. The user can use “—threads” and “--concurrency” to +specify these variables. + +If the system tests setting CPU affinity and the number of threads +specified by the user is greater than 1, memaslap will try to +bind each thread to a different CPU core. So if you want to get the best +performance memaslap, it is better to specify the number of +thread equal to the number of CPU cores. The number of threads specified by +the user can also be less or greater than the number of CPU cores. Because +of the limitation of implementation, the number of concurrencies could be +the multiple of the number of threads. + +1. For 8 CPU cores system + +For example: + +--threads=2 --concurrency=128 + +--threads=8 --concurrency=128 + +--threads=8 --concurrency=256 + +--threads=12 --concurrency=144 + +2. For 16 CPU cores system + +For example: + +--threads=8 --concurrency=128 + +--threads=16 --concurrency=256 + +--threads=16 --concurrency=512 + +--threads=24 --concurrency=288 + +The memaslap performs very well, when +used to test the performance of memcached servers. +Most of the time, the bottleneck is the network or +the server. If for some reason the user wants to +limit the performance of memaslap, there +are two ways to do this: + +Decrease the number of threads and concurrencies. +Use the option “--tps” that memaslap +provides to limit the throughput. This option allows +the user to get the expected throughput. For +example, assume that the maximum throughput is 50 +kops/s for a specific configuration, you can specify +the throughput equal to or less than the maximum +throughput using “--tps” option. + + +Window size +___________ + + +Most of the time, the user does not need to specify the window size. The +default window size is 10k. For Schooner Memcached, the user can specify +different window sizes to get different cache miss rates based on the test +case. Memslap testss cache miss rate between 0% and 100%. +If you use this utility to test the performance of Schooner Memcached, you +can specify a proper window size to get the expected cache miss rate. The +formula for calculating window size is as follows: + +Assume that the key size is 128 bytes, and the value size is 2048 bytes, and +concurrency=128. + +1. Small cache cache_size=1M, 100% cache miss (all data get from SSD). +win_size=10k + +2. cache_size=4G + +(1). cache miss rate 0% + +win_size=8k + +(2). cache miss rate 5% + +win_size=11k + +3. cache_size=16G + +(1). cache miss rate 0% + +win_size=32k + +(2). cache miss + +rate 5% + +win_size=46k + +The formula for calculating window size for cache miss rate 0%: + +cache_size / concurrency / (key_size + value_size) \* 0.5 + +The formula for calculating window size for cache miss rate 5%: + +cache_size / concurrency / (key_size + value_size) \* 0.7 + + +Verification +____________ + + +Memslap testss both data verification and expire-time +verification. The user can use "--verify=" or "-v" to specify the proportion +of data verification. In theory, it testss 100% data verification. The +user can use "--exp_verify=" or "-e" to specify the proportion of +expire-time verification. In theory, it testss 100% expire-time +verification. Specify the "--verbose" options to get more detailed error +information. + +For example: --exp_verify=0.01 –verify=0.1 , it means that 1% of the objects +set with expire-time, 10% of the objects gotten will be verified. If the +objects are gotten, memaslap will verify the expire-time and +value. + + +multi-servers and multi-config +_______________________________ + + +Memslap testss multi-servers based on self-governed thread. +There is a limitation that the number of servers cannot be greater than the +number of threads. Memslap assigns one thread to handle one +server at least. The user can use the "--servers=" or "-s" option to specify +multi-servers. + +For example: + +--servers=10.1.1.1:11211,10.1.1.2:11212,10.1.1.3:11213 --threads=6 --concurrency=36 + +The above command means that there are 6 threads, with each thread having 6 +concurrencies and that threads 0 and 3 handle server 0 (10.1.1.1); threads 1 +and 4 handle server 1 (10.1.1.2); and thread 2 and 5 handle server 2 +(10.1.1.3). + +All the threads and concurrencies in memaslap are self-governed. + +So is memaslap. The user can start up several +memaslap instances. The user can run memaslap on different client +machines to communicate with the same memcached server at the same. It is +recommended that the user start different memaslap on different +machines using the same configuration. + + +Run with execute number mode or time mode +_________________________________________ + + +The default memaslap runs with time mode. The default run time +is 10 minutes. If it times out, memaslap will exit. Do not +specify both execute number mode and time mode at the same time; just +specify one instead. + +For example: + +--time=30s (It means the test will run 30 seconds.) + +--execute_number=100000 (It means that after running 100000 commands, the test will exit.) + + +Dump statistic information periodically. +________________________________________ + + +The user can use "--stat_freq=" or "-S" to specify the frequency. + +For example: + +--stat_freq=20s + +Memslap will dump the statistics of the commands (get and set) at the frequency of every 20 +seconds. + +For more information on the format of dumping statistic information, refer to “Format of Output” section. + + +Multi-get +_________ + + +The user can use "--division=" or "-d" to specify multi-get keys count. +Memslap by default does single get with TCP. Memslap also testss data +verification and expire-time verification for multi-get. + +Memslap testss multi-get with both TCP and UDP. Because of +the different implementation of the ASCII protocol and binary protocol, +there are some differences between the two. For the ASCII protocol, +memaslap sends one “multi-get” to the server once. For the +binary protocol, memaslap sends several single get commands +together as “multi-get” to the server. + + +UDP and TCP +___________ + + +Memslap testss both UDP and TCP. For TCP, +memaslap does not reconnect the memcached server if socket connections are +lost. If all the socket connections are lost or memcached server crashes, +memaslap will exit. If the user specifies the “--reconnect” +option when socket connections are lost, it will reconnect them. + +User can use “--udp” to enable the UDP feature, but UDP comes with some +limitations: + +UDP cannot set data more than 1400 bytes. + +UDP is not testsed by the binary protocol because the binary protocol of +memcached does not tests that. + +UDP doesn’t tests reconnection. + + +Facebook test +_____________ + + +Set data with TCP and multi-get with UDP. Specify the following options: + +"--facebook --division=50" + +If you want to create thousands of TCP connections, specify the + +"--conn_sock=" option. + +For example: --facebook --division=50 --conn_sock=200 + +The above command means that memaslap will do facebook test, +each concurrency has 200 socket TCP connections and one UDP socket. + +Memslap sets objects with the TCP socket, and multi-gets 50 +objects once with the UDP socket. + +If you specify "--division=50", the key size must be less that 25 bytes +because the UDP packet size is 1400 bytes. + + +Replication test +________________ + + +For replication test, the user must specify at least two memcached servers. +The user can use “—rep_write=” option to enable feature. + +For example: + +--servers=10.1.1.1:11211,10.1.1.2:11212 –rep_write=2 + +The above command means that there are 2 replication memcached servers, +memaslap will set objects to both server 0 and server 1, get +objects which are set to server 0 before from server 1, and also get objects +which are set to server 1 before from server 0. If server 0 crashes, +memaslap will only get objects from server 1. If server 0 comes +back to life again, memaslap will reconnect server 0. If both +server 0 and server 1 crash, memaslap will exit. + + +Supports thousands of TCP connections +_____________________________________ + + +Start memaslap with "--conn_sock=" or "-n" to enable this +feature. Make sure that your system can tests opening thousands of files +and creating thousands of sockets. However, this feature does not tests +reconnection if sockets disconnect. + +For example: + +--threads=8 --concurrency=128 --conn_sock=128 + +The above command means that memaslap starts up 8 threads, each +thread has 16 concurrencies, each concurrency has 128 TCP socket +connections, and the total number of TCP socket connections is 128 \* 128 = +16384. + + +Supports binary protocol +________________________ + + +Start memaslap with "--binary" or "-B" options to enable this +feature. It testss all the above features except UDP, because the latest +memcached 1.3.3 does not implement binary UDP protocol. + +For example: + +--binary + +Since memcached 1.3.3 doesn't implement binary UDP protocol, +memaslap does not tests UDP. In addition, memcached 1.3.3 does not tests +multi-get. If you specify "--division=50" option, it just sends 50 get +commands together as “mulit-get” to the server. + + + +------------------ +Configuration file +------------------ + + +This section describes the format of the configuration file. By default +when no configuration file is specified memaslap reads the default +one located at ~/.memaslap.cnf. + +Below is a sample configuration file: + + +.. code-block:: perl + + --------------------------------------------------------------------------- + #comments should start with '#' + #key + #start_len end_len proportion + # + #key length range from start_len to end_len + #start_len must be equal to or greater than 16 + #end_len must be equal to or less than 250 + #start_len must be equal to or greater than end_len + #memaslap will generate keys according to the key range + #proportion: indicates keys generated from one range accounts for the total + generated keys + # + #example1: key range 16~100 accounts for 80% + # key range 101~200 accounts for 10% + # key range 201~250 accounts for 10% + # total should be 1 (0.8+0.1+0.1 = 1) + # + # 16 100 0.8 + # 101 200 0.1 + # 201 249 0.1 + # + #example2: all keys length are 128 bytes + # + # 128 128 1 + key + 128 128 1 + #value + #start_len end_len proportion + # + #value length range from start_len to end_len + #start_len must be equal to or greater than 1 + #end_len must be equal to or less than 1M + #start_len must be equal to or greater than end_len + #memaslap will generate values according to the value range + #proportion: indicates values generated from one range accounts for the + total generated values + # + #example1: value range 1~1000 accounts for 80% + # value range 1001~10000 accounts for 10% + # value range 10001~100000 accounts for 10% + # total should be 1 (0.8+0.1+0.1 = 1) + # + # 1 1000 0.8 + # 1001 10000 0.1 + # 10001 100000 0.1 + # + #example2: all value length are 128 bytes + # + # 128 128 1 + value + 2048 2048 1 + #cmd + #cmd_type cmd_proportion + # + #currently memaslap only testss get and set command. + # + #cmd_type + #set 0 + #get 1 + # + #example: set command accounts for 50% + # get command accounts for 50% + # total should be 1 (0.5+0.5 = 1) + # + # cmd + # 0 0.5 + # 1 0.5 + cmd + 0 0.1 + 1.0 0.9 + + + +---------------- +Format of output +---------------- + + +At the beginning, memaslap displays some configuration information as follows: + + +servers : 127.0.0.1:11211 + + + +threads count: 1 + + + +concurrency: 16 + + + +run time: 20s + + + +windows size: 10k + + + +set proportion: set_prop=0.10 + + + +get proportion: get_prop=0.90 + + + +Where +_____ + + + +servers : "servers" + + The servers used by memaslap. + + + +threads count + + The number of threads memaslap runs with. + + + +concurrency + + The number of concurrencies memaslap runs with. + + + +run time + + How long to run memaslap. + + + +windows size + + The task window size of each concurrency. + + + +set proportion + + The proportion of set command. + + + +get proportion + + The proportion of get command. + + + +The output of dynamic statistics is something like this: + + +.. code-block:: perl + + --------------------------------------------------------------------------------------------------------------------------------- + Get Statistics + Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us) + Avg(us) Std_dev Geo_dist + Period 5 345826 69165 65.3 0 27 2198 203 + 95.43 177.29 + Global 20 1257935 62896 71.8 0 26 3791 224 + 117.79 192.60 + + + Set Statistics + Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us) + Avg(us) Std_dev Geo_dist + Period 5 38425 7685 7.3 0 42 628 240 + 88.05 220.21 + Global 20 139780 6989 8.0 0 37 3790 253 + 117.93 224.83 + + + Total Statistics + Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us) + Avg(us) Std_dev Geo_dist + Period 5 384252 76850 72.5 0 27 2198 207 + 94.72 181.18 + Global 20 1397720 69886 79.7 0 26 3791 227 + 117.93 195.60 + --------------------------------------------------------------------------------------------------------------------------------- + + + +Where +_____ + + + +Get Statistics + + Statistics information of get command + + + +Set Statistics + + Statistics information of set command + + + +Total Statistics + + Statistics information of both get and set command + + + +Period + + Result within a period + + + +Global + + Accumulated results + + + +Ops + + Total operations + + + +TPS + + Throughput, operations/second + + + +Net + + The rate of network + + + +Get_miss + + How many objects can’t be gotten + + + +Min + + The minimum response time + + + +Max + + The maximum response time + + + +Avg: + + The average response time + + + +Std_dev + + Standard deviation of response time + + + +Geo_dist + + Geometric distribution based on natural exponential function + + + +At the end, memaslap will output something like this: + + +.. code-block:: perl + + --------------------------------------------------------------------------------------------------------------------------------- + Get Statistics (1257956 events) + Min: 26 + Max: 3791 + Avg: 224 + Geo: 192.60 + Std: 116.23 + Log2 Dist: + 4: 0 10 84490 215345 + 8: 484890 459823 12543 824 + 12: 31 + + Set Statistics (139782 events) + Min: 37 + Max: 3790 + Avg: 253 + Geo: 224.84 + Std: 116.83 + Log2 Dist: + 4: 0 0 4200 16988 + 8: 50784 65574 2064 167 + 12: 5 + + Total Statistics (1397738 events) + Min: 26 + Max: 3791 + Avg: 227 + Geo: 195.60 + Std: 116.60 + Log2 Dist: + 4: 0 10 88690 232333 + 8: 535674 525397 14607 991 + 12: 36 + + cmd_get: 1257969 + cmd_set: 139785 + get_misses: 0 + verify_misses: 0 + verify_failed: 0 + expired_get: 0 + unexpired_unget: 0 + written_bytes: 242516030 + read_bytes: 1003702556 + object_bytes: 152086080 + packet_disorder: 0 + packet_drop: 0 + udp_timeout: 0 + + Run time: 20.0s Ops: 1397754 TPS: 69817 Net_rate: 59.4M/s + --------------------------------------------------------------------------------------------------------------------------------- + + + +Where +_____ + + + +Get Statistics + + Get statistics of response time + + + +Set Statistics + + Set statistics of response time + + + +Total Statistics + + Both get and set statistics of response time + + + +Min + + The accumulated and minimum response time + + + +Max + + The accumulated and maximum response time + + + +Avg + + The accumulated and average response time + + + +Std + + Standard deviation of response time + + + +Log2 Dist + + Geometric distribution based on logarithm 2 + + + +cmd_get + + Total get commands done + + + +cmd_set + + Total set commands done + + + +get_misses + + How many objects can’t be gotten from server + + + +verify_misses + + How many objects need to verify but can’t get them + + + +verify_failed + + How many objects with insistent value + + + +expired_get + + How many objects are expired but we get them + + + +unexpired_unget + + How many objects are unexpired but we can’t get them + + + +written_bytes + + Total written bytes + + + +read_bytes + + Total read bytes + + + +object_bytes + + Total object bytes + + + +packet_disorder + + How many UDP packages are disorder + + + +packet_drop + + How many UDP packages are lost + + + +udp_timeout + + How many times UDP time out happen + + + +Run time + + Total run time + + + +Ops + + Total operations + + + +TPS + + Throughput, operations/second + + + +Net_rate + + The average rate of network + + + + + +------- +OPTIONS +------- + + +-s, --servers= + List one or more servers to connect. Servers count must be less than + threads count. e.g.: --servers=localhost:1234,localhost:11211 + +-T, --threads= + Number of threads to startup, better equal to CPU numbers. Default 8. + +-c, --concurrency= + Number of concurrency to simulate with load. Default 128. + +-n, --conn_sock= + Number of TCP socks per concurrency. Default 1. + +-x, --execute_number= + Number of operations(get and set) to execute for the + given test. Default 1000000. + +-t, --time= + How long the test to run, suffix: s-seconds, m-minutes, h-hours, + d-days e.g.: --time=2h. + +-F, --cfg_cmd= + Load the configure file to get command,key and value distribution list. + +-w, --win_size= + Task window size of each concurrency, suffix: K, M e.g.: --win_size=10k. + Default 10k. + +-X, --fixed_size= + Fixed length of value. + +-v, --verify= + The proportion of date verification, e.g.: --verify=0.01 + +-d, --division= + Number of keys to multi-get once. Default 1, means single get. + +-S, --stat_freq= + Frequency of dumping statistic information. suffix: s-seconds, + m-minutes, e.g.: --resp_freq=10s. + +-e, --exp_verify= + The proportion of objects with expire time, e.g.: --exp_verify=0.01. + Default no object with expire time + +-o, --overwrite= + The proportion of objects need overwrite, e.g.: --overwrite=0.01. + Default never overwrite object. + +-R, --reconnect + Reconnect tests, when connection is closed it will be reconnected. + +-U, --udp + UDP tests, default memaslap uses TCP, TCP port and UDP port of + server must be same. + +-a, --facebook + Whether it enables facebook test feature, set with TCP and multi-get with UDP. + +-B, --binary + Whether it enables binary protocol. Default with ASCII protocol. + +-P, --tps= + Expected throughput, suffix: K, e.g.: --tps=10k. + +-p, --rep_write= + The first nth servers can write data, e.g.: --rep_write=2. + +-b, --verbose + Whether it outputs detailed information when verification fails. + +-h, --help + Display this message and then exit. + +-V, --version + Display the version of the application and then exit. + + +-------- +EXAMPLES +-------- + + +memaslap -s 127.0.0.1:11211 -S 5s + +memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b + +memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2 + +memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k + +memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40 + +memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m + +memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2 + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------- +AUTHORS +------- + + +Mingqiang Zhuang (Schooner Technolgy) +Brian Aker, + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/_sources/bin/memcapable.rst.txt b/_sources/bin/memcapable.rst.txt new file mode 100644 index 00000000..0e4f33e3 --- /dev/null +++ b/_sources/bin/memcapable.rst.txt @@ -0,0 +1,78 @@ +======================================================================= +memcapable - Checking a Memcached server capibilities and compatibility +======================================================================= + +-------- +SYNOPSIS +-------- + +memcapable [options] + +.. program:: memcapable + +----------- +DESCRIPTION +----------- + +:program:`memcapable` connects to the specified memcached server and tries to +determine its capabilities by running the various commands and verifying +the response. + + +----------- +LIMITATIONS +----------- + + +The current version of memcapable will only verify the binary protocol. + + +------- +OPTIONS +------- + + +.. option:: -h hostname + +Specify the hostname to connect to. The default is \ *localhost*\ + +.. option:: -p port + +Specify the port number to connect to. The default is \ *11211*\ + +.. option:: -c + +Generate a coredump when it detects an error from the server. + +.. option:: -v + +Print out the comparison when it detects an error from the server. + +.. option:: -t n + +Set the timeout from an IO operation to/from the server to \ *n*\ seconds. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Trond Norbye, + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/_sources/bin/memcat.rst.txt b/_sources/bin/memcat.rst.txt new file mode 100644 index 00000000..b8612a92 --- /dev/null +++ b/_sources/bin/memcat.rst.txt @@ -0,0 +1,73 @@ +================================= +memcat - "cat" data from a server +================================= + + + +-------- +SYNOPSIS +-------- + +memcat [options] key + +Copy a set of keys to stdout + + +.. program:: memcat + + +----------- +DESCRIPTION +----------- + + +:program:`memcat` outputs to stdout the value a single or multiple set of keys +stored in a memcached(1) server. If any key is not found an error is returned. + +It is similar to the standard UNIX cat(1) utility. + + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. cmdoption:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +For a full list of operations run the tool with the option: + +.. cmdoption:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +Mark Atwood + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/_sources/bin/memcp.rst.txt b/_sources/bin/memcp.rst.txt new file mode 100644 index 00000000..a85eed8b --- /dev/null +++ b/_sources/bin/memcp.rst.txt @@ -0,0 +1,75 @@ +============================= +memcp - Copy data to a server +============================= + + +Copies files to a collection of memcached servers + + +-------- +SYNOPSIS +-------- + +memcp [options] [file] [server] + +.. program:: memcp + + +----------- +DESCRIPTION +----------- + + +:program:`memcp` copies one or more files into memcached(1) servers. +It is similar to the standard UNIX cp(1) command. + +The key names will be the names of the files, +without any directory path. + + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +If you do not specify either these, the final value in the command line list is the name of a server(s). + +For a full list of operations run the tool with the option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +Mark Atwood, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/_sources/bin/memdump.rst.txt b/_sources/bin/memdump.rst.txt new file mode 100644 index 00000000..6a8e12da --- /dev/null +++ b/_sources/bin/memdump.rst.txt @@ -0,0 +1,58 @@ +============================= +memdump - Dumping your server +============================= + + +Dump a list of keys from a server. + + +-------- +SYNOPSIS +-------- + +memdump [options] + +.. program:: memdump + +----------- +DESCRIPTION +----------- + + +:program:`memdump` dumps a list of "keys" from all servers that +it is told to fetch from. Because memcached does not guarentee to +provide all keys it is not possible to get a complete "dump". + + +------- +OPTIONS +------- + + +For a full list of operations run the tool with option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/_sources/bin/memerror.rst.txt b/_sources/bin/memerror.rst.txt new file mode 100644 index 00000000..53fc09c4 --- /dev/null +++ b/_sources/bin/memerror.rst.txt @@ -0,0 +1,58 @@ +============================================== +memerror - translate an error code to a string +============================================== + + +Translates a memcached error code into a string + + +-------- +SYNOPSIS +-------- + +memerror [options] [error code] + +.. program:: memerror + +----------- +DESCRIPTION +----------- + + +:program:`memerror` translates an error code from libmemcached(3) into a human +readable string. + + +------- +OPTIONS +------- + + +For a full list of operations run the tool with option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more infoerroration please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/_sources/bin/memexist.rst.txt b/_sources/bin/memexist.rst.txt new file mode 100644 index 00000000..22c3a4d8 --- /dev/null +++ b/_sources/bin/memexist.rst.txt @@ -0,0 +1,64 @@ +=========================================== +memexist - Check for the existance of a key +=========================================== + + +-------- +SYNOPSIS +-------- + +memexist [options] [key] + +.. program:: memexist + + +----------- +DESCRIPTION +----------- + +:program:`memexist` checks for the existance of a key within a cluster. + + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +If you do not specify either these, the final value in the command line list is the name of a server(s). + +For a full list of operations run the tool with the option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/_sources/bin/memflush.rst.txt b/_sources/bin/memflush.rst.txt new file mode 100644 index 00000000..a2b9894d --- /dev/null +++ b/_sources/bin/memflush.rst.txt @@ -0,0 +1,67 @@ +======================================= +memflush - flush all data from a server +======================================= + + +Reset a server or list of servers + + +-------- +SYNOPSIS +-------- + +memflush [options] + +.. program:: memflush + +----------- +DESCRIPTION +----------- + + +:program:`memflush` resets the contents of memcached(1) servers. +This means that all data in the specified servers will be deleted. + + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +For a full list of operations run the tool with option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +Mark Atwood + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/_sources/bin/memparse.rst.txt b/_sources/bin/memparse.rst.txt new file mode 100644 index 00000000..5aca71fb --- /dev/null +++ b/_sources/bin/memparse.rst.txt @@ -0,0 +1,56 @@ +================================= +memparse - Parse an option string +================================= + + +Used to validate an option string + + +-------- +SYNOPSIS +-------- + +memparse [options] "option string" + +.. program:: memparse + + +----------- +DESCRIPTION +----------- + + +:program:`memparse` can be used to validate an option string. + +------- +OPTIONS +------- + +For a full list of operations run the tool with the option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/_sources/bin/memping.rst.txt b/_sources/bin/memping.rst.txt new file mode 100644 index 00000000..5a784299 --- /dev/null +++ b/_sources/bin/memping.rst.txt @@ -0,0 +1,61 @@ +=============================================== +memping - Test to see if a server is available. +=============================================== + + +-------- +SYNOPSIS +-------- + +memping [options] [server] + +.. program:: memping + + +----------- +DESCRIPTION +----------- + + +:program:`memping` can be used to ping a memcached server to see if it is taking connections. + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +If you do not specify either these, the final value in the command line list is the name of a server(s). + +For a full list of operations run the tool with the option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + +Brian Aker, + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/_sources/bin/memrm.rst.txt b/_sources/bin/memrm.rst.txt new file mode 100644 index 00000000..d395b364 --- /dev/null +++ b/_sources/bin/memrm.rst.txt @@ -0,0 +1,71 @@ +================================= +memrm - Remove data from a server +================================= + + +memrm - Remove a key(s) from a collection of memcached servers + + +-------- +SYNOPSIS +-------- + +memrm [options] [key] + +.. program:: memrm + + +----------- +DESCRIPTION +----------- + + +:program:`memrm` removes items, specified by key, from memcached(1) servers. + + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +For a full list of operations run the tool with the + +.. option:: --help + + + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +Mark Atwood, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/_sources/bin/memslap.rst.txt b/_sources/bin/memslap.rst.txt new file mode 100644 index 00000000..fbaa5fe3 --- /dev/null +++ b/_sources/bin/memslap.rst.txt @@ -0,0 +1,63 @@ +================================================= +memslap - Load testing and benchmarking a server +================================================= + + +-------- +SYNOPSIS +-------- + +memslap [options] + +.. program:: memslap + +----------- +DESCRIPTION +----------- + + +:program:`memslap` is a load generation and benchmark tool for memcached(1) +servers. It generates configurable workload such as threads, concurrencies, connections, run time, overwrite, miss rate, key size, value size, get/set proportion, expected throughput, and so on. + + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +For a full list of operations run the tool with: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +'http://libmemcached.org/ '_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/_sources/bin/memstat.rst.txt b/_sources/bin/memstat.rst.txt new file mode 100644 index 00000000..9b60297d --- /dev/null +++ b/_sources/bin/memstat.rst.txt @@ -0,0 +1,62 @@ +========================================= +memstat - Gather statistics from a server +========================================= + + +memstat - Display the operating status of a single or group of memcached servers + + +-------- +SYNOPSIS +-------- + +memstat [options] + +.. program:: memstat + +----------- +DESCRIPTION +----------- + + +:program:`memstat` dumps the state of memcached(1) servers. +It displays all data to stdout. + + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: 'MEMCACHED_SERVERS, --args' + +which can be used to specify the "argument" sent to the stats command (ie slab, size, items, etc..). + +For a full list of operations run the tool with: + +.. option:: --help + +.. option:: --analyze + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/_sources/bin/memtouch.rst.txt b/_sources/bin/memtouch.rst.txt new file mode 100644 index 00000000..3f7cd1c7 --- /dev/null +++ b/_sources/bin/memtouch.rst.txt @@ -0,0 +1,63 @@ +========================= +memtouch - Touches a key. +========================= + + +-------- +SYNOPSIS +-------- + +memtouch [options] key + +.. program:: memtouch + + +----------- +DESCRIPTION +----------- + + +:program:`memtouch` does a "touch" on the specified key. + +------- +OPTIONS +------- + + +You can specify servers via the option: + +.. option:: --servers + +or via the environment variable: + +.. envvar:: `MEMCACHED_SERVERS` + +If you do not specify either these, the final value in the command line list is the name of a server(s). + +For a full list of operations run the tool with the option: + +.. option:: --help + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + +Brian Aker, + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/_sources/client_errors/MEMCACHED_AUTH_CONTINUE.rst.txt b/_sources/client_errors/MEMCACHED_AUTH_CONTINUE.rst.txt new file mode 100644 index 00000000..e410592c --- /dev/null +++ b/_sources/client_errors/MEMCACHED_AUTH_CONTINUE.rst.txt @@ -0,0 +1,7 @@ +======================= +MEMCACHED_AUTH_CONTINUE +======================= + +.. c:type:: MEMCACHED_AUTH_CONTINUE + +Authentication has been paused. diff --git a/_sources/client_errors/MEMCACHED_AUTH_FAILURE.rst.txt b/_sources/client_errors/MEMCACHED_AUTH_FAILURE.rst.txt new file mode 100644 index 00000000..9433eb88 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_AUTH_FAILURE.rst.txt @@ -0,0 +1,7 @@ +====================== +MEMCACHED_AUTH_FAILURE +====================== + +.. c:type:: MEMCACHED_AUTH_FAILURE + +The credentials provided are not valid for this server. diff --git a/_sources/client_errors/MEMCACHED_AUTH_PROBLEM.rst.txt b/_sources/client_errors/MEMCACHED_AUTH_PROBLEM.rst.txt new file mode 100644 index 00000000..ba8f22ca --- /dev/null +++ b/_sources/client_errors/MEMCACHED_AUTH_PROBLEM.rst.txt @@ -0,0 +1,7 @@ +====================== +MEMCACHED_AUTH_PROBLEM +====================== + +.. c:type:: MEMCACHED_AUTH_PROBLEM + +An unknown issue has occured during authentication. diff --git a/_sources/client_errors/MEMCACHED_BAD_KEY_PROVIDED.rst.txt b/_sources/client_errors/MEMCACHED_BAD_KEY_PROVIDED.rst.txt new file mode 100644 index 00000000..da1c0b8d --- /dev/null +++ b/_sources/client_errors/MEMCACHED_BAD_KEY_PROVIDED.rst.txt @@ -0,0 +1,7 @@ +========================== +MEMCACHED_BAD_KEY_PROVIDED +========================== + +.. c:type:: MEMCACHED_BAD_KEY_PROVIDED + +The key provided is not a valid key. diff --git a/_sources/client_errors/MEMCACHED_BUFFERED.rst.txt b/_sources/client_errors/MEMCACHED_BUFFERED.rst.txt new file mode 100644 index 00000000..027d0ced --- /dev/null +++ b/_sources/client_errors/MEMCACHED_BUFFERED.rst.txt @@ -0,0 +1,7 @@ +================== +MEMCACHED_BUFFERED +================== + +.. c:type:: MEMCACHED_BUFFERED + +The request has been buffered. diff --git a/_sources/client_errors/MEMCACHED_CLIENT_ERROR.rst.txt b/_sources/client_errors/MEMCACHED_CLIENT_ERROR.rst.txt new file mode 100644 index 00000000..d8df4683 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_CLIENT_ERROR.rst.txt @@ -0,0 +1,7 @@ +====================== +MEMCACHED_CLIENT_ERROR +====================== + +.. c:type:: MEMCACHED_CLIENT_ERROR + +An unknown client error has occured internally. diff --git a/_sources/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.rst.txt b/_sources/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.rst.txt new file mode 100644 index 00000000..221cced1 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.rst.txt @@ -0,0 +1,8 @@ +================================= +MEMCACHED_CONNECTION_BIND_FAILURE +================================= + +.. c:type:: MEMCACHED_CONNECTION_BIND_FAILURE +.. deprecated:: <0.30 + +We were not able to bind() to the socket. diff --git a/_sources/client_errors/MEMCACHED_CONNECTION_FAILURE.rst.txt b/_sources/client_errors/MEMCACHED_CONNECTION_FAILURE.rst.txt new file mode 100644 index 00000000..1d2ca04e --- /dev/null +++ b/_sources/client_errors/MEMCACHED_CONNECTION_FAILURE.rst.txt @@ -0,0 +1,7 @@ +============================ +MEMCACHED_CONNECTION_FAILURE +============================ + +.. c:type:: MEMCACHED_CONNECTION_FAILURE + +A unknown error has occured while trying to connect to a server. diff --git a/_sources/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst.txt b/_sources/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst.txt new file mode 100644 index 00000000..66fd7187 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst.txt @@ -0,0 +1,8 @@ +========================================== +MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE +========================================== + +.. c:type:: MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE +.. deprecated:: <0.30 + +An error has occurred while trying to connect to a server. It is likely that either the number of file descriptors need to be increased or you are out of memory. diff --git a/_sources/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.rst.txt b/_sources/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.rst.txt new file mode 100644 index 00000000..4b5c16aa --- /dev/null +++ b/_sources/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.rst.txt @@ -0,0 +1,7 @@ +============================= +MEMCACHED_DATA_DOES_NOT_EXIST +============================= + +.. c:type:: MEMCACHED_DATA_DOES_NOT_EXIST + +The data requested with the key given was not found. diff --git a/_sources/client_errors/MEMCACHED_DATA_EXISTS.rst.txt b/_sources/client_errors/MEMCACHED_DATA_EXISTS.rst.txt new file mode 100644 index 00000000..8443cae9 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_DATA_EXISTS.rst.txt @@ -0,0 +1,7 @@ +===================== +MEMCACHED_DATA_EXISTS +===================== + +.. c:type:: MEMCACHED_DATA_EXISTS + +The data requested with the key given was not found. diff --git a/_sources/client_errors/MEMCACHED_DELETED.rst.txt b/_sources/client_errors/MEMCACHED_DELETED.rst.txt new file mode 100644 index 00000000..b2654352 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_DELETED.rst.txt @@ -0,0 +1,7 @@ +================= +MEMCACHED_DELETED +================= + +.. c:type:: MEMCACHED_DELETED + +The object requested by the key has been deleted. diff --git a/_sources/client_errors/MEMCACHED_DEPRECATED.rst.txt b/_sources/client_errors/MEMCACHED_DEPRECATED.rst.txt new file mode 100644 index 00000000..13de9bcd --- /dev/null +++ b/_sources/client_errors/MEMCACHED_DEPRECATED.rst.txt @@ -0,0 +1,7 @@ +==================== +MEMCACHED_DEPRECATED +==================== + +.. c:type:: MEMCACHED_DEPRECATED + +The method that was requested has been deprecated. diff --git a/_sources/client_errors/MEMCACHED_E2BIG.rst.txt b/_sources/client_errors/MEMCACHED_E2BIG.rst.txt new file mode 100644 index 00000000..fdd04958 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_E2BIG.rst.txt @@ -0,0 +1,7 @@ +=============== +MEMCACHED_E2BIG +=============== + +.. c:type:: MEMCACHED_E2BIG + +Item is too large for the server to store. diff --git a/_sources/client_errors/MEMCACHED_END.rst.txt b/_sources/client_errors/MEMCACHED_END.rst.txt new file mode 100644 index 00000000..4372448d --- /dev/null +++ b/_sources/client_errors/MEMCACHED_END.rst.txt @@ -0,0 +1,7 @@ +============= +MEMCACHED_END +============= + +.. c:type:: MEMCACHED_END + +The server has completed returning all of the objects requested. diff --git a/_sources/client_errors/MEMCACHED_ERRNO.rst.txt b/_sources/client_errors/MEMCACHED_ERRNO.rst.txt new file mode 100644 index 00000000..60640343 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_ERRNO.rst.txt @@ -0,0 +1,7 @@ +=============== +MEMCACHED_ERRNO +=============== + +.. c:type:: MEMCACHED_ERRNO + +An error has occurred in the driver which has set errno. diff --git a/_sources/client_errors/MEMCACHED_FAILURE.rst.txt b/_sources/client_errors/MEMCACHED_FAILURE.rst.txt new file mode 100644 index 00000000..9da69fce --- /dev/null +++ b/_sources/client_errors/MEMCACHED_FAILURE.rst.txt @@ -0,0 +1,8 @@ +================= +MEMCACHED_FAILURE +================= + +.. c:type:: MEMCACHED_FAILURE +.. deprecated:: <0.30 + +A unknown failure has occurred in the server. diff --git a/_sources/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.rst.txt b/_sources/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.rst.txt new file mode 100644 index 00000000..b44fb261 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.rst.txt @@ -0,0 +1,7 @@ +========================== +MEMCACHED_FAIL_UNIX_SOCKET +========================== + +.. c:type:: MEMCACHED_FAIL_UNIX_SOCKET + +A connection was not established with the server via a unix domain socket. diff --git a/_sources/client_errors/MEMCACHED_FETCH_NOTFINISHED.rst.txt b/_sources/client_errors/MEMCACHED_FETCH_NOTFINISHED.rst.txt new file mode 100644 index 00000000..cd01172a --- /dev/null +++ b/_sources/client_errors/MEMCACHED_FETCH_NOTFINISHED.rst.txt @@ -0,0 +1,7 @@ +=========================== +MEMCACHED_FETCH_NOTFINISHED +=========================== + +.. c:type:: MEMCACHED_FETCH_NOTFINISHED + +A request has been made, but the server has not finished the fetch of the last request. diff --git a/_sources/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.rst.txt b/_sources/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.rst.txt new file mode 100644 index 00000000..2f64869c --- /dev/null +++ b/_sources/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.rst.txt @@ -0,0 +1,7 @@ +============================= +MEMCACHED_HOST_LOOKUP_FAILURE +============================= + +.. c:type:: MEMCACHED_HOST_LOOKUP_FAILURE + +A DNS failure has occurred. diff --git a/_sources/client_errors/MEMCACHED_INVALID_ARGUMENTS.rst.txt b/_sources/client_errors/MEMCACHED_INVALID_ARGUMENTS.rst.txt new file mode 100644 index 00000000..69032bbd --- /dev/null +++ b/_sources/client_errors/MEMCACHED_INVALID_ARGUMENTS.rst.txt @@ -0,0 +1,7 @@ +=========================== +MEMCACHED_INVALID_ARGUMENTS +=========================== + +.. c:type:: MEMCACHED_INVALID_ARGUMENTS + +The arguments supplied to the given function were not valid. diff --git a/_sources/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.rst.txt b/_sources/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.rst.txt new file mode 100644 index 00000000..d6c77234 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.rst.txt @@ -0,0 +1,7 @@ +=============================== +MEMCACHED_INVALID_HOST_PROTOCOL +=============================== + +.. c:type:: MEMCACHED_INVALID_HOST_PROTOCOL + +The server you are connecting too has an invalid protocol. Most likely you are connecting to an older server that does not speak the binary protocol. diff --git a/_sources/client_errors/MEMCACHED_ITEM.rst.txt b/_sources/client_errors/MEMCACHED_ITEM.rst.txt new file mode 100644 index 00000000..ee4da97c --- /dev/null +++ b/_sources/client_errors/MEMCACHED_ITEM.rst.txt @@ -0,0 +1,7 @@ +============== +MEMCACHED_ITEM +============== + +.. c:type:: MEMCACHED_ITEM + +An item has been fetched (this is an internal error only). diff --git a/_sources/client_errors/MEMCACHED_KEY_TOO_BIG.rst.txt b/_sources/client_errors/MEMCACHED_KEY_TOO_BIG.rst.txt new file mode 100644 index 00000000..c3a58eaa --- /dev/null +++ b/_sources/client_errors/MEMCACHED_KEY_TOO_BIG.rst.txt @@ -0,0 +1,7 @@ +===================== +MEMCACHED_KEY_TOO_BIG +===================== + +.. c:type:: MEMCACHED_KEY_TOO_BIG + +The key that has been provided is too large for the given server. diff --git a/_sources/client_errors/MEMCACHED_MAXIMUM_RETURN.rst.txt b/_sources/client_errors/MEMCACHED_MAXIMUM_RETURN.rst.txt new file mode 100644 index 00000000..aa7af4ff --- /dev/null +++ b/_sources/client_errors/MEMCACHED_MAXIMUM_RETURN.rst.txt @@ -0,0 +1,7 @@ +======================== +MEMCACHED_MAXIMUM_RETURN +======================== + +.. c:type:: MEMCACHED_MAXIMUM_RETURN + +This in an internal only state. diff --git a/_sources/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst.txt b/_sources/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst.txt new file mode 100644 index 00000000..fbebfd4d --- /dev/null +++ b/_sources/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst.txt @@ -0,0 +1,7 @@ +=================================== +MEMCACHED_MEMORY_ALLOCATION_FAILURE +=================================== + +.. c:type:: MEMCACHED_MEMORY_ALLOCATION_FAILURE + +An error has occurred while trying to allocate memory. diff --git a/_sources/client_errors/MEMCACHED_NOTFOUND.rst.txt b/_sources/client_errors/MEMCACHED_NOTFOUND.rst.txt new file mode 100644 index 00000000..55257626 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_NOTFOUND.rst.txt @@ -0,0 +1,7 @@ +================== +MEMCACHED_NOTFOUND +================== + +.. c:type:: MEMCACHED_NOTFOUND + +The object requested was not found. diff --git a/_sources/client_errors/MEMCACHED_NOTSTORED.rst.txt b/_sources/client_errors/MEMCACHED_NOTSTORED.rst.txt new file mode 100644 index 00000000..f10651af --- /dev/null +++ b/_sources/client_errors/MEMCACHED_NOTSTORED.rst.txt @@ -0,0 +1,7 @@ +=================== +MEMCACHED_NOTSTORED +=================== + +.. c:type:: MEMCACHED_NOTSTORED + +The request to store an object failed. diff --git a/_sources/client_errors/MEMCACHED_NOT_SUPPORTED.rst.txt b/_sources/client_errors/MEMCACHED_NOT_SUPPORTED.rst.txt new file mode 100644 index 00000000..5b10b38d --- /dev/null +++ b/_sources/client_errors/MEMCACHED_NOT_SUPPORTED.rst.txt @@ -0,0 +1,7 @@ +======================= +MEMCACHED_NOT_SUPPORTED +======================= + +.. c:type:: MEMCACHED_NOT_SUPPORTED + +The given method is not supported in the server. diff --git a/_sources/client_errors/MEMCACHED_NO_KEY_PROVIDED.rst.txt b/_sources/client_errors/MEMCACHED_NO_KEY_PROVIDED.rst.txt new file mode 100644 index 00000000..39c78de5 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_NO_KEY_PROVIDED.rst.txt @@ -0,0 +1,9 @@ +========================= +MEMCACHED_NO_KEY_PROVIDED +========================= + +.. c:type:: MEMCACHED_NO_KEY_PROVIDED +.. deprecated:: <0.30 + Use :c:type:`MEMCACHED_BAD_KEY_PROVIDED` instead. + +No key was provided. diff --git a/_sources/client_errors/MEMCACHED_NO_SERVERS.rst.txt b/_sources/client_errors/MEMCACHED_NO_SERVERS.rst.txt new file mode 100644 index 00000000..fec92151 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_NO_SERVERS.rst.txt @@ -0,0 +1,7 @@ +==================== +MEMCACHED_NO_SERVERS +==================== + +.. c:type:: MEMCACHED_NO_SERVERS + +No servers have been added to the memcached_st object. diff --git a/_sources/client_errors/MEMCACHED_PARSE_ERROR.rst.txt b/_sources/client_errors/MEMCACHED_PARSE_ERROR.rst.txt new file mode 100644 index 00000000..173073b9 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_PARSE_ERROR.rst.txt @@ -0,0 +1,7 @@ +===================== +MEMCACHED_PARSE_ERROR +===================== + +.. c:type:: MEMCACHED_PARSE_ERROR + +An error has occurred while trying to parse the configuration string. You should use memparse to determine what the error was. diff --git a/_sources/client_errors/MEMCACHED_PARSE_USER_ERROR.rst.txt b/_sources/client_errors/MEMCACHED_PARSE_USER_ERROR.rst.txt new file mode 100644 index 00000000..9e3a6292 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_PARSE_USER_ERROR.rst.txt @@ -0,0 +1,7 @@ +========================== +MEMCACHED_PARSE_USER_ERROR +========================== + +.. c:type:: MEMCACHED_PARSE_USER_ERROR + +An error has occurred in parsing the configuration string. diff --git a/_sources/client_errors/MEMCACHED_PARTIAL_READ.rst.txt b/_sources/client_errors/MEMCACHED_PARTIAL_READ.rst.txt new file mode 100644 index 00000000..78c51e02 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_PARTIAL_READ.rst.txt @@ -0,0 +1,7 @@ +====================== +MEMCACHED_PARTIAL_READ +====================== + +.. c:type:: MEMCACHED_PARTIAL_READ + +The read was only partcially successful. diff --git a/_sources/client_errors/MEMCACHED_PROTOCOL_ERROR.rst.txt b/_sources/client_errors/MEMCACHED_PROTOCOL_ERROR.rst.txt new file mode 100644 index 00000000..0899cb3e --- /dev/null +++ b/_sources/client_errors/MEMCACHED_PROTOCOL_ERROR.rst.txt @@ -0,0 +1,7 @@ +======================== +MEMCACHED_PROTOCOL_ERROR +======================== + +.. c:type:: MEMCACHED_PROTOCOL_ERROR + +An unknown error has occurred in the protocol. diff --git a/_sources/client_errors/MEMCACHED_READ_FAILURE.rst.txt b/_sources/client_errors/MEMCACHED_READ_FAILURE.rst.txt new file mode 100644 index 00000000..d929de16 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_READ_FAILURE.rst.txt @@ -0,0 +1,7 @@ +====================== +MEMCACHED_READ_FAILURE +====================== + +.. c:type:: MEMCACHED_READ_FAILURE + +A read failure has occurred. diff --git a/_sources/client_errors/MEMCACHED_SERVER_ERROR.rst.txt b/_sources/client_errors/MEMCACHED_SERVER_ERROR.rst.txt new file mode 100644 index 00000000..2cc3164b --- /dev/null +++ b/_sources/client_errors/MEMCACHED_SERVER_ERROR.rst.txt @@ -0,0 +1,7 @@ +====================== +MEMCACHED_SERVER_ERROR +====================== + +.. c:type:: MEMCACHED_SERVER_ERROR + +An unknown error has occurred in the server. diff --git a/_sources/client_errors/MEMCACHED_SERVER_MARKED_DEAD.rst.txt b/_sources/client_errors/MEMCACHED_SERVER_MARKED_DEAD.rst.txt new file mode 100644 index 00000000..2c0e9157 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_SERVER_MARKED_DEAD.rst.txt @@ -0,0 +1,7 @@ +============================ +MEMCACHED_SERVER_MARKED_DEAD +============================ + +.. c:type:: MEMCACHED_SERVER_MARKED_DEAD + +The requested server has been marked dead. diff --git a/_sources/client_errors/MEMCACHED_SOME_ERRORS.rst.txt b/_sources/client_errors/MEMCACHED_SOME_ERRORS.rst.txt new file mode 100644 index 00000000..1217da8e --- /dev/null +++ b/_sources/client_errors/MEMCACHED_SOME_ERRORS.rst.txt @@ -0,0 +1,7 @@ +===================== +MEMCACHED_SOME_ERRORS +===================== + +.. c:type:: MEMCACHED_SOME_ERRORS + +A multi request has been made, and some underterminate number of errors have occurred. diff --git a/_sources/client_errors/MEMCACHED_STAT.rst.txt b/_sources/client_errors/MEMCACHED_STAT.rst.txt new file mode 100644 index 00000000..8b1da4e3 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_STAT.rst.txt @@ -0,0 +1,7 @@ +============== +MEMCACHED_STAT +============== + +.. c:type:: MEMCACHED_STAT + +A "stat" command has been returned in the protocol. diff --git a/_sources/client_errors/MEMCACHED_STORED.rst.txt b/_sources/client_errors/MEMCACHED_STORED.rst.txt new file mode 100644 index 00000000..9bcc5bf3 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_STORED.rst.txt @@ -0,0 +1,7 @@ +================ +MEMCACHED_STORED +================ + +.. c:type:: MEMCACHED_STORED + +The requested object has been successfully stored on the server. diff --git a/_sources/client_errors/MEMCACHED_SUCCESS.rst.txt b/_sources/client_errors/MEMCACHED_SUCCESS.rst.txt new file mode 100644 index 00000000..633a7087 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_SUCCESS.rst.txt @@ -0,0 +1,7 @@ +================= +MEMCACHED_SUCCESS +================= + +.. c:type:: MEMCACHED_SUCCESS + +The request was successfully executed. diff --git a/_sources/client_errors/MEMCACHED_TIMEOUT.rst.txt b/_sources/client_errors/MEMCACHED_TIMEOUT.rst.txt new file mode 100644 index 00000000..ea39b3a0 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_TIMEOUT.rst.txt @@ -0,0 +1,7 @@ +================= +MEMCACHED_TIMEOUT +================= + +.. c:type:: MEMCACHED_TIMEOUT + +Operation has timed out. diff --git a/_sources/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.rst.txt b/_sources/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.rst.txt new file mode 100644 index 00000000..06e168d9 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.rst.txt @@ -0,0 +1,7 @@ +============================== +MEMCACHED_UNKNOWN_READ_FAILURE +============================== + +.. c:type:: MEMCACHED_UNKNOWN_READ_FAILURE + +An unknown read failure only occurs when either there is a bug in the server, or in rare cases where an ethernet nic is reporting dubious information. diff --git a/_sources/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.rst.txt b/_sources/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.rst.txt new file mode 100644 index 00000000..03ef4157 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.rst.txt @@ -0,0 +1,7 @@ +========================== +MEMCACHED_UNKNOWN_STAT_KEY +========================== + +.. c:type:: MEMCACHED_UNKNOWN_STAT_KEY + +The server you are communicating with has a stat key which has not be defined in the protocol. diff --git a/_sources/client_errors/MEMCACHED_VALUE.rst.txt b/_sources/client_errors/MEMCACHED_VALUE.rst.txt new file mode 100644 index 00000000..b26fcfb8 --- /dev/null +++ b/_sources/client_errors/MEMCACHED_VALUE.rst.txt @@ -0,0 +1,7 @@ +=============== +MEMCACHED_VALUE +=============== + +.. c:type:: MEMCACHED_VALUE + +A value has been returned from the server (this is an internal condition only). diff --git a/_sources/client_errors/MEMCACHED_WRITE_FAILURE.rst.txt b/_sources/client_errors/MEMCACHED_WRITE_FAILURE.rst.txt new file mode 100644 index 00000000..ca3ba45c --- /dev/null +++ b/_sources/client_errors/MEMCACHED_WRITE_FAILURE.rst.txt @@ -0,0 +1,7 @@ +======================= +MEMCACHED_WRITE_FAILURE +======================= + +.. c:type:: MEMCACHED_WRITE_FAILURE + +An error has occured while trying to write to a server. diff --git a/_sources/copyright.rst.txt b/_sources/copyright.rst.txt new file mode 100644 index 00000000..d3b9e1e9 --- /dev/null +++ b/_sources/copyright.rst.txt @@ -0,0 +1,35 @@ +========= +Copyright +========= + + * | 2011-2013 Brian Aker, DataDifferential + | https://datadifferential.com/ + * | 2020 Michael Wallner, SmugMug Inc + | https://smugmug.com/ + +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/_sources/error_messages.rst.txt b/_sources/error_messages.rst.txt new file mode 100644 index 00000000..34cc3045 --- /dev/null +++ b/_sources/error_messages.rst.txt @@ -0,0 +1,55 @@ +===================== +Client Error messages +===================== + +.. toctree:: + :maxdepth: 1 + + client_errors/MEMCACHED_AUTH_CONTINUE + client_errors/MEMCACHED_AUTH_FAILURE + client_errors/MEMCACHED_AUTH_PROBLEM + client_errors/MEMCACHED_BAD_KEY_PROVIDED + client_errors/MEMCACHED_BUFFERED + client_errors/MEMCACHED_CLIENT_ERROR + client_errors/MEMCACHED_CONNECTION_BIND_FAILURE + client_errors/MEMCACHED_CONNECTION_FAILURE + client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE + client_errors/MEMCACHED_DATA_DOES_NOT_EXIST + client_errors/MEMCACHED_DATA_EXISTS + client_errors/MEMCACHED_DELETED + client_errors/MEMCACHED_DEPRECATED + client_errors/MEMCACHED_E2BIG + client_errors/MEMCACHED_END + client_errors/MEMCACHED_ERRNO + client_errors/MEMCACHED_FAILURE + client_errors/MEMCACHED_FAIL_UNIX_SOCKET + client_errors/MEMCACHED_FETCH_NOTFINISHED + client_errors/MEMCACHED_HOST_LOOKUP_FAILURE + client_errors/MEMCACHED_INVALID_ARGUMENTS + client_errors/MEMCACHED_INVALID_HOST_PROTOCOL + client_errors/MEMCACHED_ITEM + client_errors/MEMCACHED_KEY_TOO_BIG + client_errors/MEMCACHED_MAXIMUM_RETURN + client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE + client_errors/MEMCACHED_NOTFOUND + client_errors/MEMCACHED_NOTSTORED + client_errors/MEMCACHED_NOT_SUPPORTED + client_errors/MEMCACHED_NO_KEY_PROVIDED + client_errors/MEMCACHED_NO_SERVERS + client_errors/MEMCACHED_PARSE_ERROR + client_errors/MEMCACHED_PARSE_USER_ERROR + client_errors/MEMCACHED_PARTIAL_READ + client_errors/MEMCACHED_PROTOCOL_ERROR + client_errors/MEMCACHED_READ_FAILURE + client_errors/MEMCACHED_SERVER_ERROR + client_errors/MEMCACHED_SERVER_MARKED_DEAD + client_errors/MEMCACHED_SOME_ERRORS + client_errors/MEMCACHED_STAT + client_errors/MEMCACHED_STORED + client_errors/MEMCACHED_SUCCESS + client_errors/MEMCACHED_TIMEOUT + client_errors/MEMCACHED_UNKNOWN_READ_FAILURE + client_errors/MEMCACHED_UNKNOWN_STAT_KEY + client_errors/MEMCACHED_VALUE + client_errors/MEMCACHED_WRITE_FAILURE + diff --git a/_sources/hashkit_create.rst.txt b/_sources/hashkit_create.rst.txt new file mode 100644 index 00000000..287382df --- /dev/null +++ b/_sources/hashkit_create.rst.txt @@ -0,0 +1,77 @@ +============================ +Creating a hashkit structure +============================ + +.. highlightlang:: c + +.. index:: object: hashkit_st + +-------- +SYNOPSIS +-------- + +#include + +.. c:type:: hashkit_st + +.. c:function:: hashkit_st *hashkit_create(hashkit_st *hash) + +.. c:function:: hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr) + +.. c:function:: void hashkit_free(hashkit_st *hash) + +.. c:function:: bool hashkit_is_allocated(const hashkit_st *hash) + +Compile and link with -lhashkit + +----------- +DESCRIPTION +----------- + + +The :c:func:`hashkit_create` function initializes a hashkit object for use. If +you pass a NULL argument for hash, then the memory for the object is +allocated. If you specify a pre-allocated piece of memory, that is +initialized for use. + +The :c:func:`hashkit_clone` function initializes a hashkit object much like +:c:func:`hashkit_create`, but instead of using default settings it will use +the settings of the ptr hashkit object. + +The :c:func:`hashkit_free` frees any resources being consumed by the hashkit +objects that were initialized with :c:func:`hashkit_create` or :c:func:`hashkit_clone`. + +The :c:func:`hashkit_is_allocated` reports where the memory was allocated +for a hashkit object. + + +------------ +RETURN VALUE +------------ + + +:c:func:`hashkit_create` and :c:func:`hashkit_clone` will return NULL on +failure or non-NULL on success. + +:c:func:`hashkit_is_allocated` returns true if the memory for the hashkit +object was allocated inside of :c:func:`hashkit_create` or +:c:func:`hashkit_clone`, otherwise it is false and was user-supplied memory. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + + +-------- +SEE ALSO +-------- + + +:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` + diff --git a/_sources/hashkit_functions.rst.txt b/_sources/hashkit_functions.rst.txt new file mode 100644 index 00000000..4db41661 --- /dev/null +++ b/_sources/hashkit_functions.rst.txt @@ -0,0 +1,75 @@ +================ +Available Hashes +================ + +.. index:: object: hashkit_st + +Various hash functions to use for calculating values for keys + + +-------- +SYNOPSIS +-------- + +#include + +.. c:function:: uint32_t hashkit_default(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_crc32(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_hsieh(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length) + +Compile and link with -lhashkit + + +----------- +DESCRIPTION +----------- + + +These functions generate hash values from a key using a variety of +algorithms. These functions can be used standalone, or as arguments +to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3). + +The hashkit_hsieh is only available if the library is built with +the appropriate flag enabled. + + +------------ +RETURN VALUE +------------ + + +A 32-bit hash value. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)` + diff --git a/_sources/hashkit_value.rst.txt b/_sources/hashkit_value.rst.txt new file mode 100644 index 00000000..d27e3528 --- /dev/null +++ b/_sources/hashkit_value.rst.txt @@ -0,0 +1,55 @@ +============= +hashkit_value +============= + + +.. index:: object: hashkit_st + +Generate a value for the given key + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length) + +Compile and link with -lhashkit + +----------- +DESCRIPTION +----------- + + +The :c:func:`hashkit_value` function generates a 32-bit hash value from the +given key and key_length. The hash argument is an initialized hashkit +object, and distribution type and hash function is used from this +object while generating the value. + + +------------ +RETURN VALUE +------------ + + +A 32-bit hash value. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)` + diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 00000000..3a4e1c61 --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,130 @@ +========================================= +Welcome to the libmemcached documentation +========================================= + +------------ +Libmemcached +------------ + +.. toctree:: + :maxdepth: 1 + :caption: Basics + + libmemcached + versioning + memcached_create + libmemcached_examples + libmemcached_configuration + libmemcached/memcached_last_error_message + +.. toctree:: + :maxdepth: 1 + :caption: Working with Data + + memcached_auto + memcached_delete + libmemcached/memcached_exist + memcached_flush_buffers + memcached_flush + memcached_get + memcached_result_st + memcached_set + memcached_append + memcached_cas + +.. toctree:: + :maxdepth: 1 + :caption: Advanced Topics + + libmemcached-1.0/memcached_set_encoding_key + memcached_behavior + memcached_callback + memcached_dump + memcached_generate_hash_value + memcached_memory_allocators + memcached_quit + libmemcached/memcached_return_t + memcached_sasl + memcached_server_st + memcached_servers + memcached_strerror + error_messages + memcached_user_data + memcached_verbosity + memcached_version + libmemcached/defaults + +.. toctree:: + :titlesonly: + :caption: Interface Versions + + libmemcached-1.0/index + libmemcached-1.1/index + +.. toctree:: + :titlesonly: + :caption: Deprecated Functions + + libmemcached/memcached_fetch + +.. toctree:: + :maxdepth: 1 + :caption: Platform Specifics + + tap + types + +.. toctree:: + :maxdepth: 1 + :caption: Deriving Statistics from a Server + + memcached_analyze + memcached_stats + +.. toctree:: + :maxdepth: 1 + :caption: Libmemcachedutil + + libmemcachedutil + memcached_pool + +.. toctree:: + :maxdepth: 1 + :caption: Client Applications + + bin/memcapable + bin/memcat + bin/memcp + bin/memdump + bin/memerror + bin/memflush + bin/memrm + bin/memslap + bin/memaslap + bin/memstat + bin/memexist.rst + bin/memparse.rst + bin/memping.rst + bin/memtouch.rst + +.. toctree:: + :maxdepth: 1 + :caption: Libhashkit + + libhashkit + hashkit_create + hashkit_functions + hashkit_value + +================== +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` + +.. toctree:: + :caption: Copyright + :hidden: + + copyright diff --git a/_sources/libhashkit.rst.txt b/_sources/libhashkit.rst.txt new file mode 100644 index 00000000..8866737a --- /dev/null +++ b/_sources/libhashkit.rst.txt @@ -0,0 +1,36 @@ +====================== +Introducing libhashkit +====================== + + +.. code-block:: c + + cc [ flag ... ] file ... -lhashkit + + #include + + + +----------- +DESCRIPTION +----------- + + +libhashkit is a small and thread-safe client library that provides a collection of useful hashing algorithm. libhashkit is distributed with libmemcached. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + +:manpage:`libhashkit(3)` + diff --git a/_sources/libmemcached-1.0/index.rst.txt b/_sources/libmemcached-1.0/index.rst.txt new file mode 100644 index 00000000..fb8ed307 --- /dev/null +++ b/_sources/libmemcached-1.0/index.rst.txt @@ -0,0 +1,9 @@ +==================== +libmemcached 1.0 API +==================== + + +.. toctree:: + :titlesonly: + + memcached_touch diff --git a/_sources/libmemcached-1.0/memcached_set_encoding_key.rst.txt b/_sources/libmemcached-1.0/memcached_set_encoding_key.rst.txt new file mode 100644 index 00000000..be38b03f --- /dev/null +++ b/_sources/libmemcached-1.0/memcached_set_encoding_key.rst.txt @@ -0,0 +1,58 @@ +================== +Set encryption key +================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + +#include + +.. c:function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length) + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and recieved from the server. + +Currently only AES is is supported. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned On success that value +will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to +translate this value to a printable string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/libmemcached-1.0/memcached_touch.rst.txt b/_sources/libmemcached-1.0/memcached_touch.rst.txt new file mode 100644 index 00000000..76b015cb --- /dev/null +++ b/_sources/libmemcached-1.0/memcached_touch.rst.txt @@ -0,0 +1,61 @@ +=========================================== +memcached_touch, memcached_touch_by_key +=========================================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration) + +.. c:function:: memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration) + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_touch` is used to update the expiration time on an existing key. +:c:func:`memcached_touch_by_key` works the same, but it takes a master key +to find the given value. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror` to translate this value to a printable +string. + +---- +HOME +---- + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + diff --git a/_sources/libmemcached-1.1/index.rst.txt b/_sources/libmemcached-1.1/index.rst.txt new file mode 100644 index 00000000..01c1b31b --- /dev/null +++ b/_sources/libmemcached-1.1/index.rst.txt @@ -0,0 +1,5 @@ +==================== +libmemcached 1.1 API +==================== + +The 1.1 is still being finalized. It will be the 1.0 API minus deprecated functions. diff --git a/_sources/libmemcached.rst.txt b/_sources/libmemcached.rst.txt new file mode 100644 index 00000000..4a1ea01a --- /dev/null +++ b/_sources/libmemcached.rst.txt @@ -0,0 +1,185 @@ +============================================== +Introducing the C Client Library for memcached +============================================== + +-------- +SYNOPSIS +-------- + +#include + +Compile and link with -lmemcached + +======= + +libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods. + +libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided: + +1. Asynchronous and Synchronous Transport Support. +2. Consistent Hashing and Distribution. +3. Tunable Hashing algorithm to match keys. +4. Access to large object support. +5. Local replication. +6. A complete reference guide and documentation to the API. +7. Tools to Manage your Memcached networks. + +----------- +DESCRIPTION +----------- + + +"Memcached is a high-performance, distributed memory object caching +system, generic in nature, but intended for use in speeding up dynamic web +applications by alleviating database load." `http://memcached.org/ `_ + +:program:`libmemcached` is a small, thread-safe client library for the +memcached protocol. The code has all been written to allow +for both web and embedded usage. It handles the work behind routing +individual keys to specific servers specified by the developer (and values are +matched based on server order as supplied by the user). It implements +a modular and consistent method of object distribution. + +There are multiple implemented routing and hashing methods. See the +:c:func:`memcached_behavior_set` manpage for more information. + +All operations are performed against a :c:type:`memcached_st` structure. +These structures can either be dynamically allocated or statically +allocated and then initialized by :c:func:`memcached_create`. Functions have +been written in order to encapsulate the :c:type:`memcached_st`. It is not +recommended that you operate directly against the structure. + +Nearly all functions return a :c:type:`memcached_return_t` value. +This value can be translated to a printable string with +:c:type:`memcached_strerror`. + +Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server. + +Group keys can be optionally used to group sets of objects with servers. + +Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers. + +:c:type:`memcached_st` structures are thread-safe, but each thread must +contain its own structure (that is, if you want to share these among +threads you must provide your own locking). No global variables are +used in this library. + +If you are working with GNU autotools you will want to add the following to +your COPYING to properly include libmemcached in your application. + +PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0) +AC_SUBST(DEPS_CFLAGS) +AC_SUBST(DEPS_LIBS) + +Some features of the library must be enabled through :c:func:`memcached_behavior_set`. + +Hope you enjoy it! + + +--------- +CONSTANTS +--------- + + +A number of constants have been provided for in the library. + + +.. c:macro:: MEMCACHED_DEFAULT_PORT + + The default port used by memcached(3). + + +.. c:macro:: MEMCACHED_MAX_KEY + + Default maximum size of a key (which includes the null pointer). Master keys + have no limit, this only applies to keys used for storage. + + +.. c:macro:: MEMCACHED_MAX_BUFFER + + Default size of read/write buffers (which includes the null pointer). + + +.. c:macro:: MEMCACHED_STRIDE + + This is the "stride" used in the consistent hash used between replicas. + + +.. c:macro:: MEMCACHED_MAX_HOST_LENGTH + + Maximum allowed size of the hostname. + + +.. c:macro:: LIBMEMCACHED_VERSION_STRING + + String value of libmemcached version such as "1.23.4" + + +.. c:macro:: LIBMEMCACHED_VERSION_HEX + + Hex value of the version number. "0x00048000" This can be used for comparing versions based on number. + + +.. c:macro:: MEMCACHED_PREFIX_KEY_MAX_SIZE + + Maximum length allowed for namespacing of a key. + + + +--------------------- +THREADS AND PROCESSES +--------------------- + + +When using threads or forked processes it is important to keep one instance +of :c:type:`memcached_st` per process or thread. Without creating your own +locking structures you can not share a single :c:type:`memcached_st`. However, +you can call :c:func:`memcached_quit` on a :c:type:`memcached_st` and then use the resulting cloned structure. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached_examples(3)` +:manpage:`libmemcached(1)` :manpage:`memcat(1)` :manpage:`memcp(1)` +:manpage:`memflush(1)` :manpage:`memrm(1)` :manpage:`memslap(1)` +:manpage:`memstat(1)` :manpage:`memcached_fetch(3)` +:manpage:`memcached_replace(3)` :manpage:`memcached_server_list_free(3)` +:manpage:`libmemcached_examples(3)` :manpage:`memcached_clone(3)` +:manpage:`memcached_free(3)` :manpage:`memcached_server_add(3)` +:manpage:`memcached_server_push(3)` :manpage:`memcached_add(3)` +:manpage:`memcached_get(3)` :manpage:`memcached_server_count(3)` +:manpage:`memcached_create(3)` :manpage:`memcached_increment(3)` +:manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)` +:manpage:`memcached_decrement(3)` :manpage:`memcached_mget(3)` +:manpage:`memcached_server_list_append(3)` :manpage:`memcached_strerror(3)` +:manpage:`memcached_delete(3)` :manpage:`memcached_quit(3)` +:manpage:`memcached_server_list_count(3)` :manpage:`memcached_verbosity(3)` +:manpage:`memcached_server_add_unix_socket(3)` +:manpage:`memcached_result_create(3)` :manpage:`memcached_result_free(3)` +:manpage:`memcached_result_key_value(3)` +:manpage:`memcached_result_key_length(3)` +:manpage:`memcached_result_value(3)` :manpage:`memcached_result_length(3)` +:manpage:`memcached_result_flags(3)` :manpage:`memcached_result_cas(3)` +:manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)` +:manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)` +:manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)` +:manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)` +:manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)` +:manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)` +:manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)` +:manpage:`memcached_dump(3)` :manpage:`memdump(1)` +:manpage:`memcached_set_memory_allocators(3)` +:manpage:`memcached_get_memory_allocators(3)` +:manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)` diff --git a/_sources/libmemcached/defaults.rst.txt b/_sources/libmemcached/defaults.rst.txt new file mode 100644 index 00000000..356c0471 --- /dev/null +++ b/_sources/libmemcached/defaults.rst.txt @@ -0,0 +1,36 @@ +======== +DEFAULTS +======== + + +.. c:macro:: MEMCACHED_DEFAULT_TIMEOUT + +Value 5000 + +.. c:macro:: MEMCACHED_DEFAULT_CONNECT_TIMEOUT + + Value 4000 + +.. c:macro:: MEMCACHED_CONTINUUM_ADDITION + + Value 10. How many extra slots we should build for in the continuum. + +.. c:macro:: MEMCACHED_SERVER_FAILURE_LIMIT + + Value 5 + +.. c:macro:: MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT + + Value 2 + +.. c:macro:: MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT + + Value 0 + +.. c:macro:: `MEMCACHED_PREFIX_KEY_MAX_SIZE` + + Value 128 + +.. c:macro:: MEMCACHED_VERSION_STRING_LENGTH + + Value 24 diff --git a/_sources/libmemcached/memcached_exist.rst.txt b/_sources/libmemcached/memcached_exist.rst.txt new file mode 100644 index 00000000..806efe6e --- /dev/null +++ b/_sources/libmemcached/memcached_exist.rst.txt @@ -0,0 +1,53 @@ +=========================== +Determine if a keys exists. +=========================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_return_t memcached_exist(memcached_st *ptr, char *key, size_t *key_length) + +.. c:function:: memcached_return_t memcached_exist_by_key(memcached_st *ptr, char *group_key, size_t *group_key_length, char *key, size_t *key_length) + + .. versionadded:: 0.53 + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + +:c:func:`memcached_exist()` can be used to check to see if a key exists. No value is returned if the key exists, or does not exist, on the server. + + +------ +RETURN +------ + +:c:func:`memcached_exist()` sets error to +to :c:type:`MEMCACHED_SUCCESS` upon finding that the key exists. +:c:type:`MEMCACHED_NOTFOUND` will be return if the key is not found. + + +---- +HOME +---- + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + + diff --git a/_sources/libmemcached/memcached_fetch.rst.txt b/_sources/libmemcached/memcached_fetch.rst.txt new file mode 100644 index 00000000..de40c64f --- /dev/null +++ b/_sources/libmemcached/memcached_fetch.rst.txt @@ -0,0 +1,66 @@ +================= +memcached_fetch +================= + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error) + + .. deprecated:: 0.50 + Use :c:func:`memcached_fetch_result` instead. + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + +:c:func:`memcached_fetch` is used to fetch an individual value from the server. :c:func:`memcached_mget` must always be called before using this method. +You must pass in a key and its length to fetch the object. You must supply +three pointer variables which will give you the state of the returned +object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of the +object, and a :c:type:`memcached_return_t` pointer to hold any error. The +object will be returned upon success and NULL will be returned on failure. :c:type:`MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon :c:type:`MEMCACHED_END` is null. + +Values returned by :c:func:`memcached_fetch` must be freed by the caller. + +All of the above functions are not tested when the +:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these +functions with this behavior on will result in :c:type:`MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :c:type:`memcached_return_t`, the error function parameter will be set to :c:type:`MEMCACHED_NOT_SUPPORTED`. + + +------ +RETURN +------ + +:c:func:`memcached_fetch` sets error to +to :c:type:`MEMCACHED_END` upon successful conclusion. +:c:type:`MEMCACHED_NOTFOUND` will be return if no keys at all were found. + +:c:type:`MEMCACHED_KEY_TOO_BIG` is set to error whenever :c:func:`memcached_fetch` was used +and the key was set larger then :c:type:`MEMCACHED_MAX_KEY`, which was the largest +key allowed for the original memcached ascii server. + + +---- +HOME +---- + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_fetch_result(3)` + diff --git a/_sources/libmemcached/memcached_last_error_message.rst.txt b/_sources/libmemcached/memcached_last_error_message.rst.txt new file mode 100644 index 00000000..f91f7ae2 --- /dev/null +++ b/_sources/libmemcached/memcached_last_error_message.rst.txt @@ -0,0 +1,47 @@ +================= +Retrieving errors +================= + + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: const char *memcached_last_error_message(memcached_st *) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + +:c:func:`memcached_last_error_message` is used to return the last error +message that the server responded too. If this error came from a specific +server, its hostname and port will be provided in the error message. + +------ +RETURN +------ + +memcached_last_error_message returns a const char* which does not need to be +de-allocated. If no error has occurred then it will return NULL. + +---- +HOME +---- + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + + diff --git a/_sources/libmemcached/memcached_return_t.rst.txt b/_sources/libmemcached/memcached_return_t.rst.txt new file mode 100644 index 00000000..e9c4fab9 --- /dev/null +++ b/_sources/libmemcached/memcached_return_t.rst.txt @@ -0,0 +1,126 @@ +================================ +Error Codes (memcached_return_t) +================================ + +-------- +SYNOPSIS +-------- + +#include + +.. c:type:: memcached_return_t + +.. c:function:: const char *memcached_strerror(memcached_st *ptr, memcached_return_t rc) + +.. c:function:: bool memcached_success(memcached_return_t) + +.. c:function:: bool memcached_continue(memcached_return_t rc) + +.. c:function:: bool memcached_failed(memcached_return_t) + +.. c:function:: bool memcached_fatal(memcached_return_t) + + +Libmemcached return types: +++++++++++++++++++++++++++ + + +:c:type:`MEMCACHED_SUCCESS` + +:c:type:`MEMCACHED_FAILURE` + +:c:type:`MEMCACHED_HOST_LOOKUP_FAILURE` + +:c:type:`MEMCACHED_CONNECTION_FAILURE` + +:c:type:`MEMCACHED_CONNECTION_BIND_FAILURE` + +:c:type:`MEMCACHED_WRITE_FAILURE` + +:c:type:`MEMCACHED_READ_FAILURE` + +:c:type:`MEMCACHED_UNKNOWN_READ_FAILURE` + +:c:type:`MEMCACHED_PROTOCOL_ERROR` + +:c:type:`MEMCACHED_CLIENT_ERROR` + +:c:type:`MEMCACHED_SERVER_ERROR` + +:c:type:`MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE` + +:c:type:`MEMCACHED_DATA_EXISTS` + +:c:type:`MEMCACHED_DATA_DOES_NOT_EXIST` + +:c:type:`MEMCACHED_NOTSTORED` + +:c:type:`MEMCACHED_STORED` + +:c:type:`MEMCACHED_NOTFOUND` + +:c:type:`MEMCACHED_MEMORY_ALLOCATION_FAILURE` + +:c:type:`MEMCACHED_PARTIAL_READ` + +:c:type:`MEMCACHED_SOME_ERRORS` + +:c:type:`MEMCACHED_NO_SERVERS` + +:c:type:`MEMCACHED_END` + +:c:type:`MEMCACHED_DELETED` + +:c:type:`MEMCACHED_VALUE` + +:c:type:`MEMCACHED_STAT` + +:c:type:`MEMCACHED_ITEM` + +:c:type:`MEMCACHED_ERRNO` + +:c:type:`MEMCACHED_FAIL_UNIX_SOCKET` + +:c:type:`MEMCACHED_NOT_SUPPORTED` + +:c:type:`MEMCACHED_NO_KEY_PROVIDED` + +:c:type:`MEMCACHED_FETCH_NOTFINISHED` + +:c:type:`MEMCACHED_TIMEOUT` + +:c:type:`MEMCACHED_BUFFERED` + +:c:type:`MEMCACHED_BAD_KEY_PROVIDED` + +:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL` + +:c:type:`MEMCACHED_SERVER_MARKED_DEAD` + +:c:type:`MEMCACHED_UNKNOWN_STAT_KEY` + +:c:type:`MEMCACHED_E2BIG` + +:c:type:`MEMCACHED_INVALID_ARGUMENTS` + +:c:type:`MEMCACHED_KEY_TOO_BIG` + +:c:type:`MEMCACHED_AUTH_PROBLEM` + +:c:type:`MEMCACHED_AUTH_FAILURE` + +:c:type:`MEMCACHED_AUTH_CONTINUE` + +:c:type:`MEMCACHED_PARSE_ERROR` + +:c:type:`MEMCACHED_PARSE_USER_ERROR` + +:c:type:`MEMCACHED_DEPRECATED` + +:c:type:`MEMCACHED_UNIX_SOCKET_PATH_TOO_BIG` + +-------- +SEE ALSO +-------- + +:manpage:`memcached` :manpage:`libmemcached` :manpage:`memcached_client_error` or :manpage:`memcached_worker_error` diff --git a/_sources/libmemcached_configuration.rst.txt b/_sources/libmemcached_configuration.rst.txt new file mode 100644 index 00000000..f9825738 --- /dev/null +++ b/_sources/libmemcached_configuration.rst.txt @@ -0,0 +1,230 @@ +======================== +Configuring Libmemcached +======================== + +.. highlightlang:: c + +-------- +SYNOPSIS +-------- + +#include + +.. envvar:: LIBMEMCACHED + +.. 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 +that you can use in your application directly. + +.. describe:: --SERVER=:/? + +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=\"/?\" + +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. + +.. describe:: --REMOVE_FAILED_SERVERS + +Enable the behavior :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`. + +.. describe:: --BINARY-PROTOCOL + +Force all connections to use the binary protocol. + +.. describe:: --BUFFER-REQUESTS + +Please see :c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS`. + +.. describe:: --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. + +.. describe:: --CONNECT-TIMEOUT= + +Please see :c:type:`MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT`. + +.. describe:: --DISTRIBUTION= + +Set the distribution model used by the client. See :manpage:`memcached_behavior_set(3)` for more details. + +.. describe:: --HASH= + +Set the hashing alogrthm used for placing keys on servers. + +.. describe:: --HASH-WITH-NAMESPACE + +When enabled the prefix key will be added to the key when determining which +server to store the data in. + +.. 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:: --RANDOMIZE-REPLICA-READ + +Select randomly the server within the replication pool to read from. + +.. 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 :c:type:`MEMCACHED_BEHAVIOR_SUPPORT_CAS` + +.. describe:: --USE-UDP + +See :manpage:`memcached_behavior_set(3)` for :c:type:`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= + +See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT + +.. describe:: --SERVER-FAILURE-LIMIT= + +See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT + +.. describe:: --SND-TIMEOUT= + +See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SND_TIMEOUT + +.. describe:: --SOCKET-RECV-SIZE= + +See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE + +.. describe:: --SOCKET-SEND-SIZE= + +See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE + +.. describe:: --POLL-TIMEOUT= + +That sets the value of the timeout used by :manpage: `poll()`. + +.. describe:: --IO-BYTES-WATERMARK= + +.. describe:: --IO-KEY-PREFETCH= + +.. describe:: --IO-MSG-WATERMARK= + +.. describe:: --TCP-KEEPIDLE + +.. describe:: --RCV-TIMEOUT= + + + +****** +Other: +****** + + +.. describe:: INCLUDE + +Include a file in configuration. Unlike --CONFIGURE-FILE= this will not reset memcached_st + +.. describe:: RESET + +Reset memcached_st and continue to process. + +.. describe:: END + +End configutation processing. + +.. describe:: ERROR + +End configutation processing and throw an error. + + +------ +RETURN +------ + + +:c:func:`memcached()` returns a pointer to the memcached_st that was +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: +`http://libmemcached.org/ `_ + + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/libmemcached_examples.rst.txt b/_sources/libmemcached_examples.rst.txt new file mode 100644 index 00000000..ccc40c91 --- /dev/null +++ b/_sources/libmemcached_examples.rst.txt @@ -0,0 +1,144 @@ +======== +Examples +======== + +Examples for libmemcached + +----------- +DESCRIPTION +----------- + + +For full examples, test cases are found in tests/\*.c in the main +distribution. These are always up to date, and are used for each test run of +the library. + + +--------------------- +Connecting to servers +--------------------- + + +.. 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); + + +In the above code you create a :c:type:`memcached_st` object with three server +by making use of :c:func:`memcached_create`. + + +-------------------------- +Creating a pool of servers +-------------------------- + + +.. code-block:: c + + const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"; + + memcached_pool_st* pool= memcached_pool(config_string, strlen(config_string)); + + memcached_return_t rc; + + memcached_st *memc= memcached_pool_pop(pool, false, &rc); + + .... do work + + /* + Release the memc_ptr that was pulled from the pool + */ + memcached_pool_push(pool, memc); + + /* + Destroy the pool. + */ + memcached_pool_destroy(pool); + + + +In the above code you create a :c:type:`memcached_pool_st` object with three +server by making use of :c:func:`memcached_pool()`. + +When :c:func:`memcached_pool_destroy()` all memory will be released that is associated +with the pool. + + +---------------------------- +Adding a value to the server +---------------------------- + + + +.. code-block:: c + + char *key= "foo"; + char *value= "value"; + + memcached_return_t rc= memcached_set(memc, key, strlen(key), value, value_length, (time_t)0, (uint32_t)0); + + if (rc != MEMCACHED_SUCCESS) + { + ... // handle failure + } + + +It is best practice to always look at the return value of any operation. + + +------------------------ +Fetching multiple values +------------------------ + + + +.. code-block:: c + + memcached_return_t rc; + char *keys[]= {"fudge", "son", "food"}; + size_t key_length[]= {5, 3, 4}; + unsigned int x; + uint32_t flags; + + char return_key[MEMCACHED_MAX_KEY]; + size_t return_key_length; + char *return_value; + size_t return_value_length; + + rc= memcached_mget(memc, keys, key_length, 3); + + x= 0; + while ((return_value= memcached_fetch(memc, return_key, &return_key_length, + &return_value_length, &flags, &rc))) + { + free(return_value); + x++; + } + + +Notice that you freed values returned from memcached_fetch(). The define +:c:type:`MEMCACHED_MAX_KEY` is provided for usage. + + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` + diff --git a/_sources/libmemcachedutil.rst.txt b/_sources/libmemcachedutil.rst.txt new file mode 100644 index 00000000..29cc7dbf --- /dev/null +++ b/_sources/libmemcachedutil.rst.txt @@ -0,0 +1,56 @@ +============================ +Introducing libmemcachedutil +============================ + + +Utility library for libmemcached + + +-------- +SYNOPSIS +-------- + +.. code-block:: c + + cc [ flag ... ] file ... -lmemcachedutil + + #include + + + +----------- +DESCRIPTION +----------- + + +:program:`libmemcachedutil` is a small and thread-safe client library that +provides extra functionality built on top of :program:`libmemcached`. + + +------- +THREADS +------- + + +Do not try to access an instance of :c:type:`memcached_st` from multiple threads +at the same time. If you want to access memcached from multiple threads +you should either clone the :c:type:`memcached_st`, or use the memcached pool +implementation. see :c:func:`memcached_pool_create`. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`libmemcached(3)` :manpage:`memcached_pool_create(3)` :manpage:`memcached_pool_destroy(3)` :manpage:`memcached_pool_pop(3)` :manpage:`memcached_pool_push(3)` + diff --git a/_sources/memcached_analyze.rst.txt b/_sources/memcached_analyze.rst.txt new file mode 100644 index 00000000..88f3ad9d --- /dev/null +++ b/_sources/memcached_analyze.rst.txt @@ -0,0 +1,69 @@ +================= +Anaylzing servers +================= + + +Analyze server information + + +-------- +SYNOPSIS +-------- + +.. index:: object: memcached_analysis_st + + +#include + +.. c:type:: memcached_analysis_st + +.. c:function:: memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error) + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +:program:`libmemcached` has the ability to query a memcached server (or +collection of servers) for their current state. Queries to find state return a +:c:type:`memcached_analysis_st` structure. You are responsible for freeing this structure. + +:c:func:`memcached_analyze` analyzes useful information based on the +provided servers and sets the result to the :c:type:`memcached_analysis_st` +structure. The return value must be freed by the calling application. + +A command line tool, :program:`memstat` with the option :option:`memstat --analyze`, +is provided so that you do not have to write an application to use this method. + + +------ +RETURN +------ + + +A pointer to the allocated :c:type:`memcached_analysis_st` structure on +success and a NULL pointer on failure. You may inspect the error detail by +checking the :c:type:`memcached_return_t` value. + +Any method returning a :c:type:`memcached_analysis_st` expects you to free the +memory allocated for it. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + diff --git a/_sources/memcached_append.rst.txt b/_sources/memcached_append.rst.txt new file mode 100644 index 00000000..0510a316 --- /dev/null +++ b/_sources/memcached_append.rst.txt @@ -0,0 +1,103 @@ +============================================= +Appending or Prepending to data on the server +============================================= + +.. index:: object: memcached_st + +Appending or Prepending to data on the server + + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_return_t memcached_prepend(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) + +.. c:function:: memcached_return_t memcached_append(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) + +.. c:function:: memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) + +.. c:function:: memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_prepend` and memcached_append are used to +modify information on a server. All methods take a key, and its length to +store the object. Keys are currently limited to 250 characters when using +either a version of memcached which is 1.4 or below, or when using the text +protocol. You must supply both a value and a length. Optionally you +may test an expiration time for the object and a 16 byte value (it is +meant to be used as a bitmap). "flags" is a 4byte space that is stored +alongside of the main value. Many sub libraries make use of this field, +so in most cases users should avoid making use of it. + +:c:func:`memcached_prepend` places a segment of data before the last piece +of data stored. Currently expiration and key are not used in the server. + +:c:func:`memcached_append` places a segment of data at the end of the last +piece of data stored. Currently expiration and key are not used in the server. + +:c:func:`memcached_prepend_by_key` and +:c:func:`memcached_append_by_key` methods both behave in a similar +method as the non key methods. The difference is that they use their +group_key parameter to map objects to particular servers. + +If you are looking for performance, :c:func:`memcached_set` with non-blocking +IO is the fastest way to store data on the server. + +All of the above functions are testsed with the +:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using +these operations with this behavior on, there are limits to the size of the +payload being sent to the server. The reason for these limits is that the +Memcached Server does not allow multi-datagram requests +and the current server implementation sets a datagram size to 1400 bytes. Due +to protocol overhead, the actual limit of the user supplied data is less than +1400 bytes and depends on the protocol in use as, well as the operation being +executed. When running with the binary protocol, +:c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value, +flags and expiry combined may not exceed 1368 bytes. When running with the +ASCII protocol, the exact limit fluctuates depending on which function is +being executed and whether the function is a cas operation or not. For +non-cas ASCII set operations, there are at least 1335 bytes available +to split among the key, key_prefix, and value; for cas ASCII operations +there are at least 1318 bytes available to split among the key, key_prefix +and value. If the total size of the command, including overhead, exceeds +1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned. + + +------ +RETURN +------ + + +All methods return a value of type :c:type:`memcached_return_t`. +On success the value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror` to translate this value to a printable +string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_add(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_replace(3)` + diff --git a/_sources/memcached_auto.rst.txt b/_sources/memcached_auto.rst.txt new file mode 100644 index 00000000..0f78e6e7 --- /dev/null +++ b/_sources/memcached_auto.rst.txt @@ -0,0 +1,98 @@ +==================================== +Incrementing and Decrementing Values +==================================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + +#include + +.. c:function:: memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value) + +.. c:function:: memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value) + +.. c:function:: memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value) + +.. c:function:: memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value) + +.. c:function:: memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value) + +.. c:function:: memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value) + +.. c:function:: memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value) + +.. c:function:: memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +:manpage:`memcached(1)` servers have the ability to increment and decrement keys +(overflow and underflow are not detected). This gives you the ability to use +memcached to generate shared sequences of values. + +memcached_increment takes a key and keylength and increments the value by +the offset passed to it. The value is then returned via the uint32_t +value pointer you pass to it. + +memcached_decrement takes a key and keylength and decrements the value by +the offset passed to it. The value is then returned via the uint32_t +value pointer you pass to it. + +memcached_increment_with_initial takes a key and keylength and increments +the value by the offset passed to it. If the object specified by key does +not exist, one of two things may happen: If the expiration value is +MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other +expiration values, the operation will succeed by seeding the value for that +key with a initial value to expire with the provided expiration time. The +flags will be set to zero.The value is then returned via the uint32_t +value pointer you pass to it. memcached_increment_with_initial is only available +when using the binary protocol. + +memcached_decrement_with_initial takes a key and keylength and decrements +the value by the offset passed to it. If the object specified by key does +not exist, one of two things may happen: If the expiration value is +MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other +expiration values, the operation will succeed by seeding the value for that +key with a initial value to expire with the provided expiration time. The +flags will be set to zero.The value is then returned via the uint32_t +value pointer you pass to it. memcached_decrement_with_initial is only available +when using the binary protocol. + +:c:func:`memcached_increment_by_key`, :c:func:`memcached_decrement_by_key`, +:c:func:`memcached_increment_with_initial_by_key`, and +:c:func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned. +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use memcached_strerror to translate this value to a printable string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_behavior.rst.txt b/_sources/memcached_behavior.rst.txt new file mode 100644 index 00000000..20c81924 --- /dev/null +++ b/_sources/memcached_behavior.rst.txt @@ -0,0 +1,311 @@ +================================ +Modifying how the driver behaves +================================ + + +Manipulate the behavior of a memcached_st structure. + +.. index:: object: memcached_st + + +-------- +SYNOPSIS +-------- + + +#include + +.. c:type:: memcached_behavior_t + +.. c:function:: uint64_t memcached_behavior_get (memcached_st *ptr, memcached_behavior_t flag) + +.. c:function:: memcached_return_t memcached_behavior_set (memcached_st *ptr, memcached_behavior_t flag, uint64_t data) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + +:manpage:`libmemcached(3)` behavior can be modified by using :c:func:`memcached_behavior_set`. Default behavior is the library strives to be quick and +accurate. Some behavior, while being faster, can also result in not entirely +accurate behavior (for instance, :c:func:`memcached_set` will always respond +with :c:type:`MEMCACHED_SUCCESS`). + +:c:func:`memcached_behavior_get` takes a behavior flag and returns whether or not that behavior is currently enabled in the client. + +:c:func:`memcached_behavior_set` changes the value of a particular option +of the client. It takes both a flag (listed below) and a value. For simple +on or off options you just need to pass in a value of 1. Calls to +:c:func:`memcached_behavior_set` will flush and reset all connections. + + +.. c:type:: MEMCACHED_BEHAVIOR_USE_UDP + +Causes :manpage:`libmemcached(3)` to use the UDP transport when communicating +with a memcached server. Not all I/O operations are testsed +when this behavior is enababled. The following operations will return +:c:type:`MEMCACHED_NOT_SUPPORTED` when executed with the +:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` enabled: :c:func:`memcached_version`, +:c:func:`memcached_stat`, :c:func:`memcached_get`, +:c:func:`memcached_get_by_key`, :c:func:`memcached_mget`, +:c:func:`memcached_mget_by_key`, :c:func:`memcached_fetch`, +:c:func:`memcached_fetch_result`, :c:func:`memcached_fetch_execute`. + +All other operations are testsed but are executed in a 'fire-and-forget' +mode, in which once the client has executed the operation, no attempt +will be made to ensure the operation has been received and acted on by the +server. + +:manpage:`libmemcached(3)` does not allow TCP and UDP servers to be shared +within the same libmemached(3) client 'instance'. An attempt to add a TCP +server when this behavior is enabled will result in a :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`, as will attempting to add a UDP server when this behavior has +not been enabled. + + + +.. c:type:: MEMCACHED_BEHAVIOR_NO_BLOCK + +Causes :manpage:`libmemcached(3)` to use asychronous IO. This is the fastest +transport available for storage functions. + + +.. c:type:: MEMCACHED_BEHAVIOR_SND_TIMEOUT + +This sets the microsecond behavior of the socket against the SO_SNDTIMEO flag. In cases where you cannot use non-blocking IO this will allow you to still have timeouts on the sending of data. + + +.. c:type:: MEMCACHED_BEHAVIOR_RCV_TIMEOUT + +This sets the microsecond behavior of the socket against the SO_RCVTIMEO flag. + +In cases where you cannot use non-blocking IO this will allow you to still have timeouts on the reading of data. + + + +.. c:type:: MEMCACHED_BEHAVIOR_TCP_NODELAY + +Turns on the no-delay feature for connecting sockets (may be faster in some +environments). + + + +.. c:type:: MEMCACHED_BEHAVIOR_HASH + +Makes the default hashing algorithm for keys use MD5. The value can be set to either :c:type:`MEMCACHED_HASH_DEFAULT`, :c:type:`MEMCACHED_HASH_MD5`, :c:type:`MEMCACHED_HASH_CRC`, :c:type:`MEMCACHED_HASH_FNV1_64`, :c:type:`MEMCACHED_HASH_FNV1A_64`, :c:type:`MEMCACHED_HASH_FNV1_32`, :c:type:`MEMCACHED_HASH_FNV1A_32`, :c:type:`MEMCACHED_HASH_JENKINS`, :c:type:`MEMCACHED_HASH_HSIEH`, and :c:type:`MEMCACHED_HASH_MURMUR`. + +Each hash has it's advantages and it's weaknesses. If you don't know or don't +care, just go with the default. + +Support for :c:type:`MEMCACHED_HASH_HSIEH` is a compile time option that is disabled by default. To enable tests for this hashing algorithm, configure and build libmemcached with the --enable-hash_hsieh. + + + +.. c:type:: MEMCACHED_BEHAVIOR_DISTRIBUTION + +Using this you can enable different means of distributing values to servers. + +The default method is MEMCACHED_DISTRIBUTION_MODULA. You can enable consistent hashing by setting MEMCACHED_DISTRIBUTION_CONSISTENT. Consistent hashing delivers better distribution and allows servers to be added to the cluster with minimal cache losses. Currently MEMCACHED_DISTRIBUTION_CONSISTENT is an alias for the value MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA. + +.. c:type:: MEMCACHED_BEHAVIOR_CACHE_LOOKUPS +.. deprecated:: 0.46(?) + DNS lookups are now always cached until an error occurs with the server. + + Memcached can cache named lookups so that DNS lookups are made only once. + +.. c:type:: MEMCACHED_BEHAVIOR_SUPPORT_CAS + +Support CAS operations (this is not enabled by default at this point in the server since it imposes a slight performance penalty). + + +.. c:type:: MEMCACHED_BEHAVIOR_KETAMA + +Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and +the hash to :c:type:`MEMCACHED_HASH_MD5`. + + +.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED + + Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA with the weighted tests. and the hash to MEMCACHED_HASH_MD5. + +.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_HASH + +Sets the hashing algorithm for host mapping on continuum. The value can be set +to either :c:type:`MEMCACHED_HASH_DEFAULT`, :c:type:`MEMCACHED_HASH_MD5`, +:c:type:`MEMCACHED_HASH_CRC`, :c:type:`MEMCACHED_HASH_FNV1_64`, +:c:type:`MEMCACHED_HASH_FNV1A_64`, :c:type:`MEMCACHED_HASH_FNV1_32`, and +:c:type:`MEMCACHED_HASH_FNV1A_32`. + +.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_COMPAT + +Sets the compatibility mode. The value can be set to either MEMCACHED_KETAMA_COMPAT_LIBMEMCACHED (this is the default) or MEMCACHED_KETAMA_COMPAT_SPY to be compatible with the SPY Memcached client for Java. + +.. c:type:: MEMCACHED_BEHAVIOR_POLL_TIMEOUT + +Modify the timeout in milliseconds value that is used by poll. The default value is -1. An signed int must be passed to memcached_behavior_set to change this value (this requires casting). For memcached_behavior_get a signed int value will be cast and returned as the unsigned long long. + +.. c:type:: MEMCACHED_BEHAVIOR_USER_DATA +.. deprecated:: < 0.30 + +.. c:type:: MEMCACHED_BEHAVIOR_BUFFER_REQUESTS + +Enabling buffered IO causes commands to "buffer" instead of being sent. Any action that gets data causes this buffer to be be sent to the remote connection. Quiting the connection or closing down the connection will also cause the buffered data to be pushed to the remote connection. + + +.. c:type:: MEMCACHED_BEHAVIOR_VERIFY_KEY + +Enabling this will cause :manpage:`libmemcached(3)` to test all keys to verify that they are valid keys. + + + +.. c:type:: MEMCACHED_BEHAVIOR_SORT_HOSTS + +Enabling this will cause hosts that are added to be placed in the host list in sorted order. This will defeat consisten hashing. + + +.. c:type:: MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT + +In non-blocking mode this changes the value of the timeout during socket connection in milliseconds. Specifying -1 means an infinite time‐out. + + +.. c:type:: MEMCACHED_BEHAVIOR_BINARY_PROTOCOL + +Enable the use of the binary protocol. Please note that you cannot toggle this flag on an open connection. + + + +.. c:type:: MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT + +Set this value to enable the server be removed after continuous MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT times connection failure. + + + +.. c:type:: MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK + +Set this value to tune the number of messages that may be sent before libmemcached should start to automatically drain the input queue. Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full). + + + +.. c:type:: MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK + +Set this value to tune the number of bytes that may be sent before libmemcached should start to automatically drain the input queue (need at least 10 IO requests sent without reading the input buffer). Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full). + + + +.. c:type:: MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH + +The binary protocol works a bit different than the textual protocol in that a multiget is implemented as a pipe of single get-operations which are sent to the server in a chunk. If you are using large multigets from your application, you may improve the latency of the gets by setting this value so you send out the first chunk of requests when you hit the specified limit. It allows the servers to start processing the requests to send the data back while the rest of the requests are created and sent to the server. + + + +.. c:type:: MEMCACHED_BEHAVIOR_NOREPLY + +Set this value to specify that you really don't care about the result from your storage commands (set, add, replace, append, prepend). + + + +.. c:type:: MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS + +If you just want "a poor mans HA", you may specify the numbers of replicas libmemcached should store of each item (on different servers). This replication does not dedicate certain memcached servers to store the replicas in, but instead it will store the replicas together with all of the other objects (on the 'n' next servers specified in your server list). + + + +.. c:type:: MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ + +Allows randomizing the replica reads starting point. Normally the read is done from primary server and in case of miss the read is done from primary + 1, then primary + 2 all the way to 'n' replicas. If this option is set on the starting point of the replica reads is randomized between the servers. This allows distributing read load to multiple servers with the expense of more write traffic. + + + +.. c:type:: MEMCACHED_BEHAVIOR_CORK + +This open has been deprecated with the behavior now built and used appropriately on selected platforms. + + +.. c:type:: MEMCACHED_BEHAVIOR_KEEPALIVE + +Enable TCP_KEEPALIVE behavior. + + + +.. c:type:: MEMCACHED_BEHAVIOR_KEEPALIVE_IDLE + +Specify time, in seconds, to mark a connection as idle. This is only available as an option Linux. + + +.. c:type:: MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE + +Find the current size of SO_SNDBUF. A value of 0 means either an error occured or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error. + + +.. c:type:: MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE + +Find the current size of SO_RCVBUF. A value of 0 means either an error occured or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error. + + +.. c:type:: MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT +.. deprecated:: 0.48 + See :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS` + + This number of times a host can have an error before it is disabled. + + +.. c:type:: MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS +.. deprecated:: 0.48 + See :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS` + + If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure. This must be used in combination with MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT. + +.. c:type:: MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS + + If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure. + +.. c:type:: MEMCACHED_BEHAVIOR_RETRY_TIMEOUT + +When enabled a host which is problematic will only be checked for usage based on the amount of time set by this behavior. The value is in seconds. + + +.. c:type:: MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY + +When enabled the prefix key will be added to the key when determining server +by hash. See :c:type:`MEMCACHED_CALLBACK_NAMESPACE` for additional +information. + + + + +------ +RETURN +------ + + +memcached_behavior_get returns either the current value of the get, or 0 +or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set +returns failure or success. + + +----- +NOTES +----- + + +memcached_behavior_set in version .17 was changed from taking a pointer +to data value, to taking a uin64_t. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_callback.rst.txt b/_sources/memcached_callback.rst.txt new file mode 100644 index 00000000..0641aa4a --- /dev/null +++ b/_sources/memcached_callback.rst.txt @@ -0,0 +1,157 @@ +================= +Setting callbacks +================= + + +Get and set a callback + +.. index:: object: memcached_st + + +-------- +SYNOPSIS +-------- + +#include + +.. c:type:: memcached_callback_t + +.. c:function:: memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, const void *data) + +.. c:function:: void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +libmemcached(3) can have callbacks set key execution points. These either +provide function calls at points in the code, or return pointers to +structures for particular usages. + +:c:func:`memcached_callback_get` takes a callback flag and returns the +structure or function set by :c:func:`memcached_callback_set`. + +:c:func:`memcached_callback_set` changes the function/structure assigned by a +callback flag. No connections are reset. + +You can use :c:type:`MEMCACHED_CALLBACK_USER_DATA` to provide custom context +if required for any of the callbacks. + + +.. c:type:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION + +When :c:func:`memcached_delete` is called this function will be excuted. At +the point of its execution all connections are closed. + + + +.. c:type:: MEMCACHED_CALLBACK_CLONE_FUNCTION + +When :c:func:`memcached_delete` is called this function will be excuted. +At the point of its execution all connections are closed. + +.. c:type:: MEMCACHED_CALLBACK_PREFIX_KEY + + See :c:type:`MEMCACHED_CALLBACK_NAMESPACE` + +.. c:type:: MEMCACHED_CALLBACK_NAMESPACE + +You can set a value which will be used to create a domain for your keys. +The value specified here will be prefixed to each of your keys. The value can +not be greater then :c:macro:`MEMCACHED_PREFIX_KEY_MAX_SIZE` - 1 and will +reduce :c:macro:`MEMCACHED_MAX_KEY` by the value of your key. + +The prefix key is only applied to the primary key, not the master key. +:c:type:`MEMCACHED_FAILURE` will be returned if no key is set. In the case of +a key which is too long, :c:type:`MEMCACHED_BAD_KEY_PROVIDED` will be returned. + +If you set a value with the value being NULL then the prefix key is disabled. + +.. c:type:: MEMCACHED_CALLBACK_USER_DATA + +This allows you to store a pointer to a specifc piece of data. This can be +retrieved from inside of :c:func:`memcached_fetch_execute`. Cloning a +:c:type:`memcached_st` will copy the pointer to the clone. + +.. c:type:: MEMCACHED_CALLBACK_MALLOC_FUNCTION +.. deprecated:: <0.32 + Use :c:type:`memcached_set_memory_allocators` instead. + +.. c:type:: MEMCACHED_CALLBACK_REALLOC_FUNCTION +.. deprecated:: <0.32 + Use :c:type:`memcached_set_memory_allocators` instead. + +.. c:type:: MEMCACHED_CALLBACK_FREE_FUNCTION +.. deprecated:: <0.32 + Use :c:type:`memcached_set_memory_allocators` instead. + +.. c:type:: MEMCACHED_CALLBACK_GET_FAILURE + +This function implements the read through cache behavior. On failure of retrieval this callback will be called. + +You are responsible for populating the result object provided. This result object will then be stored in the server and returned to the calling process. + +You must clone the :c:type:`memcached_st` in order to +make use of it. The value will be stored only if you return +:c:type:`MEMCACHED_SUCCESS` or :c:type:`MEMCACHED_BUFFERED`. Returning +:c:type:`MEMCACHED_BUFFERED` will cause the object to be buffered and not sent +immediatly (if this is the default behavior based on your connection setup +this will happen automatically). + +The prototype for this is: + +.. c:function:: memcached_return_t (\*memcached_trigger_key)(memcached_st \*ptr, char \*key, size_t key_length, memcached_result_st \*result); + + + +.. c:type:: MEMCACHED_CALLBACK_DELETE_TRIGGER + +This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it. + +The prototype for this is: + +.. c:function:: typedef memcached_return_t (\*memcached_trigger_delete_key)(memcached_st \*ptr, char \*key, size_t key_length); + + + + +------ +RETURN +------ + + +:c:func:`memcached_callback_get` return the function or structure that was +provided. Upon error, nothing is set, null is returned, and the +:c:type:`memcached_return_t` argument is set to :c:type:`MEMCACHED_FAILURE`. + +:c:func:`memcached_callback_set` returns :c:type:`MEMCACHED_SUCCESS` upon +successful setting, otherwise :c:type:`MEMCACHED_FAILURE` on error. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_cas.rst.txt b/_sources/memcached_cas.rst.txt new file mode 100644 index 00000000..a796f303 --- /dev/null +++ b/_sources/memcached_cas.rst.txt @@ -0,0 +1,78 @@ +==================================================== +Working with data on the server in an atomic fashion +==================================================== + +.. index:: object: memcached_st + + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas) + +.. c:function:: memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + +:c:func:`memcached_cas` overwrites data in the server as long as the "cas" +value is still the same in the server. You can get the cas value of a result +by calling :c:func:`memcached_result_cas` on a memcached_result_st(3) +structure. At the point that this note was written cas is still buggy in memached. Turning on tests for it in libmemcached(3) is optional. Please see +:c:func:`memcached_set` for information on how to do this. + +:c:func:`memcached_cas_by_key` method behaves in a similar method as the non +key methods. The difference is that it uses the group_key parameter +to map objects to particular servers. + +:c:func:`memcached_cas` is testsed with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior +on, there are limits to the size of the payload being sent to the server. The +reason for these limits is that the Memcached Server does not allow +multi-datagram requests and the current server implementation sets a datagram +size to 1400 bytes. Due to protocol overhead, the actual limit of the user +supplied data is less than 1400 bytes and depends on the protocol in use as, +well as the operation being executed. When running with the binary protocol, +:c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value, +flags and expiry combined may not exceed 1368 bytes. When running with the +ASCII protocol, the exact limit fluctuates depending on which function is +being executed and whether the function is a cas operation or not. For +non-cas ASCII set operations, there are at least 1335 bytes available to +split among the key, key_prefix, and value; for cas ASCII operations there +are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, exceeds 1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned. + + +------ +RETURN +------ + + +All methods return a value of type :c:type:`memcached_return_t`. +On success the value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror` to translate this value to a printable +string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_append(3)` :manpage:`memcached_add(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_replace(3)` + diff --git a/_sources/memcached_create.rst.txt b/_sources/memcached_create.rst.txt new file mode 100644 index 00000000..ae851ba9 --- /dev/null +++ b/_sources/memcached_create.rst.txt @@ -0,0 +1,83 @@ +====================================== +Creating and destroying a memcached_st +====================================== + +-------- +SYNOPSIS +-------- + +#include + +.. c:type:: memcached_st + +.. c:function:: memcached_st* memcached_create(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:: 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` +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 +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` over :c:func:`memcached_create`. + +: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`. +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 +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 +deallocated when you finish using the structure. + +You may wish to avoid using memcached_create(3) or memcached_clone(3) with a +stack based allocation. The most common issues related to ABI safety involve +heap allocated structures. + + +------ +RETURN +------ + + +: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` +that was created (or initialized). On an allocation failure, it returns NULL. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_delete.rst.txt b/_sources/memcached_delete.rst.txt new file mode 100644 index 00000000..1c4f2661 --- /dev/null +++ b/_sources/memcached_delete.rst.txt @@ -0,0 +1,73 @@ +=========================== +Deleting data from a server +=========================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration) + +.. c:function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration) + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_delete` is used to delete a particular key. +:c:func:`memcached_delete_by_key` works the same, but it takes a master key +to find the given value. + +Expiration works by placing the item into a delete queue, which means that +it won't be possible to retrieve it by the "get" command. The "add" and +"replace" commands with this key will also fail (the "set" command will +succeed, however). After the time passes, the item is finally deleted from server memory. + +Please note the the Danga memcached server removed tests for expiration in +the 1.4 version. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror` to translate this value to a printable +string. + +If you are using the non-blocking mode of the library, success only +means that the message was queued for delivery. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_dump.rst.txt b/_sources/memcached_dump.rst.txt new file mode 100644 index 00000000..988410fc --- /dev/null +++ b/_sources/memcached_dump.rst.txt @@ -0,0 +1,72 @@ +========================== +Dumping data from a server +========================== + + +Get a list of keys found on memcached servers + +.. index:: object: memcached_st + + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks) + +.. c:type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context) + +Compile and link with -lmemcached + + + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_dump` is used to get a list of keys found in memcached(1) +servers. Because memcached(1) does not guarentee to dump all keys you can not +assume you have fetched all keys from the server. The function takes an array +of callbacks that it will use to execute on keys as they are found. + +Currently the binary protocol is not testsed. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror` to translate this value to a printable +string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_flush.rst.txt b/_sources/memcached_flush.rst.txt new file mode 100644 index 00000000..042a4d42 --- /dev/null +++ b/_sources/memcached_flush.rst.txt @@ -0,0 +1,65 @@ +===================================== +Wiping clean the contents of a server +===================================== + +.. index:: object: memcached_st + +Wipe contents of memcached servers + + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +:c:func::`memcached_flush` is used to wipe clean the contents of :program:`memcached` servers. +It will either do this immediately or expire the content based on the +expiration time passed to the method (a value of zero causes an immediate +flush). The operation is not atomic to multiple servers, just atomic to a +single server. That is, it will flush the servers in the order that they were +added. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:type:`memcached_strerror` to translate this value to a printable string. + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_flush_buffers.rst.txt b/_sources/memcached_flush_buffers.rst.txt new file mode 100644 index 00000000..888c9254 --- /dev/null +++ b/_sources/memcached_flush_buffers.rst.txt @@ -0,0 +1,65 @@ +======================= +Flushing client buffers +======================= + + +.. index:: object: memcached_st + +Flush and senf buffered commands + +-------- +SYNOPSIS +-------- + +#include + +.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_flush_buffers` is used in conjunction with +:c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror` to translate this value to a printable +string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +Trond Norbye, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_generate_hash_value.rst.txt b/_sources/memcached_generate_hash_value.rst.txt new file mode 100644 index 00000000..9a9b5a67 --- /dev/null +++ b/_sources/memcached_generate_hash_value.rst.txt @@ -0,0 +1,102 @@ +=============================== +Generating hash values directly +=============================== + +.. index:: object: memcached_st + +Hash a key value + + +-------- +SYNOPSIS +-------- + + +#include + +.. c:type:: memcached_hash_t + +.. c:function:: uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm) + +.. c:function:: uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length) + +.. c:type:: MEMCACHED_HASH_DEFAULT + +.. c:type:: MEMCACHED_HASH_MD5 + +.. c:type:: MEMCACHED_HASH_CRC + +.. c:type:: MEMCACHED_HASH_FNV1_64 + +.. c:type:: MEMCACHED_HASH_FNV1A_64 + +.. c:type:: MEMCACHED_HASH_FNV1_32 + +.. c:type:: MEMCACHED_HASH_FNV1A_32 + +.. c:type:: MEMCACHED_HASH_JENKINS + +.. c:type:: MEMCACHED_HASH_MURMUR + +.. c:type:: MEMCACHED_HASH_HSIEH + +.. c:type:: MEMCACHED_HASH_MURMUR3 + + +Compile and link with -lmemcachedutil -lmemcached + + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_generate_hash_value` allows you to hash a key using one of +the hash functions defined in the library. This method is provided for +the convenience of higher-level language bindings and is not necessary +for normal memcache operations. + +The allowed hash algorithm constants are listed in the manpage for +:c:func:`memcached_behavior_set`. + +:c:func:`memcached_generate_hash` takes a :c:type:`memcached_st` struture +and produces the hash value that would have been generated based on the +defaults of :c:type:`memcached_st`. + +As of version 0.36 all hash methods have been placed into the library +libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation. + + +------ +RETURN +------ + + +A 32-bit integer which is the result of hashing the given key. +For 64-bit hash algorithms, only the least-significant 32 bits are +returned. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_get.rst.txt b/_sources/memcached_get.rst.txt new file mode 100644 index 00000000..59309669 --- /dev/null +++ b/_sources/memcached_get.rst.txt @@ -0,0 +1,131 @@ +=============================== +Retrieving data from the server +=============================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_result_st * memcached_fetch_result (memcached_st *ptr, memcached_result_st *result, memcached_return_t *error) + +.. c:function:: char * memcached_get (memcached_st *ptr, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error) + +.. c:function:: memcached_return_t memcached_mget (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys) + +.. c:function:: char * memcached_get_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error) + +.. c:function:: memcached_return_t memcached_mget_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys) + +.. c:function:: memcached_return_t memcached_fetch_execute (memcached_st *ptr, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks) + +.. c:function:: memcached_return_t memcached_mget_execute (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks) + +.. c:function:: memcached_return_t memcached_mget_execute_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks) + +.. c:type:: memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_get` is used to fetch an individual value from the server. +You must pass in a key and its length to fetch the object. You must supply +three pointer variables which will give you the state of the returned +object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of +the object, and a :c:type:`memcached_return_t` pointer to hold any error. The +object will be returned upon success and NULL will be returned on failure. Any +object returned by :c:func:`memcached_get` must be released by the caller +application. + +:c:func:`memcached_mget` is used to select multiple keys at once. For +multiple key operations it is always faster to use this function. This function always works asynchronously. + +To retrieve data after a successful execution of :c:func:`memcached_mget`, you will need to +call :c:func:`memcached_fetch_result`. You should continue to call this function until +it returns a NULL (i.e. no more values). If you need to quit in the middle of a +:c:func:`memcached_mget` call, you can execute a :c:func:`memcached_quit`, those this is not required. + +:c:func:`memcached_fetch_result` is used to fetch an individual value from the server. :c:func:`memcached_mget` must always be called before using this method. +You must pass in a key and its length to fetch the object. You must supply +three pointer variables which will give you the state of the returned +object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of the +object, and a :c:type:`memcached_return_t` pointer to hold any error. The +object will be returned upon success and NULL will be returned on failure. :c:type:`MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon :c:type:`MEMCACHED_END` is null. + +:c:func:`memcached_fetch_result` is used to return a :c:type:`memcached_result_st` structure from a memcached server. The result object is forward compatible +with changes to the server. For more information please refer to the +:c:type:`memcached_result_st` help. This function will dynamically allocate a +result structure for you if you do not pass one to the function. + +:c:func:`memcached_fetch_execute` is a callback function for result sets. +Instead of returning the results to you for processing, it passes each of the +result sets to the list of functions you provide. It passes to the function +a :c:type:`memcached_st` that can be cloned for use in the called +function (it can not be used directly). It also passes a result set which does +not need to be freed. Finally it passes a "context". This is just a pointer to +a memory reference you supply the calling function. Currently only one value +is being passed to each function call. In the future there will be an option +to allow this to be an array. + +:c:func:`memcached_mget_execute` and :c:func:`memcached_mget_execute_by_key` +is similar to :c:func:`memcached_mget`, but it may trigger the supplied +callbacks with result sets while sending out the queries. If you try to +perform a really large multiget with :c:func:`memcached_mget` you may +encounter a deadlock in the OS kernel (it will fail to write data to the +socket because the input buffer is full). :c:func:`memcached_mget_execute` +solves this problem by processing some of the results before continuing +sending out requests. Please note that this function is only available in +the binary protocol. + +:c:func:`memcached_get_by_key` and :c:func:`memcached_mget_by_key` behave +in a similar nature as :c:func:`memcached_get` and :c:func:`memcached_mget`. +The difference is that they take a master key that is used for determining +which server an object was stored if key partitioning was used for storage. + +All of the above functions are not tested when the +:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these +functions with this behavior on will result in :c:type:`MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :c:type:`memcached_return_t`, the error function parameter will be set to :c:type:`MEMCACHED_NOT_SUPPORTED`. + + +------ +RETURN +------ + + +All objects retrieved via :c:func:`memcached_get` or :c:func:`memcached_get_by_key` must be freed with :manpage:`free(3)`. + +:c:func:`memcached_get` will return NULL on +error. You must look at the value of error to determine what the actual error +was. + +:c:func:`memcached_fetch_execute` return :c:type:`MEMCACHED_SUCCESS` if +all keys were successful. :c:type:`MEMCACHED_NOTFOUND` will be return if no +keys at all were found. + +:c:func:`memcached_fetch_result` sets error +to :c:type:`MEMCACHED_END` upon successful conclusion. +:c:type:`MEMCACHED_NOTFOUND` will be return if no keys at all were found. + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_memory_allocators.rst.txt b/_sources/memcached_memory_allocators.rst.txt new file mode 100644 index 00000000..12a4ce5e --- /dev/null +++ b/_sources/memcached_memory_allocators.rst.txt @@ -0,0 +1,93 @@ +======================================== +Use custom allocators for embedded usage +======================================== + +.. index:: object: memcached_st + +Manage memory allocator functions + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context) + +.. c:function:: void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc) + +.. c:function:: void * memcached_get_memory_allocators_context(const memcached_st *ptr) + +.. c:function:: void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context) + +.. c:function:: void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context) + +.. c:function:: void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context) + +.. c:function:: void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context) + +Compile and link with -lmemcached + + + +----------- +DESCRIPTION +----------- + + +libmemcached(3) allows you to specify your own memory allocators, optimized +for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation. + +:c:func:`memcached_set_memory_allocators` is used to set the memory +allocators used by the memcached instance specified by ptr. Please note that +you cannot override only one of the memory allocators, you have to specify a +complete new set if you want to override one of them. All of the memory +allocation functions should behave as specified in the C99 standard. Specify +NULL as all functions to reset them to the default values. + +:c:func:`memcached_get_memory_allocators` is used to get the currently used +memory allocators by a mamcached handle. + +:c:func:`memcached_get_memory_allocators_context` returns the void \* that +was passed in during the call to :c:func:`memcached_set_memory_allocators`. + +The first argument to the memory allocator functions is a pointer to a +memcached structure, the is passed as const and you will need to clone +it in order to make use of any operation which would modify it. + + +----- +NOTES +----- + + +In version 0.38 all functions were modified to have a context void pointer +passed to them. This was so that customer allocators could have their +own space for memory. + + +------ +RETURN +------ + + +:c:func:`memcached_set_memory_allocators` return :c:type:`MEMCACHED_SUCCESS` +upon success, and :c:type:`MEMCACHED_FAILURE` if you don't pass a complete set +of function pointers. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_pool.rst.txt b/_sources/memcached_pool.rst.txt new file mode 100644 index 00000000..a3080788 --- /dev/null +++ b/_sources/memcached_pool.rst.txt @@ -0,0 +1,109 @@ +============================ +Working with memcached pools +============================ + +-------- +SYNOPSIS +-------- + +#include + +.. c:type:: memcached_pool_st + +.. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length) + +.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max) +.. deprecated:: 0.46 + Use :c:func:`memcached_pool` + +.. c:function:: memcached_st* memcached_pool_destroy(memcached_pool_st* pool) + +.. c:function:: memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc) +.. deprecated:: 0.53 + Use :c:func:`memcached_pool_fetch` + +.. c:function:: memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc) + +.. versionadded:: 0.53 + Synonym for memcached_pool_pop + +.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc) +.. deprecated:: 0.53 + Use :c:func:`memcached_pool_push` + +.. c:function:: memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc) +.. versionadded:: 0.53 + Synonym for memcached_pool_push. + +.. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) + +.. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) + +Compile and link with -lmemcachedutil -lmemcached + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_pool` is used to create a connection pool of objects you +may use to remove the overhead of using memcached_clone for short lived +:c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration` for details on the format of the configuration string. + +:c:func:`memcached_pool_destroy` is used to destroy the connection pool +created with :c:func:`memcached_pool_create` and release all allocated +resources. It will return the pointer to the :c:type:`memcached_st` structure +passed as an argument to :c:func:`memcached_pool_create`, and returns the ownership of the pointer to the caller when created with :c:func:`memcached_pool_create`, otherwise NULL is returned.. + +:c:func:`memcached_pool_fetch` is used to fetch a connection structure from the +connection pool. The relative_time argument specifies if the function should +block and wait for a connection structure to be available if we try +to exceed the maximum size. You need to specify time in relative time. + +:c:func:`memcached_pool_release` is used to return a connection structure back to the pool. + +:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_set` is used to get/set behavior flags on all connections in the pool. + +Both :c:func:`memcached_pool_release` and :c:func:`memcached_pool_fetch` are thread safe. + +------ +RETURN +------ + +:c:func:`memcached_pool_destroy` returns the pointer (and ownership) to the :c:type:`memcached_st` structure used to create the pool. If connections are in use it returns NULL. + +:c:func:`memcached_pool_pop` returns a pointer to a :c:type:`memcached_st` structure from the pool (or NULL if an allocation cannot be satisfied). + +:c:func:`memcached_pool_release` returns :c:type:`MEMCACHED_SUCCESS` upon success. + +:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get` returns :c:type:`MEMCACHED_SUCCESS` upon success. + +If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned. + +memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +Trond Norbye, + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`libmemcached_configuration(3)` diff --git a/_sources/memcached_quit.rst.txt b/_sources/memcached_quit.rst.txt new file mode 100644 index 00000000..b94832ec --- /dev/null +++ b/_sources/memcached_quit.rst.txt @@ -0,0 +1,63 @@ +==================================== +Disconnecting a client from a server +==================================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + +#include + +.. c:function:: void memcached_quit (memcached_st *ptr) + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_quit` will disconnect you from all currently connected +servers. It will also reset the state of the connection (ie, any :c:func:`memcached_fetch` you are in the middle of will be terminated). This function is +called automatically when you call :c:func:`memcached_free` on the :c:type:`memcached_st` structure. + +You do not need to call this on your own. All operations to change server +hashes and parameters will handle connections to the server for you. This +function is provided mainly so that you can timeout your connections or +reset connections during the middle of a :c:func:`memcached_fetch`. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned On success that value +will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to +translate this value to a printable string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_result_st.rst.txt b/_sources/memcached_result_st.rst.txt new file mode 100644 index 00000000..9b60f187 --- /dev/null +++ b/_sources/memcached_result_st.rst.txt @@ -0,0 +1,125 @@ +======================== +Working with result sets +======================== + +-------- +SYNOPSIS +-------- + +#include + +.. c:type:: memcached_result_st + +.. c:function:: memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result) + +.. c:function:: void memcached_result_free (memcached_result_st *result) + +.. c:function:: const char * memcached_result_key_value (memcached_result_st *result) + +.. c:function:: size_t memcached_result_key_length (const memcached_result_st *result) + +.. c:function:: const char *memcached_result_value (memcached_result_st *ptr) + +.. c:function:: char *memcached_result_take_value (memcached_result_st *ptr) + +.. c:function:: size_t memcached_result_length (const memcached_result_st *ptr) + +.. c:function:: uint32_t memcached_result_flags (const memcached_result_st *result) + +.. c:function:: uint64_t memcached_result_cas (const memcached_result_st *result) + +.. c:function:: memcached_return_t memcached_result_set_value (memcached_result_st *ptr, const char *value, size_t length) + +.. c:function:: void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags) + +.. c:function:: void memcached_result_set_expiration (memcached_result_st *ptr, time_t) + +Compile and link with -lmemcachedutil -lmemcached + + + +----------- +DESCRIPTION +----------- + + +libmemcached(3) can optionally return a :c:type:`memcached_result_st` which +acts as a result object. The result objects have added benefits over the +character pointer returns, in that they are forward compatible with new +return items that future memcached servers may implement (the best current +example of this is the CAS return item). The structures can also be reused, +which will save on calls to malloc(3). It is suggested that you use result +objects over char \* return functions. + +The structure of :c:type:`memcached_result_st` has been encapsulated, you should +not write code to directly access members of the structure. + +:c:func:`memcached_result_create` will either allocate memory for a +:c:type:`memcached_result_st` or will initialize a structure passed to it. + +:c:func:`memcached_result_free` will deallocate any memory attached to the +structure. If the structure was also allocated, it will deallocate it. + +:c:func:`memcached_result_key_value` returns the key value associated with the +current result object. + +:c:func:`memcached_result_key_length` returns the key length associated with +the current result object. + +:c:func:`memcached_result_value` returns the result value associated with the +current result object. + +:c:func:`memcached_result_take_value` returns and hands over the result value +associated with the current result object. You must call free() to release this +value, unless you have made use of a custom allocator. Use of a custom +allocator requires that you create your own custom free() to release it. + +:c:func:`memcached_result_length` returns the result length associated with +the current result object. + +:c:func:`memcached_result_flags` returns the flags associated with the +current result object. + +:c:func:`memcached_result_cas` returns the cas associated with the +current result object. This value will only be available if the server +tests it. + +:c:func:`memcached_result_set_value` takes a byte array and a size and sets +the result to this value. This function is used for trigger responses. + +:c:func:`memcached_result_set_flags` takes a result structure and stores a new +value for the flags field. + +:c:func:`memcached_result_set_expiration` takes a result structure and stores +a new value for the expiration field (this is only used by read through +triggers). + +You may wish to avoid using memcached_result_create(3) with a +stack based allocation. The most common issues related to ABI safety involve +heap allocated structures. + + +------ +RETURN +------ + + +Varies, see particular functions. All structures must have +:c:func:`memcached_result_free` called on them for cleanup purposes. Failure +to do this will result in leaked memory. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_sasl.rst.txt b/_sources/memcached_sasl.rst.txt new file mode 100644 index 00000000..2a2e5699 --- /dev/null +++ b/_sources/memcached_sasl.rst.txt @@ -0,0 +1,80 @@ +============ +SASL support +============ + +.. index:: object: memcached_st + + +-------- +SYNOPSIS +-------- + +#include + +.. c:function:: void memcached_set_sasl_callbacks(memcached_st *ptr, const sasl_callback_t *callbacks) + +.. c:function:: const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr) + +.. c:function:: memcached_return_t memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password) + +.. c:function:: memcached_return_t memcached_destroy_sasl_auth_data(memcached_st *ptr) + +Compile and link with -lmemcached + + + +----------- +DESCRIPTION +----------- + + +libmemcached(3) allows you to plug in your own callbacks function used by +libsasl to perform SASL authentication. + +Please note that SASL requires the memcached binary protocol, and you have +to specify the callbacks before you connect to the server. + +:c:func:`memcached_set_sasl_auth_data` is a helper function defining +the basic functionality for you, but it will store the username and password +in memory. If you choose to use this method you have to call +:c:type:`memcached_destroy_sasl_auth_data` before calling +:c:type:`memcached_free` to avoid a memory leak. You should NOT call +:c:type:`memcached_destroy_sasl_auth_data` if you specify your own callback +function with :c:func:`memcached_set_sasl_callbacks`. + + +------ +RETURN +------ + + +:c:func:`memcached_get_sasl_callbacks` returns the callbacks currently used by +this memcached handle. :c:func:`memcached_set_sasl_auth_data` returns +:c:type:`MEMCACHED_SUCCESS` upon success. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +Trond Norbye, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_server_st.rst.txt b/_sources/memcached_server_st.rst.txt new file mode 100644 index 00000000..63008795 --- /dev/null +++ b/_sources/memcached_server_st.rst.txt @@ -0,0 +1,89 @@ +========================= +Managing lists of servers +========================= + + +-------- +SYNOPSIS +-------- + + + +#include + +.. c:type:: const memcached_instance_st * + +.. c:type:: memcached_server_list_st + +.. c:type:: memcached_server_st + +.. c:function:: const const memcached_instance_st * memcached_server_list (memcached_st *ptr) + +.. c:function:: void memcached_server_list_free (memcached_server_list_st list) + +.. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, in_port_t port, memcached_return_t *error) + +.. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list) + +.. c:function:: const char *memcached_server_error (const memcached_instance_st * instance) + +.. c:function:: void memcached_server_error_reset (const memcached_instance_st * list) +.. deprecated:: 0.39 + +.. c:function:: void memcached_servers_parse () +.. deprecated:: 0.39 + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +libmemcached(3) operates on a list of hosts which are stored in +:c:type:`memcached_server_st` structures. You should not modify these structures +directly. Functions are provided to modify these structures (and more can be +added, just ask!). + +:c:func:`memcached_server_list` is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39. + +:c:func:`memcached_server_list_free` deallocates all memory associated with the array of :c:type:`memcached_server_st` that you passed to it. + +:c:func:`memcached_server_list_append` adds a server to the end of a +:c:type:`memcached_server_st` array. On error null will be returned and the +:c:type:`memcached_return_t` pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default +port of a memcached server. + +DEPRECATED :c:func:`memcached_servers_parse`, please see :c:func:`memcached` + +:c:func:`memcached_server_error` can be used to look at the text of the last error message sent by the server to to the client. + +Before version 0.39 theses functions used a memcache_server_st \*. In 0.39 +memcached_server_st \* was aliased to :c:type:`memcached_server_list_st`. This was done for a style reason to help clean up some concepts in the code. + + +------ +RETURN +------ + + +Varies, see particular functions. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_servers.rst.txt b/_sources/memcached_servers.rst.txt new file mode 100644 index 00000000..d3c90379 --- /dev/null +++ b/_sources/memcached_servers.rst.txt @@ -0,0 +1,99 @@ +======================================================== +Manipulate the server information stored in memcached_st +======================================================== + +-------- +SYNOPSIS +-------- + +#include + +.. c:type:: memcached_server_fn + +.. c:function:: uint32_t memcached_server_count (memcached_st *ptr) + +.. c:function:: memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port) + +.. c:function:: memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port) + +.. c:function:: memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket) + +.. c:function:: memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list) + +.. c:function:: const memcached_instance_st * memcached_server_by_key (memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error) + +.. c:function:: const memcached_instance_st * memcached_server_get_last_disconnect (const memcached_st *ptr) + +.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks) + +compile and link with -lmemcached + + + +----------- +DESCRIPTION +----------- + + +:doc:`libmemcached` performs operations on a list of hosts. The order of +these hosts determine routing to keys. Functions are provided to add keys to +memcached_st structures. To manipulate lists of servers see +memcached_server_st(3). + +:c:func:`memcached_server_count` provides you a count of the current number of +servers being used by a :c:type:`memcached_st` structure. + +:c:func:`memcached_server_add` pushes a single TCP server into the :c:type:`memcached_st` structure. This server will be placed at the end. Duplicate servers + are allowed, so duplication is not checked. Executing this function with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set will result in a :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`. + +:c:func:`memcached_server_add_udp` pushes a single UDP server into the :c:type:`memcached_st` structure. This server will be placed at the end. Duplicate +servers are allowed, so duplication is not checked. Executing this function with out setting the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior will result in a +:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`. + +:c:func:`memcached_server_add_unix_socket` pushes a single UNIX socket into the :c:type:`memcached_st` structure. This UNIX socket will be placed at the end. +Duplicate servers are allowed, so duplication is not checked. The length +of the filename must be one character less than :c:type:`MEMCACHED_MAX_HOST_LENGTH`. + +:c:func:`memcached_server_push` pushes an array of :c:type:`memcached_server_st` into the :c:type:`memcached_st` structure. These servers will be placed at +the end. Duplicate servers are allowed, so duplication is not checked. A +copy is made of structure so the list provided (and any operations on +the list) are not saved. + +:c:func:`memcached_server_by_key` allows you to provide a key and retrieve the +server which would be used for assignment. + +:c:func:`memcached_server_get_last_disconnect` returns a pointer to the last +server for which there was a connection problem. It does not mean this +particular server is currently dead but if the library is reporting a server +is, the returned server is a very good candidate. + +:c:func:`memcached_server_cursor` takes a memcached_st and loops through the +list of hosts currently in the cursor calling the list of callback +functions provided. You can optionally pass in a value via +context which will be provided to each callback function. An error +return from any callback will terminate the loop. :c:func:`memcached_server_cursor` is passed the original caller :c:type:`memcached_st` in its current state. + + +------ +RETURN +------ + + +Varies, see particular functions. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/_sources/memcached_set.rst.txt b/_sources/memcached_set.rst.txt new file mode 100644 index 00000000..6cbebe06 --- /dev/null +++ b/_sources/memcached_set.rst.txt @@ -0,0 +1,101 @@ +========================================================= +Store, replace, add, or atomically add data to the server +========================================================= + +.. index:: object: memcached_st + + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) + +.. c:function:: memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) + +.. c:function:: memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) + +.. c:function:: memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) + +.. c:function:: memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) + +.. c:function:: memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_set`, :c:func:`memcached_add`, and :c:func:`memcached_replace` are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you +store the object. Keys are currently limited to 250 characters by the +memcached(1) server. You must supply both a value and a length. Optionally you +may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it. + +:c:func:`memcached_set` will write an object to the server. If an object +already exists it will overwrite what is in the server. If the object does not +exist it will be written. If you are using the non-blocking mode this function +will always return true unless a network error occurs. + +:c:func:`memcached_replace` replaces an object on the server. If the object is not found on the server an error occurs. + +:c:func:`memcached_add` adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored. + +:c:func:`memcached_cas` overwrites data in the server as long as the "cas" +value is still the same in the server. You can get the cas value of a result by +calling :c:func:`memcached_result_cas` on a memcached_result_st(3) structure. At the point +that this note was written cas is still buggy in memached. Turning on tests +for it in libmemcached(3) is optional. Please see memcached_set for +information on how to do this. + +:c:func:`memcached_set_by_key`, :c:func:`memcached_add_by_key`, and :c:func:`memcached_replace_by_key` methods all behave in a similar method as the non +key methods. The difference is that they use their group_key parameter to map +objects to particular servers. + +If you are looking for performance, :c:func:`memcached_set` with non-blocking IO is the fastest way to store data on the server. + +All of the above functions are testsed with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior +on, there are limits to the size of the payload being sent to the server. +The reason for these limits is that the Memcached Server does not allow +multi-datagram requests and the current server implementation sets a datagram +size to 1400 bytes. Due to protocol overhead, the actual limit of the user supplied data is less than 1400 bytes and depends on the protocol in use as, well as the operation being +executed. When running with the binary protocol, :c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value, flags and expiry combined may not +exceed 1368 bytes. When running with the ASCII protocol, the exact limit fluctuates depending on which function is being executed and whether the function is a cas operation or not. For non-cas ASCII set operations, there are at least +1335 bytes available to split among the key, key_prefix, and value; for cas +ASCII operations there are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, +exceeds 1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned. + + +------ +RETURN +------ + + +All methods return a value of type :c:type:`memcached_return_t`. +On success the value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror` to translate this value to a printable string. + +For :c:func:`memcached_replace` and :c:func:`memcached_add`, :c:type:`MEMCACHED_NOTSTORED` is a legitmate error in the case of a collision. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_append(3)` + diff --git a/_sources/memcached_stats.rst.txt b/_sources/memcached_stats.rst.txt new file mode 100644 index 00000000..c173619a --- /dev/null +++ b/_sources/memcached_stats.rst.txt @@ -0,0 +1,93 @@ +================================================== +Working with statistical information from a server +================================================== + + +Get memcached statistics + +.. index:: object: memcached_st + + +-------- +SYNOPSIS +-------- + +#include + +.. c:type:: memcached_stat_st + +.. c:type:: memcached_return_t (*memcached_stat_fn)(const memcached_instance_st * server, const char *key, size_t key_length, const char *value, size_t value_length, void *context) + +.. c:function:: memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error) + +.. c:function:: memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, in_port_t port) + +.. c:function:: char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error) + +.. c:function:: char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error) + +.. c:function:: memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context) + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +libmemcached(3) has the ability to query a memcached server (or collection +of servers) for their current state. Queries to find state return a +:c:type:`memcached_stat_st` structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. :c:func:`memcached_stat_get_value` has been provided to query the structure. + +:c:func:`memcached_stat_execute` uses the servers found in :c:type:`memcached_stat_st` and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by +the memcached server. + +:c:func:`memcached_stat` fetches an array of :c:type:`memcached_stat_st` structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, a NULL value is returned and the error parameter is set to :c:type:`MEMCACHED_NOT_SUPPORTED`. + +:c:func:`memcached_stat_servername` can be used standalone without a :c:type:`memcached_st` to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either +the :c:func:`memcached_stat_get_keys` call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to +obtain information on. + +:c:func:`memcached_stat_get_value` returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated. + +:c:func:`memcached_stat_get_keys` returns a list of keys that the server has state objects on. You are responsible for freeing this list. + +A command line tool, memstat(1), is provided so that you do not have to write +an application to do this. + + +------ +RETURN +------ + + +Varies, see particular functions. + +Any method returning a :c:type:`memcached_stat_st` expects you to free the +memory allocated for it. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + diff --git a/_sources/memcached_strerror.rst.txt b/_sources/memcached_strerror.rst.txt new file mode 100644 index 00000000..07023b8d --- /dev/null +++ b/_sources/memcached_strerror.rst.txt @@ -0,0 +1,57 @@ +================================================ +Coverting Errors, memcached_return_t, to strings +================================================ + + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + +#include + +.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_strerror` takes a :c:type:`memcached_return_t` value and returns a string describing the error. + +This string must not be modified by the application. + +:c:type:`memcached_return_t` values are returned from nearly all libmemcached(3) functions. + +:c:type:`memcached_return_t` values are of an enum type so that you can set up responses with switch/case and know that you are capturing all possible return values. + + +------ +RETURN +------ + + +:c:func:`memcached_strerror` returns a string describing a :c:type:`memcached_return_t` value. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/_sources/memcached_user_data.rst.txt b/_sources/memcached_user_data.rst.txt new file mode 100644 index 00000000..93a777ff --- /dev/null +++ b/_sources/memcached_user_data.rst.txt @@ -0,0 +1,72 @@ +============================================== +Storing custom user information in the client. +============================================== + +.. index:: object: memcached_st + +Manage user specific data + + +------- +LIBRARY +------- + + +C Client Library for memcached (libmemcached, -lmemcached) + + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: void *memcached_get_user_data (memcached_st *ptr) + +.. c:function:: void *memcached_set_user_data (memcached_st *ptr, void *data) + +Compile and link with -lmemcached + + + +----------- +DESCRIPTION +----------- + + +libmemcached(3) allows you to store a pointer to a user specific data inside +the memcached_st structure. + +:c:func:`memcached_set_user_data` is used to set the user specific data in the +:c:type:`memcached_st` structure. + +:c:func:`memcached_get_user_data` is used to retrieve the user specific data in the :c:type:`memcached_st` structure. + + +------ +RETURN +------ + + +:c:func:`memcached_set_user_data` returns the previous value of the user specific data. + +:c:func:`memcached_get_user_data` returns the current value uf the user specific data. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` + diff --git a/_sources/memcached_verbosity.rst.txt b/_sources/memcached_verbosity.rst.txt new file mode 100644 index 00000000..c3ae0d89 --- /dev/null +++ b/_sources/memcached_verbosity.rst.txt @@ -0,0 +1,56 @@ +================================= +Setting the verbosity of a server +================================= + +.. index:: object: memcached_st + +Modifiy verbosity of servers + +-------- +SYNOPSIS +-------- + +#include + +.. c:function:: memcached_return_t memcached_verbosity (memcached_st *ptr, uint32_t verbosity) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_verbosity` modifies the "verbosity" of the +memcached(1) servers referenced in the :c:type:`memcached_st` parameter. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned. + +On success that value will be :c:type:`MEMCACHED_SUCCESS`. + +Use :c:func:`memcached_strerror` to translate this value to a printable string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + diff --git a/_sources/memcached_version.rst.txt b/_sources/memcached_version.rst.txt new file mode 100644 index 00000000..20b8b25a --- /dev/null +++ b/_sources/memcached_version.rst.txt @@ -0,0 +1,63 @@ +======================================================= +Getting version information about the client and server +======================================================= + + +-------- +SYNOPSIS +-------- + +#include + +.. c:function:: const char * memcached_lib_version (void) + +.. c:function:: memcached_return_t memcached_version (memcached_st *ptr) + + +Compile and link with -lmemcached + + + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_lib_version` is used to return a simple version string representing the libmemcached version (client library version, not server version) + +:c:func:`memcached_version` is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code. + + +------ +RETURN +------ + + +:c:func:`memcached_lib_version` returns a string with the version of the libmemcached driver. + +A value of :c:type:`memcached_return_t` is returned from :c:func:'memcached_version' + +On success that value will be :c:type:`MEMCACHED_SUCCESS`. + +If called with the :c:func:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value :c:type:`MEMCACHED_NOT_SUPPORTED` will be returned. + +Use :c:func:`memcached_strerror` to translate this value to +a printable string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + diff --git a/_sources/tap.rst.txt b/_sources/tap.rst.txt new file mode 100644 index 00000000..5572f114 --- /dev/null +++ b/_sources/tap.rst.txt @@ -0,0 +1,7 @@ +================= +Systemtap support +================= + +By default on Linux libmemcached is compiled to support Systemtap. This enabled/disabled during compiles via the dtrace configure flag. + +Please see :manpage: `stapex` for more information about Systemtap. diff --git a/_sources/types.rst.txt b/_sources/types.rst.txt new file mode 100644 index 00000000..ea418749 --- /dev/null +++ b/_sources/types.rst.txt @@ -0,0 +1,27 @@ +================ +Required C types +================ + +.. highlightlang:: c + +Types +----- + +C Types Used +------------ + +.. c:type:: bool + +.. c:type:: uint32_t + +.. c:type:: uint64_t + +.. c:type:: in_port_t + +.. c:type:: size_t + +.. c:type:: time_t + +.. c:type:: struct timespec + +.. c:type:: sasl_callback_t diff --git a/_sources/versioning.rst.txt b/_sources/versioning.rst.txt new file mode 100644 index 00000000..dd3bee9d --- /dev/null +++ b/_sources/versioning.rst.txt @@ -0,0 +1,8 @@ +========== +Versioning +========== + +Libmemcached is layed out by interface version. The 1.0 version would be found in: libmemcached-1.0/memcached.h + +The historic libmemcached/memcached.h includes libmemcached-1.0/memcached.h. For best practice you should include the version of libmemcacached that you used during development. + diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 00000000..ea6972d5 --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,764 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > p:first-child, +td > p:first-child { + margin-top: 0px; +} + +th > p:last-child, +td > p:last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +li > p:first-child { + margin-top: 0px; +} + +li > p:last-child { + margin-bottom: 0px; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > p:first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +div.code-block-caption { + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +div.code-block-caption + div > div.highlight > pre { + margin-top: 0; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + padding: 1em 1em 0; +} + +div.literal-block-wrapper div.highlight { + margin: 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: relative; + left: 0px; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css new file mode 100644 index 00000000..3c33cef5 --- /dev/null +++ b/_static/css/badge_only.css @@ -0,0 +1 @@ +.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} diff --git a/_static/css/theme.css b/_static/css/theme.css new file mode 100644 index 00000000..aed8cef0 --- /dev/null +++ b/_static/css/theme.css @@ -0,0 +1,6 @@ +/* sphinx_rtd_theme version 0.4.3 | MIT license */ +/* Built 20190212 16:02 */ +*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:.5cm}p,h2,.rst-content .toctree-wrapper p.caption,h3{orphans:3;widows:3}h2,.rst-content .toctree-wrapper p.caption,h3{page-break-after:avoid}}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content .code-block-caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a,.wy-nav-top a{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.7.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2?v=4.7.0") format("woff2"),url("../fonts/fontawesome-webfont.woff?v=4.7.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.7.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.3333333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.2857142857em;text-align:center}.fa-ul{padding-left:0;margin-left:2.1428571429em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.1428571429em;width:2.1428571429em;top:.1428571429em;text-align:center}.fa-li.fa-lg{left:-1.8571428571em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.wy-menu-vertical li span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.rst-content .fa-pull-left.admonition-title,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content dl dt .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.rst-content code.download span.fa-pull-left:first-child,.fa-pull-left.icon{margin-right:.3em}.fa.fa-pull-right,.wy-menu-vertical li span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.rst-content .fa-pull-right.admonition-title,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content dl dt .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.rst-content code.download span.fa-pull-right:first-child,.fa-pull-right.icon{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content .code-block-caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.rst-content code.download span.pull-left:first-child,.pull-left.icon{margin-right:.3em}.fa.pull-right,.wy-menu-vertical li span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content .code-block-caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.rst-content code.download span.pull-right:first-child,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-remove:before,.fa-close:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-gear:before,.fa-cog:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-rotate-right:before,.fa-repeat:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-warning:before,.fa-exclamation-triangle:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-gears:before,.fa-cogs:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-save:before,.fa-floppy-o:before{content:""}.fa-square:before{content:""}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-unsorted:before,.fa-sort:before{content:""}.fa-sort-down:before,.fa-sort-desc:before{content:""}.fa-sort-up:before,.fa-sort-asc:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-legal:before,.fa-gavel:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-flash:before,.fa-bolt:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-paste:before,.fa-clipboard:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-unlink:before,.fa-chain-broken:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""}.fa-euro:before,.fa-eur:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-rupee:before,.fa-inr:before{content:""}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""}.fa-won:before,.fa-krw:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-turkish-lira:before,.fa-try:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-institution:before,.fa-bank:before,.fa-university:before{content:""}.fa-mortar-board:before,.fa-graduation-cap:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""}.fa-file-zip-o:before,.fa-file-archive-o:before{content:""}.fa-file-sound-o:before,.fa-file-audio-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-send:before,.fa-paper-plane:before{content:""}.fa-send-o:before,.fa-paper-plane-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-hotel:before,.fa-bed:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-yc:before,.fa-y-combinator:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-tv:before,.fa-television:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:""}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-signing:before,.fa-sign-language:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-vcard:before,.fa-address-card:before{content:""}.fa-vcard-o:before,.fa-address-card-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content .code-block-caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:"FontAwesome";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .rst-content p.caption .headerlink,.rst-content p.caption a .headerlink,a .rst-content table>caption .headerlink,.rst-content table>caption a .headerlink,a .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption a .headerlink,a .rst-content tt.download span:first-child,.rst-content tt.download a span:first-child,a .rst-content code.download span:first-child,.rst-content code.download a span:first-child,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .btn span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.btn .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .rst-content p.caption .headerlink,.rst-content p.caption .btn .headerlink,.btn .rst-content table>caption .headerlink,.rst-content table>caption .btn .headerlink,.btn .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .btn .headerlink,.btn .rst-content tt.download span:first-child,.rst-content tt.download .btn span:first-child,.btn .rst-content code.download span:first-child,.rst-content code.download .btn span:first-child,.btn .icon,.nav .fa,.nav .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand,.nav .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .rst-content p.caption .headerlink,.rst-content p.caption .nav .headerlink,.nav .rst-content table>caption .headerlink,.rst-content table>caption .nav .headerlink,.nav .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .nav .headerlink,.nav .rst-content tt.download span:first-child,.rst-content tt.download .nav span:first-child,.nav .rst-content code.download span:first-child,.rst-content code.download .nav span:first-child,.nav .icon{display:inline}.btn .fa.fa-large,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.btn .rst-content .code-block-caption .fa-large.headerlink,.rst-content .code-block-caption .btn .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .btn span.fa-large:first-child,.btn .rst-content code.download span.fa-large:first-child,.rst-content code.download .btn span.fa-large:first-child,.btn .fa-large.icon,.nav .fa.fa-large,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.nav .rst-content .code-block-caption .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.nav .rst-content code.download span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.nav .fa-large.icon{line-height:.9em}.btn .fa.fa-spin,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.btn .rst-content .code-block-caption .fa-spin.headerlink,.rst-content .code-block-caption .btn .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .btn span.fa-spin:first-child,.btn .rst-content code.download span.fa-spin:first-child,.rst-content code.download .btn span.fa-spin:first-child,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.nav .rst-content .code-block-caption .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.nav .rst-content code.download span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.wy-menu-vertical li span.btn.toctree-expand:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.rst-content code.download span.btn:first-child:before,.btn.icon:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.rst-content code.download span.btn:first-child:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.rst-content tt.download .btn-mini span:first-child:before,.btn-mini .rst-content code.download span:first-child:before,.rst-content code.download .btn-mini span:first-child:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#6ab0de;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.admonition{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo,.rst-content .wy-alert-warning.admonition{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title,.rst-content .wy-alert-warning.admonition .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.admonition{background:#e7f2fa}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition .admonition-title{background:#6ab0de}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.admonition{background:#dbfaf4}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition .admonition-title{background:#1abc9c}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.admonition{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a{color:#2980B9}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#2980B9}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980B9 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#2980B9;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#9B59B6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980B9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type="search"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 .3125em 0;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:68em;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.3576515979%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.3576515979%;width:48.821174201%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.3576515979%;width:31.7615656014%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;*overflow:visible}input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type="datetime-local"]{padding:.34375em .625em}input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}input[type="text"]:focus,input[type="password"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus{outline:0;outline:thin dotted \9;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type="radio"][disabled],input[type="checkbox"][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{position:absolute;content:"";display:block;left:0;top:0;width:36px;height:12px;border-radius:4px;background:#ccc;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{position:absolute;content:"";display:block;width:18px;height:18px;border-radius:4px;background:#999;left:-3px;top:-3px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27AE60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:.7em 0 0}.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:.3em;display:block}.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980B9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9B59B6}html{height:100%;overflow-x:hidden}body{font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#2980B9 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,.rst-content .toctree-wrapper p.caption,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2,.rst-content .toctree-wrapper p.caption{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt,.rst-content code{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:before,.wy-breadcrumbs:after{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.wy-breadcrumbs li code,.wy-breadcrumbs li .rst-content tt,.rst-content .wy-breadcrumbs li tt{padding:5px;border:none;background:none}.wy-breadcrumbs li code.literal,.wy-breadcrumbs li .rst-content tt.literal,.rst-content .wy-breadcrumbs li tt.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#3a7ca8;height:32px;display:inline-block;line-height:32px;padding:0 1.618em;margin:12px 0 0 0;display:block;font-weight:bold;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li code,.wy-menu-vertical li .rst-content tt,.rst-content .wy-menu-vertical li tt{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.on a:hover span.toctree-expand,.wy-menu-vertical li.current>a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand{display:block;font-size:.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a{color:#404040}.wy-menu-vertical li.toctree-l1.current li.toctree-l2>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>ul{display:none}.wy-menu-vertical li.toctree-l1.current li.toctree-l2.current>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current>ul{display:block}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{display:block;background:#c9c9c9;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3{font-size:.9em}.wy-menu-vertical li.toctree-l3.current>a{background:#bdbdbd;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{display:block;background:#bdbdbd;padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:normal}.wy-menu-vertical a{display:inline-block;line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980B9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980B9;text-align:center;padding:.809em;display:block;color:#fcfcfc;margin-bottom:.809em}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em auto;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-side-nav-search>a img.logo,.wy-side-nav-search .wy-dropdown>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search>a.icon img.logo,.wy-side-nav-search .wy-dropdown>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:normal;color:rgba(255,255,255,0.3)}.wy-nav .wy-menu-vertical header{color:#2980B9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980B9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980B9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:gray}footer p{margin-bottom:12px}footer span.commit code,footer span.commit .rst-content tt,.rst-content footer span.commit tt{padding:0px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;font-size:1em;background:none;border:none;color:gray}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{width:100%}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:before,.rst-breadcrumbs-buttons:after{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-side-scroll{width:auto}.wy-side-nav-search{width:auto}.wy-menu.wy-menu-vertical{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1100px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure p:last-child.caption{margin-bottom:0px}.rst-content div.figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;display:block;overflow:auto}.rst-content pre.literal-block,.rst-content div[class^='highlight']{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px 0}.rst-content pre.literal-block div[class^='highlight'],.rst-content div[class^='highlight'] div[class^='highlight']{padding:0px;border:none;margin:0}.rst-content div[class^='highlight'] td.code{width:100%}.rst-content .linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;display:block;overflow:auto}.rst-content div[class^='highlight'] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content pre.literal-block,.rst-content div[class^='highlight'] pre,.rst-content .linenodiv pre{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;font-size:12px;line-height:1.4}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^='highlight'],.rst-content div[class^='highlight'] pre{white-space:pre-wrap}}.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last,.rst-content .admonition .last{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha}.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px}.rst-content .section ol p:last-child,.rst-content .section ul p:last-child{margin-bottom:24px}.rst-content .line-block{margin-left:0px;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content .toctree-wrapper p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink{visibility:hidden;font-size:14px}.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content .toctree-wrapper p.caption .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content table>caption .headerlink:after,.rst-content .code-block-caption .headerlink:after{content:"";font-family:FontAwesome}.rst-content h1:hover .headerlink:after,.rst-content h2:hover .headerlink:after,.rst-content .toctree-wrapper p.caption:hover .headerlink:after,.rst-content h3:hover .headerlink:after,.rst-content h4:hover .headerlink:after,.rst-content h5:hover .headerlink:after,.rst-content h6:hover .headerlink:after,.rst-content dl dt:hover .headerlink:after,.rst-content p.caption:hover .headerlink:after,.rst-content table>caption:hover .headerlink:after,.rst-content .code-block-caption:hover .headerlink:after{visibility:visible}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;display:inline-block;font-weight:bold;padding:0 6px}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:baseline;position:relative;top:-0.4em;line-height:0;font-size:90%}.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none;border:none;color:gray}.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}.rst-content table.docutils.citation tt,.rst-content table.docutils.citation code,.rst-content table.docutils.footnote tt,.rst-content table.docutils.footnote code{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}.rst-content table.docutils td .last,.rst-content table.docutils td .last :last-child{margin-bottom:0}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none}.rst-content table.field-list td p{font-size:inherit;line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content tt,.rst-content tt,.rst-content code{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;padding:2px 5px}.rst-content tt big,.rst-content tt em,.rst-content tt big,.rst-content code big,.rst-content tt em,.rst-content code em{font-size:100% !important;line-height:normal}.rst-content tt.literal,.rst-content tt.literal,.rst-content code.literal{color:#E74C3C}.rst-content tt.xref,a .rst-content tt,.rst-content tt.xref,.rst-content code.xref,a .rst-content tt,a .rst-content code{font-weight:bold;color:#404040}.rst-content pre,.rst-content kbd,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace}.rst-content a tt,.rst-content a tt,.rst-content a code{color:#2980B9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold;margin-bottom:12px}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl:not(.docutils){margin-bottom:24px}.rst-content dl:not(.docutils) dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980B9;border-top:solid 3px #6ab0de;padding:6px;position:relative}.rst-content dl:not(.docutils) dt:before{color:#6ab0de}.rst-content dl:not(.docutils) dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dl dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:#555}.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dt:first-child{margin-top:0}.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) code{font-weight:bold}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname{font-weight:bold}.rst-content dl:not(.docutils) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}.rst-content dl:not(.docutils) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}.rst-content tt.download,.rst-content code.download{background:inherit;padding:inherit;font-weight:normal;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content tt.download span:first-child,.rst-content code.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-regular.eot");src:url("../fonts/Lato/lato-regular.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-regular.woff2") format("woff2"),url("../fonts/Lato/lato-regular.woff") format("woff"),url("../fonts/Lato/lato-regular.ttf") format("truetype");font-weight:400;font-style:normal}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-bold.eot");src:url("../fonts/Lato/lato-bold.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-bold.woff2") format("woff2"),url("../fonts/Lato/lato-bold.woff") format("woff"),url("../fonts/Lato/lato-bold.ttf") format("truetype");font-weight:700;font-style:normal}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-bolditalic.eot");src:url("../fonts/Lato/lato-bolditalic.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-bolditalic.woff2") format("woff2"),url("../fonts/Lato/lato-bolditalic.woff") format("woff"),url("../fonts/Lato/lato-bolditalic.ttf") format("truetype");font-weight:700;font-style:italic}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-italic.eot");src:url("../fonts/Lato/lato-italic.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-italic.woff2") format("woff2"),url("../fonts/Lato/lato-italic.woff") format("woff"),url("../fonts/Lato/lato-italic.ttf") format("truetype");font-weight:400;font-style:italic}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:400;src:url("../fonts/RobotoSlab/roboto-slab.eot");src:url("../fonts/RobotoSlab/roboto-slab-v7-regular.eot?#iefix") format("embedded-opentype"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.woff2") format("woff2"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.woff") format("woff"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.ttf") format("truetype")}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:700;src:url("../fonts/RobotoSlab/roboto-slab-v7-bold.eot");src:url("../fonts/RobotoSlab/roboto-slab-v7-bold.eot?#iefix") format("embedded-opentype"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.woff2") format("woff2"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.woff") format("woff"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.ttf") format("truetype")} diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 00000000..b33f87fc --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,314 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keyup(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box or textarea + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 00000000..6d865102 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,10 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/fonts/Lato/lato-bold.eot b/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 00000000..3361183a Binary files /dev/null and b/_static/fonts/Lato/lato-bold.eot differ diff --git a/_static/fonts/Lato/lato-bold.ttf b/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 00000000..29f691d5 Binary files /dev/null and b/_static/fonts/Lato/lato-bold.ttf differ diff --git a/_static/fonts/Lato/lato-bold.woff b/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/_static/fonts/Lato/lato-bold.woff differ diff --git a/_static/fonts/Lato/lato-bold.woff2 b/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/_static/fonts/Lato/lato-bolditalic.eot b/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 00000000..3d415493 Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/_static/fonts/Lato/lato-bolditalic.ttf b/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 00000000..f402040b Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/_static/fonts/Lato/lato-bolditalic.woff b/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/_static/fonts/Lato/lato-bolditalic.woff2 b/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/_static/fonts/Lato/lato-italic.eot b/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 00000000..3f826421 Binary files /dev/null and b/_static/fonts/Lato/lato-italic.eot differ diff --git a/_static/fonts/Lato/lato-italic.ttf b/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 00000000..b4bfc9b2 Binary files /dev/null and b/_static/fonts/Lato/lato-italic.ttf differ diff --git a/_static/fonts/Lato/lato-italic.woff b/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/_static/fonts/Lato/lato-italic.woff differ diff --git a/_static/fonts/Lato/lato-italic.woff2 b/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/_static/fonts/Lato/lato-regular.eot b/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 00000000..11e3f2a5 Binary files /dev/null and b/_static/fonts/Lato/lato-regular.eot differ diff --git a/_static/fonts/Lato/lato-regular.ttf b/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 00000000..74decd9e Binary files /dev/null and b/_static/fonts/Lato/lato-regular.ttf differ diff --git a/_static/fonts/Lato/lato-regular.woff b/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/_static/fonts/Lato/lato-regular.woff differ diff --git a/_static/fonts/Lato/lato-regular.woff2 b/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 00000000..79dc8efe Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 00000000..2f7ca78a Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/_static/fonts/fontawesome-webfont.eot b/_static/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/_static/fonts/fontawesome-webfont.eot differ diff --git a/_static/fonts/fontawesome-webfont.svg b/_static/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/_static/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/fonts/fontawesome-webfont.ttf b/_static/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/_static/fonts/fontawesome-webfont.ttf differ diff --git a/_static/fonts/fontawesome-webfont.woff b/_static/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/_static/fonts/fontawesome-webfont.woff differ diff --git a/_static/fonts/fontawesome-webfont.woff2 b/_static/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/_static/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/jquery-3.4.1.js b/_static/jquery-3.4.1.js new file mode 100644 index 00000000..773ad95c --- /dev/null +++ b/_static/jquery-3.4.1.js @@ -0,0 +1,10598 @@ +/*! + * jQuery JavaScript Library v3.4.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2019-05-01T21:04Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var document = window.document; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var concat = arr.concat; + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.4.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android <=4.0 only + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a global context + globalEval: function( code, options ) { + DOMEval( code, { nonce: options && options.nonce } ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // Support: Android <=4.0 only + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.4 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2019-04-08 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + + // ID selector + if ( (m = match[1]) ) { + + // Document context + if ( nodeType === 9 ) { + if ( (elem = context.getElementById( m )) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && (elem = newContext.getElementById( m )) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( (m = match[3]) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + (!rbuggyQSA || !rbuggyQSA.test( selector )) && + + // Support: IE 8 only + // Exclude object elements + (nodeType !== 1 || context.nodeName.toLowerCase() !== "object") ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && rdescend.test( selector ) ) { + + // Capture the context ID, setting it first if necessary + if ( (nid = context.getAttribute( "id" )) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", (nid = expando) ); + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[i] = "#" + nid + " " + toSelector( groups[i] ); + } + newSelector = groups.join( "," ); + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement("fieldset"); + + try { + return !!fn( el ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = (elem.ownerDocument || elem).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9-11, Edge + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + if ( preferredDoc !== document && + (subWindow = document.defaultView) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert(function( el ) { + el.className = "i"; + return !el.getAttribute("className"); + }); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( el ) { + el.appendChild( document.createComment("") ); + return !el.getElementsByTagName("*").length; + }); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + }); + + // ID filter and find + if ( support.getById ) { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( (elem = elems[i++]) ) { + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( el ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll("[msallowcapture^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push("~="); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push(".#.+[+~]"); + } + }); + + assert(function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement("input"); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll("[name=d]").length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll(":enabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll(":disabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( el ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + return -1; + } + if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + return a === document ? -1 : + b === document ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch (e) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return (sel + "").replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + while ( (node = elem[i++]) ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[6] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[3] ) { + match[2] = match[4] || match[5] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + // Use previously-cached element index if available + if ( useCache ) { + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + // Don't keep the element (issue #299) + input[0] = null; + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( (tokens = []) ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push({ + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + }); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push({ + value: matched, + type: type, + matches: match + }); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( (oldCache = uniqueCache[ key ]) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return (newCache[ 2 ] = oldCache[ 2 ]); + } else { + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + len = elems.length; + + if ( outermost ) { + outermostContext = context === document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + if ( !context && elem.ownerDocument !== document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context || document, xml) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( (selector = compiled.selector || selector) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert(function( el ) { + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; +}); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert(function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute("href") === "#" ; +}) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + }); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert(function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +}) ) { + addHandle( "value", function( elem, name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + }); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert(function( el ) { + return el.getAttribute("disabled") == null; +}) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + null; + } + }); +} + +return Sizzle; + +})( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( typeof elem.contentDocument !== "undefined" ) { + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + +var swap = function( elem, options, callback, args ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.apply( elem, args || [] ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // Support: IE <=9 only + option: [ 1, "" ], + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +// Support: IE <=9 only +wrapMap.optgroup = wrapMap.option; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; +} )(); + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = {}; + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + // Make a writable jQuery.Event from the native event object + var event = jQuery.event.fix( nativeEvent ); + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + /* eslint-disable max-len */ + + // See https://github.com/eslint/eslint/issues/3229 + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, + + /* eslint-enable */ + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.access( src ); + pdataCur = dataPriv.set( dest, pdataOld ); + events = pdataOld.events; + + if ( events ) { + delete pdataCur.handle; + pdataCur.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = concat.apply( [], args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + } ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html.replace( rxhtmlTag, "<$1>" ); + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + // Support: IE 9-11 only + // Also use offsetWidth/offsetHeight for when box sizing is unreliable + // We use getClientRects() to check for hidden/disconnected. + // In those cases, the computed value can be trusted to be border-box + if ( ( !support.boxSizingReliable() && isBorderBox || + val === "auto" || + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue && type !== false ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = Date.now(); + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + + +jQuery._evalUrl = function( url, options ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memaslap - Load testing and benchmarking a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memaslap - Load testing and benchmarking a server¶

+
+

SYNOPSIS¶

+

memaslap [options]

+
+
+--help¶
+
+ +
+
+MEMCACHED_SERVERS¶
+
+ +
+
+

DESCRIPTION¶

+

memaslap is a load generation and benchmark tool for memcached +servers. It generates configurable workload such as threads, concurrencies, +connections, run time, overwrite, miss rate, key size, value size, get/set +proportion, expected throughput, and so on. Furthermore, it also testss data +verification, expire-time verification, UDP, binary protocol, facebook test, +replication test, multi-get and reconnection, etc.

+

Memaslap manages network connections like memcached with +libevent. Each thread of memaslap is bound with a CPU core, all +the threads don’t communicate with each other, and there are several socket +connections in each thread. Each connection keeps key size distribution, +value size distribution, and command distribution by itself.

+

You can specify servers via the memslap --servers option or via the +environment variable MEMCACHED_SERVERS.

+
+
+

FEATURES¶

+

Memslap is developed to for the following purposes:

+

Manages network connections with libevent asynchronously.

+

Set both TCP and UDP up to use non-blocking IO.

+

Improves parallelism: higher performance in multi-threads environments.

+

Improves time efficiency: faster processing speed.

+

Generates key and value more efficiently; key size distribution and value size distribution are configurable.

+

Supports get, multi-get, and set commands; command distribution is configurable.

+

Supports controllable miss rate and overwrite rate.

+

Supports data and expire-time verification.

+

Supports dumping statistic information periodically.

+

Supports thousands of TCP connections.

+

Supports binary protocol.

+

Supports facebook test (set with TCP and multi-get with UDP) and replication test.

+
+
+

DETAILS¶

+
+

Effective implementation of network.¶

+

For memaslap, both TCP and UDP use non-blocking network IO. All +the network events are managed by libevent as memcached. The network module +of memaslap is similar to memcached. Libevent can ensure +memaslap can handle network very efficiently.

+
+
+

Effective implementation of multi-threads and concurrency¶

+

Memslap has the similar implementation of multi-threads to +memcached. Memslap creates one or more self-governed threads; +each thread is bound with one CPU core if the system testss setting CPU +core affinity.

+

In addition, each thread has a libevent to manage the events of the network; +each thread has one or more self-governed concurrencies; and each +concurrency has one or more socket connections. All the concurrencies don’t +communicate with each other even though they are in the same thread.

+

Memslap can create thousands of socket connections, and each +concurrency has tens of socket connections. Each concurrency randomly or +sequentially selects one socket connection from its socket connection pool +to run, so memaslap can ensure each concurrency handles one +socket connection at any given time. Users can specify the number of +concurrency and socket connections of each concurrency according to their +expected workload.

+
+
+

Effective implementation of generating key and value¶

+

In order to improve time efficiency and space efficiency, +memaslap creates a random characters table with 10M characters. All the +suffixes of keys and values are generated from this random characters table.

+

Memslap uses the offset in the character table and the length +of the string to identify a string. It can save much memory. +Each key contains two parts, a prefix and a suffix. The prefix is an +uint64_t, 8 bytes. In order to verify the data set before, +memaslap need to ensure each key is unique, so it uses the prefix to identify +a key. The prefix cannot include illegal characters, such as ‘r’, ‘n’, +‘0’ and ‘ ‘. And memaslap has an algorithm to ensure that.

+

Memslap doesn’t generate all the objects (key-value pairs) at +the beginning. It only generates enough objects to fill the task window +(default 10K objects) of each concurrency. Each object has the following +basic information, key prefix, key suffix offset in the character table, key +length, value offset in the character table, and value length.

+

In the work process, each concurrency sequentially or randomly selects an +object from the window to do set operation or get operation. At the same +time, each concurrency kicks objects out of its window and adds new object +into it.

+
+
+

Simple but useful task scheduling¶

+

Memslap uses libevent to schedule all the concurrencies of +threads, and each concurrency schedules tasks based on the local task +window. Memslap assumes that if each concurrency keeps the same +key distribution, value distribution and commands distribution, from +outside, memaslap keeps all the distribution as a whole. +Each task window includes a lot of objects, each object stores its basic +information, such as key, value, expire time, and so on. At any time, all +the objects in the window keep the same and fixed key and value +distribution. If an object is overwritten, the value of the object will be +updated. Memslap verifies the data or expire-time according to +the object information stored in the task window.

+

Libevent selects which concurrency to handle based on a specific network +event. Then the concurrency selects which command (get or set) to operate +based on the command distribution. If it needs to kick out an old object and +add a new object, in order to keep the same key and value distribution, the +new object must have the same key length and value length.

+

If memcached server has two cache layers (memory and SSD), running +memaslap with different window sizes can get different cache +miss rates. If memaslap adds enough objects into the windows at +the beginning, and the cache of memcached cannot store all the objects +initialized, then memaslap will get some objects from the second +cache layer. It causes the first cache layer to miss. So the user can +specify the window size to get the expected miss rate of the first cache +layer.

+
+
+

Useful implementation of multi-servers , UDP, TCP, multi-get and binary protocol¶

+

Because each thread is self-governed, memaslap can assign +different threads to handle different memcached servers. This is just one of +the ways in which memaslap tests multiple servers. The only +limitation is that the number of servers cannot be greater than the number +of threads. The other way to test multiple servers is for replication +test. Each concurrency has one socket connection to each memcached server. +For the implementation, memaslap can set some objects to one +memcached server, and get these objects from the other servers.

+

By default, Memslap does single get. If the user specifies +multi-get option, memaslap will collect enough get commands and +pack and send the commands together.

+

Memslap testss both the ASCII protocol and binary protocol, +but it runs on the ASCII protocol by default. +Memslap by default runs on the TCP protocol, but it also +tests UDP. Because UDP is unreliable, dropped packages and out-of-order +packages may occur. Memslap creates a memory buffer to handle +these problems. Memslap tries to read all the response data of +one command from the server and reorders the response data. If some packages +get lost, the waiting timeout mechanism can ensure half-baked packages will +be discarded and the next command will be sent.

+
+
+
+

USAGE¶

+

Below are some usage samples:

+

memaslap -s 127.0.0.1:11211 -S 5s

+

memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40

+

memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m

+

memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2

+

The user must specify one server at least to run memaslap. The +rest of the parameters have default values, as shown below:

+

Thread number = 1 Concurrency = 16

+

Run time = 600 seconds Configuration file = NULL

+

Key size = 64 Value size = 1024

+

Get/set = 9:1 Window size = 10k

+

Execute number = 0 Single get = true

+

Multi-get = false Number of sockets of each concurrency = 1

+

Reconnect = false Data verification = false

+

Expire-time verification = false ASCII protocol = true

+

Binary protocol = false Dumping statistic information

+

periodically = false

+

Overwrite proportion = 0% UDP = false

+

TCP = true Limit throughput = false

+

Facebook test = false Replication test = false

+
+

Key size, value size and command distribution.¶

+

All the distributions are read from the configuration file specified by user +with “—cfg_cmd” option. If the user does not specify a configuration file, +memaslap will run with the default distribution (key size = 64, +value size = 1024, get/set = 9:1). For information on how to edit the +configuration file, refer to the “Configuration File” section.

+

The minimum key size is 16 bytes; the maximum key size is 250 bytes. The +precision of proportion is 0.001. The proportion of distribution will be +rounded to 3 decimal places.

+

The minimum value size is 1 bytes; the maximum value size is 1M bytes. The +precision of proportion is 0.001. The proportion of distribution will be +rounded to 3 decimal places. +Currently, memaslap only testss set and get commands. And it +testss 100% set and 100% get. For 100% get, it will preset some objects to +the server.

+
+
+

Multi-thread and concurrency¶

+

The high performance of memaslap benefits from the special +schedule of thread and concurrency. It’s important to specify the proper +number of them. The default number of threads is 1; the default number of +concurrency is 16. The user can use “—threads” and “–concurrency” to +specify these variables.

+

If the system tests setting CPU affinity and the number of threads +specified by the user is greater than 1, memaslap will try to +bind each thread to a different CPU core. So if you want to get the best +performance memaslap, it is better to specify the number of +thread equal to the number of CPU cores. The number of threads specified by +the user can also be less or greater than the number of CPU cores. Because +of the limitation of implementation, the number of concurrencies could be +the multiple of the number of threads.

+
    +

  1. For 8 CPU cores system

    2. +
+

For example:

+

–threads=2 –concurrency=128

+

–threads=8 –concurrency=128

+

–threads=8 –concurrency=256

+

–threads=12 –concurrency=144

+
    +

  1. For 16 CPU cores system

    2. +
+

For example:

+

–threads=8 –concurrency=128

+

–threads=16 –concurrency=256

+

–threads=16 –concurrency=512

+

–threads=24 –concurrency=288

+

The memaslap performs very well, when +used to test the performance of memcached servers. +Most of the time, the bottleneck is the network or +the server. If for some reason the user wants to +limit the performance of memaslap, there +are two ways to do this:

+

Decrease the number of threads and concurrencies. +Use the option “–tps” that memaslap +provides to limit the throughput. This option allows +the user to get the expected throughput. For +example, assume that the maximum throughput is 50 +kops/s for a specific configuration, you can specify +the throughput equal to or less than the maximum +throughput using “–tps” option.

+
+
+

Window size¶

+

Most of the time, the user does not need to specify the window size. The +default window size is 10k. For Schooner Memcached, the user can specify +different window sizes to get different cache miss rates based on the test +case. Memslap testss cache miss rate between 0% and 100%. +If you use this utility to test the performance of Schooner Memcached, you +can specify a proper window size to get the expected cache miss rate. The +formula for calculating window size is as follows:

+

Assume that the key size is 128 bytes, and the value size is 2048 bytes, and +concurrency=128.

+

1. Small cache cache_size=1M, 100% cache miss (all data get from SSD). +win_size=10k

+
    +

  1. cache_size=4G

    2. +
+

(1). cache miss rate 0%

+

win_size=8k

+

(2). cache miss rate 5%

+

win_size=11k

+
    +

  1. cache_size=16G

    2. +
+

(1). cache miss rate 0%

+

win_size=32k

+

(2). cache miss

+

rate 5%

+

win_size=46k

+

The formula for calculating window size for cache miss rate 0%:

+

cache_size / concurrency / (key_size + value_size) * 0.5

+

The formula for calculating window size for cache miss rate 5%:

+

cache_size / concurrency / (key_size + value_size) * 0.7

+
+
+

Verification¶

+

Memslap testss both data verification and expire-time +verification. The user can use “–verify=” or “-v” to specify the proportion +of data verification. In theory, it testss 100% data verification. The +user can use “–exp_verify=” or “-e” to specify the proportion of +expire-time verification. In theory, it testss 100% expire-time +verification. Specify the “–verbose” options to get more detailed error +information.

+

For example: –exp_verify=0.01 –verify=0.1 , it means that 1% of the objects +set with expire-time, 10% of the objects gotten will be verified. If the +objects are gotten, memaslap will verify the expire-time and +value.

+
+
+

multi-servers and multi-config¶

+

Memslap testss multi-servers based on self-governed thread. +There is a limitation that the number of servers cannot be greater than the +number of threads. Memslap assigns one thread to handle one +server at least. The user can use the “–servers=” or “-s” option to specify +multi-servers.

+

For example:

+

–servers=10.1.1.1:11211,10.1.1.2:11212,10.1.1.3:11213 –threads=6 –concurrency=36

+

The above command means that there are 6 threads, with each thread having 6 +concurrencies and that threads 0 and 3 handle server 0 (10.1.1.1); threads 1 +and 4 handle server 1 (10.1.1.2); and thread 2 and 5 handle server 2 +(10.1.1.3).

+

All the threads and concurrencies in memaslap are self-governed.

+

So is memaslap. The user can start up several +memaslap instances. The user can run memaslap on different client +machines to communicate with the same memcached server at the same. It is +recommended that the user start different memaslap on different +machines using the same configuration.

+
+
+

Run with execute number mode or time mode¶

+

The default memaslap runs with time mode. The default run time +is 10 minutes. If it times out, memaslap will exit. Do not +specify both execute number mode and time mode at the same time; just +specify one instead.

+

For example:

+

–time=30s (It means the test will run 30 seconds.)

+

–execute_number=100000 (It means that after running 100000 commands, the test will exit.)

+
+
+

Dump statistic information periodically.¶

+

The user can use “–stat_freq=” or “-S” to specify the frequency.

+

For example:

+

–stat_freq=20s

+

Memslap will dump the statistics of the commands (get and set) at the frequency of every 20 +seconds.

+

For more information on the format of dumping statistic information, refer to “Format of Output” section.

+
+
+

Multi-get¶

+

The user can use “–division=” or “-d” to specify multi-get keys count. +Memslap by default does single get with TCP. Memslap also testss data +verification and expire-time verification for multi-get.

+

Memslap testss multi-get with both TCP and UDP. Because of +the different implementation of the ASCII protocol and binary protocol, +there are some differences between the two. For the ASCII protocol, +memaslap sends one “multi-get” to the server once. For the +binary protocol, memaslap sends several single get commands +together as “multi-get” to the server.

+
+
+

UDP and TCP¶

+

Memslap testss both UDP and TCP. For TCP, +memaslap does not reconnect the memcached server if socket connections are +lost. If all the socket connections are lost or memcached server crashes, +memaslap will exit. If the user specifies the “–reconnect” +option when socket connections are lost, it will reconnect them.

+

User can use “–udp” to enable the UDP feature, but UDP comes with some +limitations:

+

UDP cannot set data more than 1400 bytes.

+

UDP is not testsed by the binary protocol because the binary protocol of +memcached does not tests that.

+

UDP doesn’t tests reconnection.

+
+
+

Facebook test¶

+

Set data with TCP and multi-get with UDP. Specify the following options:

+

“–facebook –division=50”

+

If you want to create thousands of TCP connections, specify the

+

“–conn_sock=” option.

+

For example: –facebook –division=50 –conn_sock=200

+

The above command means that memaslap will do facebook test, +each concurrency has 200 socket TCP connections and one UDP socket.

+

Memslap sets objects with the TCP socket, and multi-gets 50 +objects once with the UDP socket.

+

If you specify “–division=50”, the key size must be less that 25 bytes +because the UDP packet size is 1400 bytes.

+
+
+

Replication test¶

+

For replication test, the user must specify at least two memcached servers. +The user can use “—rep_write=” option to enable feature.

+

For example:

+

–servers=10.1.1.1:11211,10.1.1.2:11212 –rep_write=2

+

The above command means that there are 2 replication memcached servers, +memaslap will set objects to both server 0 and server 1, get +objects which are set to server 0 before from server 1, and also get objects +which are set to server 1 before from server 0. If server 0 crashes, +memaslap will only get objects from server 1. If server 0 comes +back to life again, memaslap will reconnect server 0. If both +server 0 and server 1 crash, memaslap will exit.

+
+
+

Supports thousands of TCP connections¶

+

Start memaslap with “–conn_sock=” or “-n” to enable this +feature. Make sure that your system can tests opening thousands of files +and creating thousands of sockets. However, this feature does not tests +reconnection if sockets disconnect.

+

For example:

+

–threads=8 –concurrency=128 –conn_sock=128

+

The above command means that memaslap starts up 8 threads, each +thread has 16 concurrencies, each concurrency has 128 TCP socket +connections, and the total number of TCP socket connections is 128 * 128 = +16384.

+
+
+

Supports binary protocol¶

+

Start memaslap with “–binary” or “-B” options to enable this +feature. It testss all the above features except UDP, because the latest +memcached 1.3.3 does not implement binary UDP protocol.

+

For example:

+

–binary

+

Since memcached 1.3.3 doesn’t implement binary UDP protocol, +memaslap does not tests UDP. In addition, memcached 1.3.3 does not tests +multi-get. If you specify “–division=50” option, it just sends 50 get +commands together as “mulit-get” to the server.

+
+
+
+

Configuration file¶

+

This section describes the format of the configuration file. By default +when no configuration file is specified memaslap reads the default +one located at ~/.memaslap.cnf.

+

Below is a sample configuration file:

+
---------------------------------------------------------------------------
+#comments should start with '#'
+#key
+#start_len end_len proportion
+#
+#key length range from start_len to end_len
+#start_len must be equal to or greater than 16
+#end_len must be equal to or less than 250
+#start_len must be equal to or greater than end_len
+#memaslap will generate keys according to the key range
+#proportion: indicates keys generated from one range accounts for the total
+generated keys
+#
+#example1: key range 16~100 accounts for 80%
+#          key range 101~200 accounts for 10%
+#          key range 201~250 accounts for 10%
+#          total should be 1 (0.8+0.1+0.1 = 1)
+#
+#          16 100 0.8
+#          101 200 0.1
+#          201 249 0.1
+#
+#example2: all keys length are 128 bytes
+#
+#          128 128 1
+key
+128 128 1
+#value
+#start_len end_len proportion
+#
+#value length range from start_len to end_len
+#start_len must be equal to or greater than 1
+#end_len must be equal to or less than 1M
+#start_len must be equal to or greater than end_len
+#memaslap will generate values according to the value range
+#proportion: indicates values generated from one range accounts for the
+total generated values
+#
+#example1: value range 1~1000 accounts for 80%
+#          value range 1001~10000 accounts for 10%
+#          value range 10001~100000 accounts for 10%
+#          total should be 1 (0.8+0.1+0.1 = 1)
+#
+#          1 1000 0.8
+#          1001 10000 0.1
+#          10001 100000 0.1
+#
+#example2: all value length are 128 bytes
+#
+#          128 128 1
+value
+2048 2048 1
+#cmd
+#cmd_type cmd_proportion
+#
+#currently memaslap only testss get and set command.
+#
+#cmd_type
+#set     0
+#get     1
+#
+#example: set command accounts for 50%
+#         get command accounts for 50%
+#         total should be 1 (0.5+0.5 = 1)
+#
+#         cmd
+#         0    0.5
+#         1    0.5
+cmd
+0    0.1
+1.0 0.9
+
+
+
+
+

Format of output¶

+

At the beginning, memaslap displays some configuration information as follows:

+

servers : 127.0.0.1:11211

+

threads count: 1

+

concurrency: 16

+

run time: 20s

+

windows size: 10k

+

set proportion: set_prop=0.10

+

get proportion: get_prop=0.90

+
+

Where¶

+

servers : “servers”

+
+

The servers used by memaslap.

+
+

threads count

+
+

The number of threads memaslap runs with.

+
+

concurrency

+
+

The number of concurrencies memaslap runs with.

+
+

run time

+
+

How long to run memaslap.

+
+

windows size

+
+

The task window size of each concurrency.

+
+

set proportion

+
+

The proportion of set command.

+
+

get proportion

+
+

The proportion of get command.

+
+

The output of dynamic statistics is something like this:

+
---------------------------------------------------------------------------------------------------------------------------------
+Get Statistics
+Type  Time(s)  Ops   TPS(ops/s)  Net(M/s)  Get_miss  Min(us)  Max(us)
+Avg(us)  Std_dev    Geo_dist
+Period   5   345826  69165     65.3      0         27      2198     203
+95.43      177.29
+Global  20  1257935  62896     71.8      0         26      3791     224
+117.79     192.60
+
+
+Set Statistics
+Type  Time(s)  Ops   TPS(ops/s)  Net(M/s)  Get_miss  Min(us)  Max(us)
+Avg(us)  Std_dev    Geo_dist
+Period   5    38425   7685      7.3       0         42      628     240
+88.05      220.21
+Global   20   139780  6989      8.0       0         37      3790    253
+117.93     224.83
+
+
+Total Statistics
+Type  Time(s)  Ops   TPS(ops/s)  Net(M/s)  Get_miss  Min(us)  Max(us)
+Avg(us)  Std_dev    Geo_dist
+Period   5   384252   76850     72.5      0        27      2198     207
+94.72      181.18
+Global  20  1397720   69886     79.7      0        26      3791     227
+117.93     195.60
+---------------------------------------------------------------------------------------------------------------------------------
+
+
+
+
+

Where¶

+

Get Statistics

+
+

Statistics information of get command

+
+

Set Statistics

+
+

Statistics information of set command

+
+

Total Statistics

+
+

Statistics information of both get and set command

+
+

Period

+
+

Result within a period

+
+

Global

+
+

Accumulated results

+
+

Ops

+
+

Total operations

+
+

TPS

+
+

Throughput, operations/second

+
+

Net

+
+

The rate of network

+
+

Get_miss

+
+

How many objects can’t be gotten

+
+

Min

+
+

The minimum response time

+
+

Max

+
+

The maximum response time

+
+

Avg:

+
+

The average response time

+
+

Std_dev

+
+

Standard deviation of response time

+
+

Geo_dist

+
+

Geometric distribution based on natural exponential function

+
+

At the end, memaslap will output something like this:

+
---------------------------------------------------------------------------------------------------------------------------------
+Get Statistics (1257956 events)
+  Min:        26
+  Max:      3791
+  Avg:       224
+  Geo:    192.60
+  Std:    116.23
+                  Log2 Dist:
+                    4:        0       10    84490   215345
+                    8:   484890   459823    12543      824
+                   12:       31
+
+ Set Statistics (139782 events)
+    Min:        37
+    Max:      3790
+    Avg:       253
+    Geo:    224.84
+    Std:    116.83
+    Log2 Dist:
+      4:        0        0     4200 16988
+      8:    50784    65574 2064      167
+      12:        5
+
+  Total Statistics (1397738 events)
+      Min:        26
+      Max:      3791
+      Avg:       227
+      Geo:    195.60
+      Std:    116.60
+      Log2 Dist:
+        4:        0       10    88690   232333
+        8:   535674   525397    14607      991
+        12:       36
+
+cmd_get: 1257969
+cmd_set: 139785
+get_misses: 0
+verify_misses: 0
+verify_failed: 0
+expired_get: 0
+unexpired_unget: 0
+written_bytes: 242516030
+read_bytes: 1003702556
+object_bytes: 152086080
+packet_disorder: 0
+packet_drop: 0
+udp_timeout: 0
+
+Run time: 20.0s Ops: 1397754 TPS: 69817 Net_rate: 59.4M/s
+---------------------------------------------------------------------------------------------------------------------------------
+
+
+
+
+

Where¶

+

Get Statistics

+
+

Get statistics of response time

+
+

Set Statistics

+
+

Set statistics of response time

+
+

Total Statistics

+
+

Both get and set statistics of response time

+
+

Min

+
+

The accumulated and minimum response time

+
+

Max

+
+

The accumulated and maximum response time

+
+

Avg

+
+

The accumulated and average response time

+
+

Std

+
+

Standard deviation of response time

+
+

Log2 Dist

+
+

Geometric distribution based on logarithm 2

+
+

cmd_get

+
+

Total get commands done

+
+

cmd_set

+
+

Total set commands done

+
+

get_misses

+
+

How many objects can’t be gotten from server

+
+

verify_misses

+
+

How many objects need to verify but can’t get them

+
+

verify_failed

+
+

How many objects with insistent value

+
+

expired_get

+
+

How many objects are expired but we get them

+
+

unexpired_unget

+
+

How many objects are unexpired but we can’t get them

+
+

written_bytes

+
+

Total written bytes

+
+

read_bytes

+
+

Total read bytes

+
+

object_bytes

+
+

Total object bytes

+
+

packet_disorder

+
+

How many UDP packages are disorder

+
+

packet_drop

+
+

How many UDP packages are lost

+
+

udp_timeout

+
+

How many times UDP time out happen

+
+

Run time

+
+

Total run time

+
+

Ops

+
+

Total operations

+
+

TPS

+
+

Throughput, operations/second

+
+

Net_rate

+
+

The average rate of network

+
+
+
+
+

OPTIONS¶

+
+
-s, –servers=

List one or more servers to connect. Servers count must be less than +threads count. e.g.: –servers=localhost:1234,localhost:11211

+
+
-T, –threads=

Number of threads to startup, better equal to CPU numbers. Default 8.

+
+
-c, –concurrency=

Number of concurrency to simulate with load. Default 128.

+
+
-n, –conn_sock=

Number of TCP socks per concurrency. Default 1.

+
+
-x, –execute_number=

Number of operations(get and set) to execute for the +given test. Default 1000000.

+
+
-t, –time=

How long the test to run, suffix: s-seconds, m-minutes, h-hours, +d-days e.g.: –time=2h.

+
+
-F, –cfg_cmd=

Load the configure file to get command,key and value distribution list.

+
+
-w, –win_size=

Task window size of each concurrency, suffix: K, M e.g.: –win_size=10k. +Default 10k.

+
+
-X, –fixed_size=

Fixed length of value.

+
+
-v, –verify=

The proportion of date verification, e.g.: –verify=0.01

+
+
-d, –division=

Number of keys to multi-get once. Default 1, means single get.

+
+
-S, –stat_freq=

Frequency of dumping statistic information. suffix: s-seconds, +m-minutes, e.g.: –resp_freq=10s.

+
+
-e, –exp_verify=

The proportion of objects with expire time, e.g.: –exp_verify=0.01. +Default no object with expire time

+
+
-o, –overwrite=

The proportion of objects need overwrite, e.g.: –overwrite=0.01. +Default never overwrite object.

+
+
+
+
-R, --reconnect
+

Reconnect tests, when connection is closed it will be reconnected.

+
+
-U, --udp
+

UDP tests, default memaslap uses TCP, TCP port and UDP port of +server must be same.

+
+
-a, --facebook
+

Whether it enables facebook test feature, set with TCP and multi-get with UDP.

+
+
-B, --binary
+

Whether it enables binary protocol. Default with ASCII protocol.

+
+
+
+
-P, –tps=

Expected throughput, suffix: K, e.g.: –tps=10k.

+
+
-p, –rep_write=

The first nth servers can write data, e.g.: –rep_write=2.

+
+
+
+
-b, --verbose
+

Whether it outputs detailed information when verification fails.

+
+
-h, --help
+

Display this message and then exit.

+
+
-V, --version
+

Display the version of the application and then exit.

+
+
+
+
+

EXAMPLES¶

+

memaslap -s 127.0.0.1:11211 -S 5s

+

memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40

+

memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m

+

memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHORS¶

+

Mingqiang Zhuang <mingqiangzhuang@hengtiansoft.com> (Schooner Technolgy) +Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memcapable.html b/bin/memcapable.html new file mode 100644 index 00000000..c40774ff --- /dev/null +++ b/bin/memcapable.html @@ -0,0 +1,801 @@ + + + + + + + + + + + memcapable - Checking a Memcached server capibilities and compatibility — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memcapable - Checking a Memcached server capibilities and compatibility
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memcapable - Checking a Memcached server capibilities and compatibility¶

+
+

SYNOPSIS¶

+

memcapable [options]

+
+
+

DESCRIPTION¶

+

memcapable connects to the specified memcached server and tries to +determine its capabilities by running the various commands and verifying +the response.

+
+
+

LIMITATIONS¶

+

The current version of memcapable will only verify the binary protocol.

+
+
+

OPTIONS¶

+
+
+-h hostname¶
+
+ +

Specify the hostname to connect to. The default is localhost

+
+
+-p port¶
+
+ +

Specify the port number to connect to. The default is 11211

+
+
+-c¶
+
+ +

Generate a coredump when it detects an error from the server.

+
+
+-v¶
+
+ +

Print out the comparison when it detects an error from the server.

+
+
+-t n¶
+
+ +

Set the timeout from an IO operation to/from the server to n seconds.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Trond Norbye, <trond.norbye@gmail.com>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memcat.html b/bin/memcat.html new file mode 100644 index 00000000..eb41dca3 --- /dev/null +++ b/bin/memcat.html @@ -0,0 +1,787 @@ + + + + + + + + + + + memcat - “cat” data from a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memcat - “cat” data from a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memcat - “cat” data from a server¶

+
+

SYNOPSIS¶

+

memcat [options] key

+

Copy a set of keys to stdout

+
+
+

DESCRIPTION¶

+

memcat outputs to stdout the value a single or multiple set of keys +stored in a memcached(1) server. If any key is not found an error is returned.

+

It is similar to the standard UNIX cat(1) utility.

+
+
+

OPTIONS¶

+

You can specify servers via the option:

+
+
+--servers¶
+
+ +

or via the environment variable:

+
+
+`MEMCACHED_SERVERS`¶
+
+ +

For a full list of operations run the tool with the option:

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+

Mark Atwood <mark@fallenpegasus.com>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memcp.html b/bin/memcp.html new file mode 100644 index 00000000..6e3aa964 --- /dev/null +++ b/bin/memcp.html @@ -0,0 +1,789 @@ + + + + + + + + + + + memcp - Copy data to a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memcp - Copy data to a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memcp - Copy data to a server¶

+

Copies files to a collection of memcached servers

+
+

SYNOPSIS¶

+

memcp [options] [file] [server]

+
+
+

DESCRIPTION¶

+

memcp copies one or more files into memcached(1) servers. +It is similar to the standard UNIX cp(1) command.

+

The key names will be the names of the files, +without any directory path.

+
+
+

OPTIONS¶

+

You can specify servers via the option:

+
+
+--servers¶
+
+ +

or via the environment variable:

+
+
+`MEMCACHED_SERVERS`¶
+
+ +

If you do not specify either these, the final value in the command line list is the name of a server(s).

+

For a full list of operations run the tool with the option:

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+

Mark Atwood, <mark@fallenpegasus.com>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memdump.html b/bin/memdump.html new file mode 100644 index 00000000..12e1d805 --- /dev/null +++ b/bin/memdump.html @@ -0,0 +1,774 @@ + + + + + + + + + + + memdump - Dumping your server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memdump - Dumping your server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memdump - Dumping your server¶

+

Dump a list of keys from a server.

+
+

SYNOPSIS¶

+

memdump [options]

+
+
+

DESCRIPTION¶

+

memdump dumps a list of “keys” from all servers that +it is told to fetch from. Because memcached does not guarentee to +provide all keys it is not possible to get a complete “dump”.

+
+
+

OPTIONS¶

+

For a full list of operations run the tool with option:

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memerror.html b/bin/memerror.html new file mode 100644 index 00000000..aab50b24 --- /dev/null +++ b/bin/memerror.html @@ -0,0 +1,773 @@ + + + + + + + + + + + memerror - translate an error code to a string — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memerror - translate an error code to a string
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memerror - translate an error code to a string¶

+

Translates a memcached error code into a string

+
+

SYNOPSIS¶

+

memerror [options] [error code]

+
+
+

DESCRIPTION¶

+

memerror translates an error code from libmemcached(3) into a human +readable string.

+
+
+

OPTIONS¶

+

For a full list of operations run the tool with option:

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more infoerroration please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memexist.html b/bin/memexist.html new file mode 100644 index 00000000..f94d77ab --- /dev/null +++ b/bin/memexist.html @@ -0,0 +1,784 @@ + + + + + + + + + + + memexist - Check for the existance of a key — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memexist - Check for the existance of a key
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memexist - Check for the existance of a key¶

+
+

SYNOPSIS¶

+

memexist [options] [key]

+
+
+

DESCRIPTION¶

+

memexist checks for the existance of a key within a cluster.

+
+
+

OPTIONS¶

+

You can specify servers via the option:

+
+
+--servers¶
+
+ +

or via the environment variable:

+
+
+`MEMCACHED_SERVERS`¶
+
+ +

If you do not specify either these, the final value in the command line list is the name of a server(s).

+

For a full list of operations run the tool with the option:

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memflush.html b/bin/memflush.html new file mode 100644 index 00000000..e65aef5f --- /dev/null +++ b/bin/memflush.html @@ -0,0 +1,786 @@ + + + + + + + + + + + memflush - flush all data from a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memflush - flush all data from a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memflush - flush all data from a server¶

+

Reset a server or list of servers

+
+

SYNOPSIS¶

+

memflush [options]

+
+
+

DESCRIPTION¶

+

memflush resets the contents of memcached(1) servers. +This means that all data in the specified servers will be deleted.

+
+
+

OPTIONS¶

+

You can specify servers via the option:

+
+
+--servers¶
+
+ +

or via the environment variable:

+
+
+`MEMCACHED_SERVERS`¶
+
+ +

For a full list of operations run the tool with option:

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+

Mark Atwood <mark@fallenpegasus.com>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memparse.html b/bin/memparse.html new file mode 100644 index 00000000..8f5b9b9a --- /dev/null +++ b/bin/memparse.html @@ -0,0 +1,772 @@ + + + + + + + + + + + memparse - Parse an option string — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memparse - Parse an option string
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memparse - Parse an option string¶

+

Used to validate an option string

+
+

SYNOPSIS¶

+

memparse [options] “option string”

+
+
+

DESCRIPTION¶

+

memparse can be used to validate an option string.

+
+
+

OPTIONS¶

+

For a full list of operations run the tool with the option:

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memping.html b/bin/memping.html new file mode 100644 index 00000000..7cf27c38 --- /dev/null +++ b/bin/memping.html @@ -0,0 +1,784 @@ + + + + + + + + + + + memping - Test to see if a server is available. — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memping - Test to see if a server is available.
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memping - Test to see if a server is available.¶

+
+

SYNOPSIS¶

+

memping [options] [server]

+
+
+

DESCRIPTION¶

+

memping can be used to ping a memcached server to see if it is taking connections.

+
+
+

OPTIONS¶

+

You can specify servers via the option:

+
+
+--servers¶
+
+ +

or via the environment variable:

+
+
+`MEMCACHED_SERVERS`¶
+
+ +

If you do not specify either these, the final value in the command line list is the name of a server(s).

+

For a full list of operations run the tool with the option:

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memrm.html b/bin/memrm.html new file mode 100644 index 00000000..9ffd62d7 --- /dev/null +++ b/bin/memrm.html @@ -0,0 +1,785 @@ + + + + + + + + + + + memrm - Remove data from a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memrm - Remove data from a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memrm - Remove data from a server¶

+

memrm - Remove a key(s) from a collection of memcached servers

+
+

SYNOPSIS¶

+

memrm [options] [key]

+
+
+

DESCRIPTION¶

+

memrm removes items, specified by key, from memcached(1) servers.

+
+
+

OPTIONS¶

+

You can specify servers via the option:

+
+
+--servers¶
+
+ +

or via the environment variable:

+
+
+`MEMCACHED_SERVERS`¶
+
+ +

For a full list of operations run the tool with the

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+

Mark Atwood, <mark@fallenpegasus.com>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memslap.html b/bin/memslap.html new file mode 100644 index 00000000..6e9fbaa9 --- /dev/null +++ b/bin/memslap.html @@ -0,0 +1,784 @@ + + + + + + + + + + + memslap - Load testing and benchmarking a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memslap - Load testing and benchmarking a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memslap - Load testing and benchmarking a server¶

+
+

SYNOPSIS¶

+

memslap [options]

+
+
+

DESCRIPTION¶

+

memslap is a load generation and benchmark tool for memcached(1) +servers. It generates configurable workload such as threads, concurrencies, connections, run time, overwrite, miss rate, key size, value size, get/set proportion, expected throughput, and so on.

+
+
+

OPTIONS¶

+

You can specify servers via the option:

+
+
+--servers¶
+
+ +

or via the environment variable:

+
+
+`MEMCACHED_SERVERS`¶
+
+ +

For a full list of operations run the tool with:

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +‘http://libmemcached.org/ <http://libmemcached.org/>’_

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memstat.html b/bin/memstat.html new file mode 100644 index 00000000..ad79009c --- /dev/null +++ b/bin/memstat.html @@ -0,0 +1,787 @@ + + + + + + + + + + + memstat - Gather statistics from a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memstat - Gather statistics from a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memstat - Gather statistics from a server¶

+

memstat - Display the operating status of a single or group of memcached servers

+
+

SYNOPSIS¶

+

memstat [options]

+
+
+

DESCRIPTION¶

+

memstat dumps the state of memcached(1) servers. +It displays all data to stdout.

+
+
+

OPTIONS¶

+

You can specify servers via the option:

+
+
+--servers¶
+
+ +

or via the environment variable:

+
+
+'MEMCACHED_SERVERS, --args'¶
+
+ +

which can be used to specify the “argument” sent to the stats command (ie slab, size, items, etc..).

+

For a full list of operations run the tool with:

+
+
+--help¶
+
+ +
+
+--analyze¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/memtouch.html b/bin/memtouch.html new file mode 100644 index 00000000..98fc29f7 --- /dev/null +++ b/bin/memtouch.html @@ -0,0 +1,784 @@ + + + + + + + + + + + memtouch - Touches a key. — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memtouch - Touches a key.
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memtouch - Touches a key.¶

+
+

SYNOPSIS¶

+

memtouch [options] key

+
+
+

DESCRIPTION¶

+

memtouch does a “touch” on the specified key.

+
+
+

OPTIONS¶

+

You can specify servers via the option:

+
+
+--servers¶
+
+ +

or via the environment variable:

+
+
+`MEMCACHED_SERVERS`¶
+
+ +

If you do not specify either these, the final value in the command line list is the name of a server(s).

+

For a full list of operations run the tool with the option:

+
+
+--help¶
+
+ +
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_AUTH_CONTINUE.html b/client_errors/MEMCACHED_AUTH_CONTINUE.html new file mode 100644 index 00000000..9d4a3187 --- /dev/null +++ b/client_errors/MEMCACHED_AUTH_CONTINUE.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_AUTH_CONTINUE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_AUTH_CONTINUE¶

+
+
+MEMCACHED_AUTH_CONTINUE¶
+
+ +

Authentication has been paused.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_AUTH_FAILURE.html b/client_errors/MEMCACHED_AUTH_FAILURE.html new file mode 100644 index 00000000..d91aab50 --- /dev/null +++ b/client_errors/MEMCACHED_AUTH_FAILURE.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_AUTH_FAILURE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_AUTH_FAILURE¶

+
+
+MEMCACHED_AUTH_FAILURE¶
+
+ +

The credentials provided are not valid for this server.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_AUTH_PROBLEM.html b/client_errors/MEMCACHED_AUTH_PROBLEM.html new file mode 100644 index 00000000..c6cd6411 --- /dev/null +++ b/client_errors/MEMCACHED_AUTH_PROBLEM.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_AUTH_PROBLEM — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_AUTH_PROBLEM¶

+
+
+MEMCACHED_AUTH_PROBLEM¶
+
+ +

An unknown issue has occured during authentication.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_BAD_KEY_PROVIDED.html b/client_errors/MEMCACHED_BAD_KEY_PROVIDED.html new file mode 100644 index 00000000..86f1156a --- /dev/null +++ b/client_errors/MEMCACHED_BAD_KEY_PROVIDED.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_BAD_KEY_PROVIDED — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_BAD_KEY_PROVIDED¶

+
+
+MEMCACHED_BAD_KEY_PROVIDED¶
+
+ +

The key provided is not a valid key.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_BUFFERED.html b/client_errors/MEMCACHED_BUFFERED.html new file mode 100644 index 00000000..576c2f3b --- /dev/null +++ b/client_errors/MEMCACHED_BUFFERED.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_BUFFERED — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_BUFFERED¶

+
+
+MEMCACHED_BUFFERED¶
+
+ +

The request has been buffered.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_CLIENT_ERROR.html b/client_errors/MEMCACHED_CLIENT_ERROR.html new file mode 100644 index 00000000..7404d89e --- /dev/null +++ b/client_errors/MEMCACHED_CLIENT_ERROR.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_CLIENT_ERROR — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_CLIENT_ERROR¶

+
+
+MEMCACHED_CLIENT_ERROR¶
+
+ +

An unknown client error has occured internally.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.html b/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.html new file mode 100644 index 00000000..f9879f31 --- /dev/null +++ b/client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.html @@ -0,0 +1,752 @@ + + + + + + + + + + + MEMCACHED_CONNECTION_BIND_FAILURE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_CONNECTION_BIND_FAILURE¶

+
+
+MEMCACHED_CONNECTION_BIND_FAILURE¶
+
+ +
+

Deprecated since version <0.30.

+
+

We were not able to bind() to the socket.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_CONNECTION_FAILURE.html b/client_errors/MEMCACHED_CONNECTION_FAILURE.html new file mode 100644 index 00000000..704d0956 --- /dev/null +++ b/client_errors/MEMCACHED_CONNECTION_FAILURE.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_CONNECTION_FAILURE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_CONNECTION_FAILURE¶

+
+
+MEMCACHED_CONNECTION_FAILURE¶
+
+ +

A unknown error has occured while trying to connect to a server.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.html b/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.html new file mode 100644 index 00000000..e48f10ae --- /dev/null +++ b/client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.html @@ -0,0 +1,752 @@ + + + + + + + + + + + MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE¶

+
+
+MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE¶
+
+ +
+

Deprecated since version <0.30.

+
+

An error has occurred while trying to connect to a server. It is likely that either the number of file descriptors need to be increased or you are out of memory.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.html b/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.html new file mode 100644 index 00000000..df36a144 --- /dev/null +++ b/client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_DATA_DOES_NOT_EXIST — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_DATA_DOES_NOT_EXIST¶

+
+
+MEMCACHED_DATA_DOES_NOT_EXIST¶
+
+ +

The data requested with the key given was not found.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_DATA_EXISTS.html b/client_errors/MEMCACHED_DATA_EXISTS.html new file mode 100644 index 00000000..a01a98d0 --- /dev/null +++ b/client_errors/MEMCACHED_DATA_EXISTS.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_DATA_EXISTS — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_DATA_EXISTS¶

+
+
+MEMCACHED_DATA_EXISTS¶
+
+ +

The data requested with the key given was not found.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_DELETED.html b/client_errors/MEMCACHED_DELETED.html new file mode 100644 index 00000000..63f98a99 --- /dev/null +++ b/client_errors/MEMCACHED_DELETED.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_DELETED — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_DELETED¶

+
+
+MEMCACHED_DELETED¶
+
+ +

The object requested by the key has been deleted.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_DEPRECATED.html b/client_errors/MEMCACHED_DEPRECATED.html new file mode 100644 index 00000000..ceb0ef07 --- /dev/null +++ b/client_errors/MEMCACHED_DEPRECATED.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_DEPRECATED — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_DEPRECATED¶

+
+
+MEMCACHED_DEPRECATED¶
+
+ +

The method that was requested has been deprecated.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_E2BIG.html b/client_errors/MEMCACHED_E2BIG.html new file mode 100644 index 00000000..f2fa0772 --- /dev/null +++ b/client_errors/MEMCACHED_E2BIG.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_E2BIG — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_E2BIG¶

+
+
+MEMCACHED_E2BIG¶
+
+ +

Item is too large for the server to store.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_END.html b/client_errors/MEMCACHED_END.html new file mode 100644 index 00000000..9e3acb88 --- /dev/null +++ b/client_errors/MEMCACHED_END.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_END — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_END¶

+
+
+MEMCACHED_END¶
+
+ +

The server has completed returning all of the objects requested.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_ERRNO.html b/client_errors/MEMCACHED_ERRNO.html new file mode 100644 index 00000000..24962016 --- /dev/null +++ b/client_errors/MEMCACHED_ERRNO.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_ERRNO — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_ERRNO¶

+
+
+MEMCACHED_ERRNO¶
+
+ +

An error has occurred in the driver which has set errno.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_FAILURE.html b/client_errors/MEMCACHED_FAILURE.html new file mode 100644 index 00000000..cf273287 --- /dev/null +++ b/client_errors/MEMCACHED_FAILURE.html @@ -0,0 +1,752 @@ + + + + + + + + + + + MEMCACHED_FAILURE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_FAILURE¶

+
+
+MEMCACHED_FAILURE¶
+
+ +
+

Deprecated since version <0.30.

+
+

A unknown failure has occurred in the server.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.html b/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.html new file mode 100644 index 00000000..29864036 --- /dev/null +++ b/client_errors/MEMCACHED_FAIL_UNIX_SOCKET.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_FAIL_UNIX_SOCKET — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_FAIL_UNIX_SOCKET¶

+
+
+MEMCACHED_FAIL_UNIX_SOCKET¶
+
+ +

A connection was not established with the server via a unix domain socket.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_FETCH_NOTFINISHED.html b/client_errors/MEMCACHED_FETCH_NOTFINISHED.html new file mode 100644 index 00000000..72761220 --- /dev/null +++ b/client_errors/MEMCACHED_FETCH_NOTFINISHED.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_FETCH_NOTFINISHED — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_FETCH_NOTFINISHED¶

+
+
+MEMCACHED_FETCH_NOTFINISHED¶
+
+ +

A request has been made, but the server has not finished the fetch of the last request.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.html b/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.html new file mode 100644 index 00000000..6d14ae81 --- /dev/null +++ b/client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_HOST_LOOKUP_FAILURE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_HOST_LOOKUP_FAILURE¶

+
+
+MEMCACHED_HOST_LOOKUP_FAILURE¶
+
+ +

A DNS failure has occurred.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_INVALID_ARGUMENTS.html b/client_errors/MEMCACHED_INVALID_ARGUMENTS.html new file mode 100644 index 00000000..3fb6c068 --- /dev/null +++ b/client_errors/MEMCACHED_INVALID_ARGUMENTS.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_INVALID_ARGUMENTS — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_INVALID_ARGUMENTS¶

+
+
+MEMCACHED_INVALID_ARGUMENTS¶
+
+ +

The arguments supplied to the given function were not valid.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.html b/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.html new file mode 100644 index 00000000..f1089bef --- /dev/null +++ b/client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_INVALID_HOST_PROTOCOL — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_INVALID_HOST_PROTOCOL¶

+
+
+MEMCACHED_INVALID_HOST_PROTOCOL¶
+
+ +

The server you are connecting too has an invalid protocol. Most likely you are connecting to an older server that does not speak the binary protocol.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_ITEM.html b/client_errors/MEMCACHED_ITEM.html new file mode 100644 index 00000000..7240b785 --- /dev/null +++ b/client_errors/MEMCACHED_ITEM.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_ITEM — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_ITEM¶

+
+
+MEMCACHED_ITEM¶
+
+ +

An item has been fetched (this is an internal error only).

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_KEY_TOO_BIG.html b/client_errors/MEMCACHED_KEY_TOO_BIG.html new file mode 100644 index 00000000..1287dbd4 --- /dev/null +++ b/client_errors/MEMCACHED_KEY_TOO_BIG.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_KEY_TOO_BIG — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_KEY_TOO_BIG¶

+
+
+MEMCACHED_KEY_TOO_BIG¶
+
+ +

The key that has been provided is too large for the given server.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_MAXIMUM_RETURN.html b/client_errors/MEMCACHED_MAXIMUM_RETURN.html new file mode 100644 index 00000000..d1cc2f04 --- /dev/null +++ b/client_errors/MEMCACHED_MAXIMUM_RETURN.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_MAXIMUM_RETURN — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_MAXIMUM_RETURN¶

+
+
+MEMCACHED_MAXIMUM_RETURN¶
+
+ +

This in an internal only state.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.html b/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.html new file mode 100644 index 00000000..9d3fe44b --- /dev/null +++ b/client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_MEMORY_ALLOCATION_FAILURE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_MEMORY_ALLOCATION_FAILURE¶

+
+
+MEMCACHED_MEMORY_ALLOCATION_FAILURE¶
+
+ +

An error has occurred while trying to allocate memory.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_NOTFOUND.html b/client_errors/MEMCACHED_NOTFOUND.html new file mode 100644 index 00000000..0bb2ff47 --- /dev/null +++ b/client_errors/MEMCACHED_NOTFOUND.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_NOTFOUND — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_NOTFOUND¶

+
+
+MEMCACHED_NOTFOUND¶
+
+ +

The object requested was not found.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_NOTSTORED.html b/client_errors/MEMCACHED_NOTSTORED.html new file mode 100644 index 00000000..9bae6da1 --- /dev/null +++ b/client_errors/MEMCACHED_NOTSTORED.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_NOTSTORED — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_NOTSTORED¶

+
+
+MEMCACHED_NOTSTORED¶
+
+ +

The request to store an object failed.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_NOT_SUPPORTED.html b/client_errors/MEMCACHED_NOT_SUPPORTED.html new file mode 100644 index 00000000..025a4ca8 --- /dev/null +++ b/client_errors/MEMCACHED_NOT_SUPPORTED.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_NOT_SUPPORTED — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_NOT_SUPPORTED¶

+
+
+MEMCACHED_NOT_SUPPORTED¶
+
+ +

The given method is not supported in the server.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_NO_KEY_PROVIDED.html b/client_errors/MEMCACHED_NO_KEY_PROVIDED.html new file mode 100644 index 00000000..002e831d --- /dev/null +++ b/client_errors/MEMCACHED_NO_KEY_PROVIDED.html @@ -0,0 +1,752 @@ + + + + + + + + + + + MEMCACHED_NO_KEY_PROVIDED — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_NO_KEY_PROVIDED¶

+
+
+MEMCACHED_NO_KEY_PROVIDED¶
+
+ +
+

Deprecated since version <0.30: Use MEMCACHED_BAD_KEY_PROVIDED instead.

+
+

No key was provided.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_NO_SERVERS.html b/client_errors/MEMCACHED_NO_SERVERS.html new file mode 100644 index 00000000..620d5bed --- /dev/null +++ b/client_errors/MEMCACHED_NO_SERVERS.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_NO_SERVERS — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_NO_SERVERS¶

+
+
+MEMCACHED_NO_SERVERS¶
+
+ +

No servers have been added to the memcached_st object.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_PARSE_ERROR.html b/client_errors/MEMCACHED_PARSE_ERROR.html new file mode 100644 index 00000000..8c375702 --- /dev/null +++ b/client_errors/MEMCACHED_PARSE_ERROR.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_PARSE_ERROR — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_PARSE_ERROR¶

+
+
+MEMCACHED_PARSE_ERROR¶
+
+ +

An error has occurred while trying to parse the configuration string. You should use memparse to determine what the error was.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_PARSE_USER_ERROR.html b/client_errors/MEMCACHED_PARSE_USER_ERROR.html new file mode 100644 index 00000000..93bc90d4 --- /dev/null +++ b/client_errors/MEMCACHED_PARSE_USER_ERROR.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_PARSE_USER_ERROR — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_PARSE_USER_ERROR¶

+
+
+MEMCACHED_PARSE_USER_ERROR¶
+
+ +

An error has occurred in parsing the configuration string.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_PARTIAL_READ.html b/client_errors/MEMCACHED_PARTIAL_READ.html new file mode 100644 index 00000000..91ea576e --- /dev/null +++ b/client_errors/MEMCACHED_PARTIAL_READ.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_PARTIAL_READ — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_PARTIAL_READ¶

+
+
+MEMCACHED_PARTIAL_READ¶
+
+ +

The read was only partcially successful.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_PROTOCOL_ERROR.html b/client_errors/MEMCACHED_PROTOCOL_ERROR.html new file mode 100644 index 00000000..cdbc4e58 --- /dev/null +++ b/client_errors/MEMCACHED_PROTOCOL_ERROR.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_PROTOCOL_ERROR — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_PROTOCOL_ERROR¶

+
+
+MEMCACHED_PROTOCOL_ERROR¶
+
+ +

An unknown error has occurred in the protocol.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_READ_FAILURE.html b/client_errors/MEMCACHED_READ_FAILURE.html new file mode 100644 index 00000000..638d0ca4 --- /dev/null +++ b/client_errors/MEMCACHED_READ_FAILURE.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_READ_FAILURE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_READ_FAILURE¶

+
+
+MEMCACHED_READ_FAILURE¶
+
+ +

A read failure has occurred.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_SERVER_ERROR.html b/client_errors/MEMCACHED_SERVER_ERROR.html new file mode 100644 index 00000000..a6e5bce8 --- /dev/null +++ b/client_errors/MEMCACHED_SERVER_ERROR.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_SERVER_ERROR — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_SERVER_ERROR¶

+
+
+MEMCACHED_SERVER_ERROR¶
+
+ +

An unknown error has occurred in the server.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_SERVER_MARKED_DEAD.html b/client_errors/MEMCACHED_SERVER_MARKED_DEAD.html new file mode 100644 index 00000000..8fcb42ce --- /dev/null +++ b/client_errors/MEMCACHED_SERVER_MARKED_DEAD.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_SERVER_MARKED_DEAD — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_SERVER_MARKED_DEAD¶

+
+
+MEMCACHED_SERVER_MARKED_DEAD¶
+
+ +

The requested server has been marked dead.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_SOME_ERRORS.html b/client_errors/MEMCACHED_SOME_ERRORS.html new file mode 100644 index 00000000..635113ef --- /dev/null +++ b/client_errors/MEMCACHED_SOME_ERRORS.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_SOME_ERRORS — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_SOME_ERRORS¶

+
+
+MEMCACHED_SOME_ERRORS¶
+
+ +

A multi request has been made, and some underterminate number of errors have occurred.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_STAT.html b/client_errors/MEMCACHED_STAT.html new file mode 100644 index 00000000..5635c9a0 --- /dev/null +++ b/client_errors/MEMCACHED_STAT.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_STAT — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_STAT¶

+
+
+MEMCACHED_STAT¶
+
+ +

A “stat” command has been returned in the protocol.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_STORED.html b/client_errors/MEMCACHED_STORED.html new file mode 100644 index 00000000..6858512c --- /dev/null +++ b/client_errors/MEMCACHED_STORED.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_STORED — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_STORED¶

+
+
+MEMCACHED_STORED¶
+
+ +

The requested object has been successfully stored on the server.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_SUCCESS.html b/client_errors/MEMCACHED_SUCCESS.html new file mode 100644 index 00000000..0f614316 --- /dev/null +++ b/client_errors/MEMCACHED_SUCCESS.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_SUCCESS — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_SUCCESS¶

+
+
+MEMCACHED_SUCCESS¶
+
+ +

The request was successfully executed.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_TIMEOUT.html b/client_errors/MEMCACHED_TIMEOUT.html new file mode 100644 index 00000000..760f7a14 --- /dev/null +++ b/client_errors/MEMCACHED_TIMEOUT.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_TIMEOUT — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_TIMEOUT¶

+
+
+MEMCACHED_TIMEOUT¶
+
+ +

Operation has timed out.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.html b/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.html new file mode 100644 index 00000000..17dff1b8 --- /dev/null +++ b/client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_UNKNOWN_READ_FAILURE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_UNKNOWN_READ_FAILURE¶

+
+
+MEMCACHED_UNKNOWN_READ_FAILURE¶
+
+ +

An unknown read failure only occurs when either there is a bug in the server, or in rare cases where an ethernet nic is reporting dubious information.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.html b/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.html new file mode 100644 index 00000000..bffadc4a --- /dev/null +++ b/client_errors/MEMCACHED_UNKNOWN_STAT_KEY.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_UNKNOWN_STAT_KEY — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_UNKNOWN_STAT_KEY¶

+
+
+MEMCACHED_UNKNOWN_STAT_KEY¶
+
+ +

The server you are communicating with has a stat key which has not be defined in the protocol.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_VALUE.html b/client_errors/MEMCACHED_VALUE.html new file mode 100644 index 00000000..1a463cf8 --- /dev/null +++ b/client_errors/MEMCACHED_VALUE.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_VALUE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_VALUE¶

+
+
+MEMCACHED_VALUE¶
+
+ +

A value has been returned from the server (this is an internal condition only).

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/client_errors/MEMCACHED_WRITE_FAILURE.html b/client_errors/MEMCACHED_WRITE_FAILURE.html new file mode 100644 index 00000000..da4d5b8a --- /dev/null +++ b/client_errors/MEMCACHED_WRITE_FAILURE.html @@ -0,0 +1,749 @@ + + + + + + + + + + + MEMCACHED_WRITE_FAILURE — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

MEMCACHED_WRITE_FAILURE¶

+
+
+MEMCACHED_WRITE_FAILURE¶
+
+ +

An error has occured while trying to write to a server.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/copyright.html b/copyright.html new file mode 100644 index 00000000..e01c2a29 --- /dev/null +++ b/copyright.html @@ -0,0 +1,775 @@ + + + + + + + + + + + Copyright — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Copyright
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ + + + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/error_messages.html b/error_messages.html new file mode 100644 index 00000000..142c9f8f --- /dev/null +++ b/error_messages.html @@ -0,0 +1,792 @@ + + + + + + + + + + + Client Error messages — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Client Error messages
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ + + + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 00000000..00727fe0 --- /dev/null +++ b/genindex.html @@ -0,0 +1,1642 @@ + + + + + + + + + + + + Index — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Index
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ + +

Index

+ +
+ Symbols + | B + | E + | H + | I + | L + | M + | O + | S + | T + | U + +
+

Symbols

+ + + +
+ +

B

+ + +
+ +

E

+ + +
+ +

H

+ + + +
+ +

I

+ + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

O

+ + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/hashkit_create.html b/hashkit_create.html new file mode 100644 index 00000000..0a422933 --- /dev/null +++ b/hashkit_create.html @@ -0,0 +1,802 @@ + + + + + + + + + + + Creating a hashkit structure — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Creating a hashkit structure
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Creating a hashkit structure¶

+
+

SYNOPSIS¶

+

#include <libhashkit/hashkit.h>

+
+
+hashkit_st¶
+
+ +
+
+hashkit_st *hashkit_create(hashkit_st *hash)¶
+
+ +
+
+hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr)¶
+
+ +
+
+void hashkit_free(hashkit_st *hash)¶
+
+ +
+
+bool hashkit_is_allocated(const hashkit_st *hash)¶
+
+ +

Compile and link with -lhashkit

+
+
+

DESCRIPTION¶

+

The hashkit_create() function initializes a hashkit object for use. If +you pass a NULL argument for hash, then the memory for the object is +allocated. If you specify a pre-allocated piece of memory, that is +initialized for use.

+

The hashkit_clone() function initializes a hashkit object much like +hashkit_create(), but instead of using default settings it will use +the settings of the ptr hashkit object.

+

The hashkit_free() frees any resources being consumed by the hashkit +objects that were initialized with hashkit_create() or hashkit_clone().

+

The hashkit_is_allocated() reports where the memory was allocated +for a hashkit object.

+
+
+

RETURN VALUE¶

+

hashkit_create() and hashkit_clone() will return NULL on +failure or non-NULL on success.

+

hashkit_is_allocated() returns true if the memory for the hashkit +object was allocated inside of hashkit_create() or +hashkit_clone(), otherwise it is false and was user-supplied memory.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/hashkit_functions.html b/hashkit_functions.html new file mode 100644 index 00000000..1191234b --- /dev/null +++ b/hashkit_functions.html @@ -0,0 +1,818 @@ + + + + + + + + + + + Available Hashes — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Available Hashes
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Available Hashes¶

+

Various hash functions to use for calculating values for keys

+
+

SYNOPSIS¶

+

#include <libhashkit/hashkit.h>

+
+
+uint32_t hashkit_default(const char *key, size_t key_length)¶
+
+ +
+
+uint32_t hashkit_fnv1_64(const char *key, size_t key_length)¶
+
+ +
+
+uint32_t hashkit_fnv1a_64(const char *key, size_t key_length)¶
+
+ +
+
+uint32_t hashkit_fnv1_32(const char *key, size_t key_length)¶
+
+ +
+
+uint32_t hashkit_fnv1a_32(const char *key, size_t key_length)¶
+
+ +
+
+uint32_t hashkit_crc32(const char *key, size_t key_length)¶
+
+ +
+
+uint32_t hashkit_hsieh(const char *key, size_t key_length)¶
+
+ +
+
+uint32_t hashkit_murmur(const char *key, size_t key_length)¶
+
+ +
+
+uint32_t hashkit_jenkins(const char *key, size_t key_length)¶
+
+ +
+
+uint32_t hashkit_md5(const char *key, size_t key_length)¶
+
+ +

Compile and link with -lhashkit

+
+
+

DESCRIPTION¶

+

These functions generate hash values from a key using a variety of +algorithms. These functions can be used standalone, or as arguments +to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).

+

The hashkit_hsieh is only available if the library is built with +the appropriate flag enabled.

+
+
+

RETURN VALUE¶

+

A 32-bit hash value.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3) hashkit_set_continuum_hash_fn(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/hashkit_value.html b/hashkit_value.html new file mode 100644 index 00000000..1974f950 --- /dev/null +++ b/hashkit_value.html @@ -0,0 +1,772 @@ + + + + + + + + + + + hashkit_value — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • hashkit_value
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

hashkit_value¶

+

Generate a value for the given key

+
+

SYNOPSIS¶

+

#include <libhashkit/hashkit.h>

+
+
+uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length)¶
+
+ +

Compile and link with -lhashkit

+
+
+

DESCRIPTION¶

+

The hashkit_value() function generates a 32-bit hash value from the +given key and key_length. The hash argument is an initialized hashkit +object, and distribution type and hash function is used from this +object while generating the value.

+
+
+

RETURN VALUE¶

+

A 32-bit hash value.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..0f5543b8 --- /dev/null +++ b/index.html @@ -0,0 +1,863 @@ + + + + + + + + + + + Welcome to the libmemcached documentation — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Welcome to the libmemcached documentation
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Welcome to the libmemcached documentation¶

+
+

Libmemcached¶

+
+

Basics

+ +
+
+

Working with Data

+ +
+
+

Advanced Topics

+ +
+
+

Interface Versions

+ +
+
+

Deprecated Functions

+ +
+
+

Platform Specifics

+ +
+
+

Deriving Statistics from a Server

+ +
+
+

Libmemcachedutil

+ +
+
+

Client Applications

+ +
+
+

Libhashkit

+ +
+
+
+
+

Indices and tables¶

+ +
+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libhashkit.html b/libhashkit.html new file mode 100644 index 00000000..c4efc4ac --- /dev/null +++ b/libhashkit.html @@ -0,0 +1,759 @@ + + + + + + + + + + + Introducing libhashkit — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Introducing libhashkit
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Introducing libhashkit¶

+
cc [ flag ... ] file ... -lhashkit
+
+#include <libhashkit/hashkit.h>
+
+
+
+

DESCRIPTION¶

+

libhashkit is a small and thread-safe client library that provides a collection of useful hashing algorithm. libhashkit is distributed with libmemcached.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

libhashkit(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached-1.0/index.html b/libmemcached-1.0/index.html new file mode 100644 index 00000000..ea63313d --- /dev/null +++ b/libmemcached-1.0/index.html @@ -0,0 +1,746 @@ + + + + + + + + + + + libmemcached 1.0 API — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • libmemcached 1.0 API
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

libmemcached 1.0 API¶

+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached-1.0/memcached_set_encoding_key.html b/libmemcached-1.0/memcached_set_encoding_key.html new file mode 100644 index 00000000..b65ff56a --- /dev/null +++ b/libmemcached-1.0/memcached_set_encoding_key.html @@ -0,0 +1,775 @@ + + + + + + + + + + + Set encryption key — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Set encryption key
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Set encryption key¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+void memcached_set_encoding_key(memcached_st *ptr, const char *string, const size_t string_length)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_set_encoding_key() sets the key that will be used to encrypt and decrypt data as it is sent and recieved from the server.

+

Currently only AES is is supported.

+
+
+

RETURN¶

+

A value of type memcached_return_t is returned On success that value +will be MEMCACHED_SUCCESS. Use memcached_strerror() to +translate this value to a printable string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached-1.0/memcached_touch.html b/libmemcached-1.0/memcached_touch.html new file mode 100644 index 00000000..e53116fc --- /dev/null +++ b/libmemcached-1.0/memcached_touch.html @@ -0,0 +1,784 @@ + + + + + + + + + + + memcached_touch, memcached_touch_by_key — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

memcached_touch, memcached_touch_by_key¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_touch(memcached_st *ptr, const char *key, size_t key_length, time_t expiration)¶
+
+ +
+
+memcached_return_t memcached_touch_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_touch() is used to update the expiration time on an existing key. +memcached_touch_by_key() works the same, but it takes a master key +to find the given value.

+
+
+

RETURN¶

+

A value of type memcached_return_t is returned +On success that value will be MEMCACHED_SUCCESS. +Use memcached_strerror() to translate this value to a printable +string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached-1.1/index.html b/libmemcached-1.1/index.html new file mode 100644 index 00000000..d3efd97b --- /dev/null +++ b/libmemcached-1.1/index.html @@ -0,0 +1,742 @@ + + + + + + + + + + + libmemcached 1.1 API — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • libmemcached 1.1 API
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

libmemcached 1.1 API¶

+

The 1.1 is still being finalized. It will be the 1.0 API minus deprecated functions.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached.html b/libmemcached.html new file mode 100644 index 00000000..3fb6ef29 --- /dev/null +++ b/libmemcached.html @@ -0,0 +1,894 @@ + + + + + + + + + + + Introducing the C Client Library for memcached — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Introducing the C Client Library for memcached
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Introducing the C Client Library for memcached¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+

Compile and link with -lmemcached

+
+

libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.

+

libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:

+
    +

  1. Asynchronous and Synchronous Transport Support.

    2. +

  2. Consistent Hashing and Distribution.

    3. +

  3. Tunable Hashing algorithm to match keys.

    4. +

  4. Access to large object support.

    5. +

  5. Local replication.

    6. +

  6. A complete reference guide and documentation to the API.

    7. +

  7. Tools to Manage your Memcached networks.

    8. +
+
+
+

DESCRIPTION¶

+

“Memcached is a high-performance, distributed memory object caching +system, generic in nature, but intended for use in speeding up dynamic web +applications by alleviating database load.” http://memcached.org/

+

libmemcached is a small, thread-safe client library for the +memcached protocol. The code has all been written to allow +for both web and embedded usage. It handles the work behind routing +individual keys to specific servers specified by the developer (and values are +matched based on server order as supplied by the user). It implements +a modular and consistent method of object distribution.

+

There are multiple implemented routing and hashing methods. See the +memcached_behavior_set() manpage for more information.

+

All operations are performed against a memcached_st structure. +These structures can either be dynamically allocated or statically +allocated and then initialized by memcached_create(). Functions have +been written in order to encapsulate the memcached_st. It is not +recommended that you operate directly against the structure.

+

Nearly all functions return a memcached_return_t value. +This value can be translated to a printable string with +memcached_strerror.

+

Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.

+

Group keys can be optionally used to group sets of objects with servers.

+

Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.

+

memcached_st structures are thread-safe, but each thread must +contain its own structure (that is, if you want to share these among +threads you must provide your own locking). No global variables are +used in this library.

+

If you are working with GNU autotools you will want to add the following to +your COPYING to properly include libmemcached in your application.

+

PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0) +AC_SUBST(DEPS_CFLAGS) +AC_SUBST(DEPS_LIBS)

+

Some features of the library must be enabled through memcached_behavior_set().

+

Hope you enjoy it!

+
+
+

CONSTANTS¶

+

A number of constants have been provided for in the library.

+
+
+MEMCACHED_DEFAULT_PORT¶
+

The default port used by memcached(3).

+
+ +
+
+MEMCACHED_MAX_KEY¶
+

Default maximum size of a key (which includes the null pointer). Master keys +have no limit, this only applies to keys used for storage.

+
+ +
+
+MEMCACHED_MAX_BUFFER¶
+

Default size of read/write buffers (which includes the null pointer).

+
+ +
+
+MEMCACHED_STRIDE¶
+

This is the “stride” used in the consistent hash used between replicas.

+
+ +
+
+MEMCACHED_MAX_HOST_LENGTH¶
+

Maximum allowed size of the hostname.

+
+ +
+
+LIBMEMCACHED_VERSION_STRING¶
+

String value of libmemcached version such as “1.23.4”

+
+ +
+
+LIBMEMCACHED_VERSION_HEX¶
+

Hex value of the version number. “0x00048000” This can be used for comparing versions based on number.

+
+ +
+
+MEMCACHED_PREFIX_KEY_MAX_SIZE¶
+

Maximum length allowed for namespacing of a key.

+
+ +
+
+

THREADS AND PROCESSES¶

+

When using threads or forked processes it is important to keep one instance +of memcached_st per process or thread. Without creating your own +locking structures you can not share a single memcached_st. However, +you can call memcached_quit() on a memcached_st and then use the resulting cloned structure.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached_examples(3) +libmemcached(1) memcat(1) memcp(1) +memflush(1) memrm(1) memslap(1) +memstat(1) memcached_fetch(3) +memcached_replace(3) memcached_server_list_free(3) +libmemcached_examples(3) memcached_clone(3) +memcached_free(3) memcached_server_add(3) +memcached_server_push(3) memcached_add(3) +memcached_get(3) memcached_server_count(3) +memcached_create(3) memcached_increment(3) +memcached_server_list(3) memcached_set(3) +memcached_decrement(3) memcached_mget(3) +memcached_server_list_append(3) memcached_strerror(3) +memcached_delete(3) memcached_quit(3) +memcached_server_list_count(3) memcached_verbosity(3) +memcached_server_add_unix_socket(3) +memcached_result_create(3) memcached_result_free(3) +memcached_result_key_value(3) +memcached_result_key_length(3) +memcached_result_value(3) memcached_result_length(3) +memcached_result_flags(3) memcached_result_cas(3) +memcached_result_st(3) memcached_append(3) +memcached_prepend(3) memcached_fetch_result(3) +memerror(1) memcached_get_by_key(3) +memcached_mget_by_key(3) memcached_delete_by_key(3) +memcached_fetch_execute(3) memcached_callback_get(3) +memcached_callback_set(3) memcached_version(3) +memcached_lib_version(3) memcached_result_set_value(3) +memcached_dump(3) memdump(1) +memcached_set_memory_allocators(3) +memcached_get_memory_allocators(3) +memcached_get_user_data(3) memcached_set_user_data(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached/defaults.html b/libmemcached/defaults.html new file mode 100644 index 00000000..37cb7a3c --- /dev/null +++ b/libmemcached/defaults.html @@ -0,0 +1,789 @@ + + + + + + + + + + + DEFAULTS — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • DEFAULTS
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

DEFAULTS¶

+
+
+MEMCACHED_DEFAULT_TIMEOUT¶
+
+ +

Value 5000

+
+
+MEMCACHED_DEFAULT_CONNECT_TIMEOUT¶
+

Value 4000

+
+ +
+
+MEMCACHED_CONTINUUM_ADDITION¶
+

Value 10. How many extra slots we should build for in the continuum.

+
+ +
+
+MEMCACHED_SERVER_FAILURE_LIMIT¶
+

Value 5

+
+ +
+
+MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT¶
+

Value 2

+
+ +
+
+MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT¶
+

Value 0

+
+ +
+
+`MEMCACHED_PREFIX_KEY_MAX_SIZE`
+

Value 128

+
+ +
+
+MEMCACHED_VERSION_STRING_LENGTH¶
+

Value 24

+
+ +
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached/memcached_exist.html b/libmemcached/memcached_exist.html new file mode 100644 index 00000000..d42c05ee --- /dev/null +++ b/libmemcached/memcached_exist.html @@ -0,0 +1,778 @@ + + + + + + + + + + + Determine if a keys exists. — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Determine if a keys exists.
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Determine if a keys exists.¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_exist(memcached_st *ptr, char *key, size_t *key_length)¶
+
+ +
+
+memcached_return_t memcached_exist_by_key(memcached_st *ptr, char *group_key, size_t *group_key_length, char *key, size_t *key_length)¶
+
+

New in version 0.53.

+
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_exist() can be used to check to see if a key exists. No value is returned if the key exists, or does not exist, on the server.

+
+
+

RETURN¶

+

memcached_exist() sets error to +to MEMCACHED_SUCCESS upon finding that the key exists. +MEMCACHED_NOTFOUND will be return if the key is not found.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached/memcached_fetch.html b/libmemcached/memcached_fetch.html new file mode 100644 index 00000000..7dd88cb1 --- /dev/null +++ b/libmemcached/memcached_fetch.html @@ -0,0 +1,785 @@ + + + + + + + + + + + memcached_fetch — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • memcached_fetch
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

memcached_fetch¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)¶
+
+

Deprecated since version 0.50: Use memcached_fetch_result() instead.

+
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_fetch() is used to fetch an individual value from the server. memcached_mget() must always be called before using this method. +You must pass in a key and its length to fetch the object. You must supply +three pointer variables which will give you the state of the returned +object. A uint32_t pointer to contain whatever flags you stored with the value, a size_t pointer which will be filled with size of of the +object, and a memcached_return_t pointer to hold any error. The +object will be returned upon success and NULL will be returned on failure. MEMCACHED_END is returned by the *error value when all objects that have been found are returned. The final value upon MEMCACHED_END is null.

+

Values returned by memcached_fetch() must be freed by the caller.

+

All of the above functions are not tested when the +MEMCACHED_BEHAVIOR_USE_UDP has been set. Executing any of these +functions with this behavior on will result in MEMCACHED_NOT_SUPPORTED being returned, or for those functions which do not return a memcached_return_t, the error function parameter will be set to MEMCACHED_NOT_SUPPORTED.

+
+
+

RETURN¶

+

memcached_fetch() sets error to +to MEMCACHED_END upon successful conclusion. +MEMCACHED_NOTFOUND will be return if no keys at all were found.

+

MEMCACHED_KEY_TOO_BIG is set to error whenever memcached_fetch() was used +and the key was set larger then MEMCACHED_MAX_KEY, which was the largest +key allowed for the original memcached ascii server.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3) memcached_fetch_result(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached/memcached_last_error_message.html b/libmemcached/memcached_last_error_message.html new file mode 100644 index 00000000..425cef7a --- /dev/null +++ b/libmemcached/memcached_last_error_message.html @@ -0,0 +1,771 @@ + + + + + + + + + + + Retrieving errors — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Retrieving errors
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Retrieving errors¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+const char *memcached_last_error_message(memcached_st *)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_last_error_message() is used to return the last error +message that the server responded too. If this error came from a specific +server, its hostname and port will be provided in the error message.

+
+
+

RETURN¶

+

memcached_last_error_message returns a const char* which does not need to be +de-allocated. If no error has occurred then it will return NULL.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached/memcached_return_t.html b/libmemcached/memcached_return_t.html new file mode 100644 index 00000000..b34ebb18 --- /dev/null +++ b/libmemcached/memcached_return_t.html @@ -0,0 +1,829 @@ + + + + + + + + + + + Error Codes (memcached_return_t) — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Error Codes (memcached_return_t)
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Error Codes (memcached_return_t)¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t¶
+
+ +
+
+const char *memcached_strerror(memcached_st *ptr, memcached_return_t rc)¶
+
+ +
+
+bool memcached_success(memcached_return_t)¶
+
+ +
+
+bool memcached_continue(memcached_return_t rc)¶
+
+ +
+
+bool memcached_failed(memcached_return_t)¶
+
+ +
+
+bool memcached_fatal(memcached_return_t)¶
+
+ + +
+
+

SEE ALSO¶

+

memcached libmemcached memcached_client_error or memcached_worker_error

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached_configuration.html b/libmemcached_configuration.html new file mode 100644 index 00000000..0768a1b2 --- /dev/null +++ b/libmemcached_configuration.html @@ -0,0 +1,1022 @@ + + + + + + + + + + + Configuring Libmemcached — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Configuring Libmemcached
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Configuring Libmemcached¶

+
+

SYNOPSIS¶

+

#include <libmemcached-1.0/memcached.h>

+
+
+LIBMEMCACHED¶
+
+ +
+
+memcached_st *memcached(const char *string, size_t string_length)¶
+
+ +
+
+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 +that you can use in your application directly.

+
+
+--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.

+
+
+--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.

+
+
+--VERIFY-KEY
+
+ +

Verify that keys that are being used fit within the design of the protocol being used.

+
+
+--REMOVE_FAILED_SERVERS
+
+ +

Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.

+
+
+--BINARY-PROTOCOL
+
+ +

Force all connections to use the binary protocol.

+
+
+--BUFFER-REQUESTS
+
+ +

Please see MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.

+
+
+--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=
+
+ +

Please see MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.

+
+
+--DISTRIBUTION=
+
+ +

Set the distribution model used by the client. See memcached_behavior_set(3) for more details.

+
+
+--HASH=
+
+ +

Set the hashing alogrthm used for placing keys on servers.

+
+
+--HASH-WITH-NAMESPACE
+
+ +

When enabled the prefix key will be added to the key when determining which +server to store the data in.

+
+
+--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=
+
+ +

Set the nummber of servers that keys will be replicated to.

+
+
+--RANDOMIZE-REPLICA-READ
+
+ +

Select randomly the server within the replication pool to read from.

+
+
+--SORT-HOSTS
+
+ +

When adding new servers always calculate their distribution based on sorted naming order.

+
+
+--SUPPORT-CAS
+
+ +

See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_SUPPORT_CAS

+
+
+--USE-UDP
+
+ +

See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_USE_UDP

+
+
+--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:¶

+
+
+--POOL-MIN
+
+ +

Initial size of pool.

+
+
+--POOL-MAX
+
+ +

Maximize size of the pool.

+
+
+

I/O Options:¶

+
+
+--TCP-NODELAY
+
+ +

See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_TCP_NODELAY

+
+
+--TCP-KEEPALIVE
+
+ +

See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE

+
+
+--RETRY-TIMEOUT=
+
+ +

See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT

+
+
+--SERVER-FAILURE-LIMIT=
+
+ +

See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT

+
+
+--SND-TIMEOUT=
+
+ +

See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_SND_TIMEOUT

+
+
+--SOCKET-RECV-SIZE=
+
+ +

See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE

+
+
+--SOCKET-SEND-SIZE=
+
+ +

See memcached_behavior_set(3) for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE

+
+
+--POLL-TIMEOUT=
+
+ +

That sets the value of the timeout used by :manpage: poll().

+
+
+--IO-BYTES-WATERMARK=
+
+ +
+
+--IO-KEY-PREFETCH=
+
+ +
+
+--IO-MSG-WATERMARK=
+
+ +
+
+--TCP-KEEPIDLE
+
+ +
+
+--RCV-TIMEOUT=
+
+ +
+
+

Other:¶

+
+
+INCLUDE
+
+ +

Include a file in configuration. Unlike –CONFIGURE-FILE= this will not reset memcached_st

+
+
+RESET
+
+ +

Reset memcached_st and continue to process.

+
+
+END
+
+ +

End configutation processing.

+
+
+ERROR
+
+ +

End configutation processing and throw an error.

+
+
+
+

RETURN¶

+

memcached() returns a pointer to the memcached_st that was +created (or initialized). On an allocation failure, it returns NULL.

+
+
+

EXAMPLE¶

+
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: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcached_examples.html b/libmemcached_examples.html new file mode 100644 index 00000000..0eb85b9d --- /dev/null +++ b/libmemcached_examples.html @@ -0,0 +1,840 @@ + + + + + + + + + + + Examples — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Examples
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Examples¶

+

Examples for libmemcached

+
+

DESCRIPTION¶

+

For full examples, test cases are found in tests/*.c in the main +distribution. These are always up to date, and are used for each test run of +the library.

+
+
+

Connecting to servers¶

+
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);
+
+
+

In the above code you create a memcached_st object with three server +by making use of memcached_create().

+
+
+

Creating a pool of servers¶

+
const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com";
+
+memcached_pool_st* pool= memcached_pool(config_string, strlen(config_string));
+
+memcached_return_t rc;
+
+memcached_st *memc= memcached_pool_pop(pool, false, &rc);
+
+.... do work
+
+/*
+  Release the memc_ptr that was pulled from the pool
+*/
+memcached_pool_push(pool, memc);
+
+/*
+  Destroy the pool.
+*/
+memcached_pool_destroy(pool);
+
+
+

In the above code you create a memcached_pool_st object with three +server by making use of memcached_pool().

+

When memcached_pool_destroy() all memory will be released that is associated +with the pool.

+
+
+

Adding a value to the server¶

+
char *key= "foo";
+char *value= "value";
+
+memcached_return_t rc= memcached_set(memc, key, strlen(key), value, value_length, (time_t)0, (uint32_t)0);
+
+if (rc != MEMCACHED_SUCCESS)
+{
+... // handle failure
+}
+
+
+

It is best practice to always look at the return value of any operation.

+
+
+

Fetching multiple values¶

+
memcached_return_t rc;
+char *keys[]= {"fudge", "son", "food"};
+size_t key_length[]= {5, 3, 4};
+unsigned int x;
+uint32_t flags;
+
+char return_key[MEMCACHED_MAX_KEY];
+size_t return_key_length;
+char *return_value;
+size_t return_value_length;
+
+rc= memcached_mget(memc, keys, key_length, 3);
+
+x= 0;
+while ((return_value= memcached_fetch(memc, return_key, &return_key_length,
+                                      &return_value_length, &flags, &rc)))
+{
+  free(return_value);
+  x++;
+}
+
+
+

Notice that you freed values returned from memcached_fetch(). The define +MEMCACHED_MAX_KEY is provided for usage.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/libmemcachedutil.html b/libmemcachedutil.html new file mode 100644 index 00000000..4667938c --- /dev/null +++ b/libmemcachedutil.html @@ -0,0 +1,771 @@ + + + + + + + + + + + Introducing libmemcachedutil — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Introducing libmemcachedutil
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Introducing libmemcachedutil¶

+

Utility library for libmemcached

+
+

SYNOPSIS¶

+
cc [ flag ... ] file ... -lmemcachedutil
+
+#include <libmemcached/memcached_util.h>
+
+
+
+
+

DESCRIPTION¶

+

libmemcachedutil is a small and thread-safe client library that +provides extra functionality built on top of libmemcached.

+
+
+

THREADS¶

+

Do not try to access an instance of memcached_st from multiple threads +at the same time. If you want to access memcached from multiple threads +you should either clone the memcached_st, or use the memcached pool +implementation. see memcached_pool_create().

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

libmemcached(3) memcached_pool_create(3) memcached_pool_destroy(3) memcached_pool_pop(3) memcached_pool_push(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_analyze.html b/memcached_analyze.html new file mode 100644 index 00000000..01bf0d17 --- /dev/null +++ b/memcached_analyze.html @@ -0,0 +1,785 @@ + + + + + + + + + + + Anaylzing servers — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Anaylzing servers
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Anaylzing servers¶

+

Analyze server information

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_analysis_st¶
+
+ +
+
+memcached_analysis_st * memcached_analyze(memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

libmemcached has the ability to query a memcached server (or +collection of servers) for their current state. Queries to find state return a +memcached_analysis_st structure. You are responsible for freeing this structure.

+

memcached_analyze() analyzes useful information based on the +provided servers and sets the result to the memcached_analysis_st +structure. The return value must be freed by the calling application.

+

A command line tool, memstat with the option memstat --analyze, +is provided so that you do not have to write an application to use this method.

+
+
+

RETURN¶

+

A pointer to the allocated memcached_analysis_st structure on +success and a NULL pointer on failure. You may inspect the error detail by +checking the memcached_return_t value.

+

Any method returning a memcached_analysis_st expects you to free the +memory allocated for it.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_append.html b/memcached_append.html new file mode 100644 index 00000000..9e66823d --- /dev/null +++ b/memcached_append.html @@ -0,0 +1,823 @@ + + + + + + + + + + + Appending or Prepending to data on the server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Appending or Prepending to data on the server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Appending or Prepending to data on the server¶

+

Appending or Prepending to data on the server

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_prepend(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)¶
+
+ +
+
+memcached_return_t memcached_append(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)¶
+
+ +
+
+memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)¶
+
+ +
+
+memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_prepend() and memcached_append are used to +modify information on a server. All methods take a key, and its length to +store the object. Keys are currently limited to 250 characters when using +either a version of memcached which is 1.4 or below, or when using the text +protocol. You must supply both a value and a length. Optionally you +may test an expiration time for the object and a 16 byte value (it is +meant to be used as a bitmap). “flags” is a 4byte space that is stored +alongside of the main value. Many sub libraries make use of this field, +so in most cases users should avoid making use of it.

+

memcached_prepend() places a segment of data before the last piece +of data stored. Currently expiration and key are not used in the server.

+

memcached_append() places a segment of data at the end of the last +piece of data stored. Currently expiration and key are not used in the server.

+

memcached_prepend_by_key() and +memcached_append_by_key() methods both behave in a similar +method as the non key methods. The difference is that they use their +group_key parameter to map objects to particular servers.

+

If you are looking for performance, memcached_set() with non-blocking +IO is the fastest way to store data on the server.

+

All of the above functions are testsed with the +MEMCACHED_BEHAVIOR_USE_UDP behavior enabled. However, when using +these operations with this behavior on, there are limits to the size of the +payload being sent to the server. The reason for these limits is that the +Memcached Server does not allow multi-datagram requests +and the current server implementation sets a datagram size to 1400 bytes. Due +to protocol overhead, the actual limit of the user supplied data is less than +1400 bytes and depends on the protocol in use as, well as the operation being +executed. When running with the binary protocol, +MEMCACHED_BEHAVIOR_BINARY_PROTOCOL, the size of the key,value, +flags and expiry combined may not exceed 1368 bytes. When running with the +ASCII protocol, the exact limit fluctuates depending on which function is +being executed and whether the function is a cas operation or not. For +non-cas ASCII set operations, there are at least 1335 bytes available +to split among the key, key_prefix, and value; for cas ASCII operations +there are at least 1318 bytes available to split among the key, key_prefix +and value. If the total size of the command, including overhead, exceeds +1400 bytes, a MEMCACHED_WRITE_FAILURE will be returned.

+
+
+

RETURN¶

+

All methods return a value of type memcached_return_t. +On success the value will be MEMCACHED_SUCCESS. +Use memcached_strerror() to translate this value to a printable +string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemached(3) memcached_strerror(3) memcached_set(3) memcached_add(3) memcached_cas(3) memcached_replace(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_auto.html b/memcached_auto.html new file mode 100644 index 00000000..90eb58fc --- /dev/null +++ b/memcached_auto.html @@ -0,0 +1,834 @@ + + + + + + + + + + + Incrementing and Decrementing Values — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Incrementing and Decrementing Values
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Incrementing and Decrementing Values¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_increment(memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)¶
+
+ +
+
+memcached_return_t memcached_decrement(memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)¶
+
+ +
+
+memcached_return_t memcached_increment_with_initial(memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)¶
+
+ +
+
+memcached_return_t memcached_decrement_with_initial(memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)¶
+
+ +
+
+memcached_return_t memcached_increment_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)¶
+
+ +
+
+memcached_return_t memcached_decrement_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)¶
+
+ +
+
+memcached_return_t memcached_increment_with_initial_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)¶
+
+ +
+
+memcached_return_t memcached_decrement_with_initial_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached(1) servers have the ability to increment and decrement keys +(overflow and underflow are not detected). This gives you the ability to use +memcached to generate shared sequences of values.

+

memcached_increment takes a key and keylength and increments the value by +the offset passed to it. The value is then returned via the uint32_t +value pointer you pass to it.

+

memcached_decrement takes a key and keylength and decrements the value by +the offset passed to it. The value is then returned via the uint32_t +value pointer you pass to it.

+

memcached_increment_with_initial takes a key and keylength and increments +the value by the offset passed to it. If the object specified by key does +not exist, one of two things may happen: If the expiration value is +MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other +expiration values, the operation will succeed by seeding the value for that +key with a initial value to expire with the provided expiration time. The +flags will be set to zero.The value is then returned via the uint32_t +value pointer you pass to it. memcached_increment_with_initial is only available +when using the binary protocol.

+

memcached_decrement_with_initial takes a key and keylength and decrements +the value by the offset passed to it. If the object specified by key does +not exist, one of two things may happen: If the expiration value is +MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other +expiration values, the operation will succeed by seeding the value for that +key with a initial value to expire with the provided expiration time. The +flags will be set to zero.The value is then returned via the uint32_t +value pointer you pass to it. memcached_decrement_with_initial is only available +when using the binary protocol.

+

memcached_increment_by_key(), memcached_decrement_by_key(), +memcached_increment_with_initial_by_key(), and +memcached_decrement_with_initial_by_key() are master key equivalents of the above.

+
+
+

RETURN¶

+

A value of type memcached_return_t is returned. +On success that value will be MEMCACHED_SUCCESS. +Use memcached_strerror to translate this value to a printable string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_behavior.html b/memcached_behavior.html new file mode 100644 index 00000000..257b1ff4 --- /dev/null +++ b/memcached_behavior.html @@ -0,0 +1,1057 @@ + + + + + + + + + + + Modifying how the driver behaves — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Modifying how the driver behaves
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Modifying how the driver behaves¶

+

Manipulate the behavior of a memcached_st structure.

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_behavior_t¶
+
+ +
+
+uint64_t memcached_behavior_get(memcached_st *ptr, memcached_behavior_t flag)¶
+
+ +
+
+memcached_return_t memcached_behavior_set(memcached_st *ptr, memcached_behavior_t flag, uint64_t data)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

libmemcached(3) behavior can be modified by using memcached_behavior_set(). Default behavior is the library strives to be quick and +accurate. Some behavior, while being faster, can also result in not entirely +accurate behavior (for instance, memcached_set() will always respond +with MEMCACHED_SUCCESS).

+

memcached_behavior_get() takes a behavior flag and returns whether or not that behavior is currently enabled in the client.

+

memcached_behavior_set() changes the value of a particular option +of the client. It takes both a flag (listed below) and a value. For simple +on or off options you just need to pass in a value of 1. Calls to +memcached_behavior_set() will flush and reset all connections.

+
+
+MEMCACHED_BEHAVIOR_USE_UDP¶
+
+ +

Causes libmemcached(3) to use the UDP transport when communicating +with a memcached server. Not all I/O operations are testsed +when this behavior is enababled. The following operations will return +MEMCACHED_NOT_SUPPORTED when executed with the +MEMCACHED_BEHAVIOR_USE_UDP enabled: memcached_version(), +memcached_stat(), memcached_get(), +memcached_get_by_key(), memcached_mget(), +memcached_mget_by_key(), memcached_fetch(), +memcached_fetch_result(), memcached_fetch_execute().

+

All other operations are testsed but are executed in a ‘fire-and-forget’ +mode, in which once the client has executed the operation, no attempt +will be made to ensure the operation has been received and acted on by the +server.

+

libmemcached(3) does not allow TCP and UDP servers to be shared +within the same libmemached(3) client ‘instance’. An attempt to add a TCP +server when this behavior is enabled will result in a MEMCACHED_INVALID_HOST_PROTOCOL, as will attempting to add a UDP server when this behavior has +not been enabled.

+
+
+MEMCACHED_BEHAVIOR_NO_BLOCK¶
+
+ +

Causes libmemcached(3) to use asychronous IO. This is the fastest +transport available for storage functions.

+
+
+MEMCACHED_BEHAVIOR_SND_TIMEOUT¶
+
+ +

This sets the microsecond behavior of the socket against the SO_SNDTIMEO flag. In cases where you cannot use non-blocking IO this will allow you to still have timeouts on the sending of data.

+
+
+MEMCACHED_BEHAVIOR_RCV_TIMEOUT¶
+
+ +

This sets the microsecond behavior of the socket against the SO_RCVTIMEO flag.

+

In cases where you cannot use non-blocking IO this will allow you to still have timeouts on the reading of data.

+
+
+MEMCACHED_BEHAVIOR_TCP_NODELAY¶
+
+ +

Turns on the no-delay feature for connecting sockets (may be faster in some +environments).

+
+
+MEMCACHED_BEHAVIOR_HASH¶
+
+ +

Makes the default hashing algorithm for keys use MD5. The value can be set to either MEMCACHED_HASH_DEFAULT, MEMCACHED_HASH_MD5, MEMCACHED_HASH_CRC, MEMCACHED_HASH_FNV1_64, MEMCACHED_HASH_FNV1A_64, MEMCACHED_HASH_FNV1_32, MEMCACHED_HASH_FNV1A_32, MEMCACHED_HASH_JENKINS, MEMCACHED_HASH_HSIEH, and MEMCACHED_HASH_MURMUR.

+

Each hash has it’s advantages and it’s weaknesses. If you don’t know or don’t +care, just go with the default.

+

Support for MEMCACHED_HASH_HSIEH is a compile time option that is disabled by default. To enable tests for this hashing algorithm, configure and build libmemcached with the –enable-hash_hsieh.

+
+
+MEMCACHED_BEHAVIOR_DISTRIBUTION¶
+
+ +

Using this you can enable different means of distributing values to servers.

+

The default method is MEMCACHED_DISTRIBUTION_MODULA. You can enable consistent hashing by setting MEMCACHED_DISTRIBUTION_CONSISTENT. Consistent hashing delivers better distribution and allows servers to be added to the cluster with minimal cache losses. Currently MEMCACHED_DISTRIBUTION_CONSISTENT is an alias for the value MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA.

+
+
+MEMCACHED_BEHAVIOR_CACHE_LOOKUPS¶
+
+ +
+

Deprecated since version 0.46(?): DNS lookups are now always cached until an error occurs with the server.

+

Memcached can cache named lookups so that DNS lookups are made only once.

+
+
+
+MEMCACHED_BEHAVIOR_SUPPORT_CAS¶
+
+ +

Support CAS operations (this is not enabled by default at this point in the server since it imposes a slight performance penalty).

+
+
+MEMCACHED_BEHAVIOR_KETAMA¶
+
+ +

Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and +the hash to MEMCACHED_HASH_MD5.

+
+
+MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED¶
+

Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA with the weighted tests. and the hash to MEMCACHED_HASH_MD5.

+
+ +
+
+MEMCACHED_BEHAVIOR_KETAMA_HASH¶
+
+ +

Sets the hashing algorithm for host mapping on continuum. The value can be set +to either MEMCACHED_HASH_DEFAULT, MEMCACHED_HASH_MD5, +MEMCACHED_HASH_CRC, MEMCACHED_HASH_FNV1_64, +MEMCACHED_HASH_FNV1A_64, MEMCACHED_HASH_FNV1_32, and +MEMCACHED_HASH_FNV1A_32.

+
+
+MEMCACHED_BEHAVIOR_KETAMA_COMPAT¶
+
+ +

Sets the compatibility mode. The value can be set to either MEMCACHED_KETAMA_COMPAT_LIBMEMCACHED (this is the default) or MEMCACHED_KETAMA_COMPAT_SPY to be compatible with the SPY Memcached client for Java.

+
+
+MEMCACHED_BEHAVIOR_POLL_TIMEOUT¶
+
+ +

Modify the timeout in milliseconds value that is used by poll. The default value is -1. An signed int must be passed to memcached_behavior_set to change this value (this requires casting). For memcached_behavior_get a signed int value will be cast and returned as the unsigned long long.

+
+
+MEMCACHED_BEHAVIOR_USER_DATA¶
+
+ +
+

Deprecated since version <: 0.30

+
+
+
+MEMCACHED_BEHAVIOR_BUFFER_REQUESTS¶
+
+ +

Enabling buffered IO causes commands to “buffer” instead of being sent. Any action that gets data causes this buffer to be be sent to the remote connection. Quiting the connection or closing down the connection will also cause the buffered data to be pushed to the remote connection.

+
+
+MEMCACHED_BEHAVIOR_VERIFY_KEY¶
+
+ +

Enabling this will cause libmemcached(3) to test all keys to verify that they are valid keys.

+
+
+MEMCACHED_BEHAVIOR_SORT_HOSTS¶
+
+ +

Enabling this will cause hosts that are added to be placed in the host list in sorted order. This will defeat consisten hashing.

+
+
+MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT¶
+
+ +

In non-blocking mode this changes the value of the timeout during socket connection in milliseconds. Specifying -1 means an infinite time‐out.

+
+
+MEMCACHED_BEHAVIOR_BINARY_PROTOCOL¶
+
+ +

Enable the use of the binary protocol. Please note that you cannot toggle this flag on an open connection.

+
+
+MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT¶
+
+ +

Set this value to enable the server be removed after continuous MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT times connection failure.

+
+
+MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK¶
+
+ +

Set this value to tune the number of messages that may be sent before libmemcached should start to automatically drain the input queue. Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full).

+
+
+MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK¶
+
+ +

Set this value to tune the number of bytes that may be sent before libmemcached should start to automatically drain the input queue (need at least 10 IO requests sent without reading the input buffer). Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full).

+
+
+MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH¶
+
+ +

The binary protocol works a bit different than the textual protocol in that a multiget is implemented as a pipe of single get-operations which are sent to the server in a chunk. If you are using large multigets from your application, you may improve the latency of the gets by setting this value so you send out the first chunk of requests when you hit the specified limit. It allows the servers to start processing the requests to send the data back while the rest of the requests are created and sent to the server.

+
+
+MEMCACHED_BEHAVIOR_NOREPLY¶
+
+ +

Set this value to specify that you really don’t care about the result from your storage commands (set, add, replace, append, prepend).

+
+
+MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS¶
+
+ +

If you just want “a poor mans HA”, you may specify the numbers of replicas libmemcached should store of each item (on different servers). This replication does not dedicate certain memcached servers to store the replicas in, but instead it will store the replicas together with all of the other objects (on the ‘n’ next servers specified in your server list).

+
+
+MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ¶
+
+ +

Allows randomizing the replica reads starting point. Normally the read is done from primary server and in case of miss the read is done from primary + 1, then primary + 2 all the way to ‘n’ replicas. If this option is set on the starting point of the replica reads is randomized between the servers. This allows distributing read load to multiple servers with the expense of more write traffic.

+
+
+MEMCACHED_BEHAVIOR_CORK¶
+
+ +

This open has been deprecated with the behavior now built and used appropriately on selected platforms.

+
+
+MEMCACHED_BEHAVIOR_KEEPALIVE¶
+
+ +

Enable TCP_KEEPALIVE behavior.

+
+
+MEMCACHED_BEHAVIOR_KEEPALIVE_IDLE¶
+
+ +

Specify time, in seconds, to mark a connection as idle. This is only available as an option Linux.

+
+
+MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE¶
+
+ +

Find the current size of SO_SNDBUF. A value of 0 means either an error occured or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.

+
+
+MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE¶
+
+ +

Find the current size of SO_RCVBUF. A value of 0 means either an error occured or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.

+
+
+MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
+
+ +
+

Deprecated since version 0.48: See MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS

+

This number of times a host can have an error before it is disabled.

+
+
+
+MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS¶
+
+ +
+

Deprecated since version 0.48: See MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS

+

If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure. This must be used in combination with MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT.

+
+
+
+MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS¶
+

If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure.

+
+ +
+
+MEMCACHED_BEHAVIOR_RETRY_TIMEOUT¶
+
+ +

When enabled a host which is problematic will only be checked for usage based on the amount of time set by this behavior. The value is in seconds.

+
+
+MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY¶
+
+ +

When enabled the prefix key will be added to the key when determining server +by hash. See MEMCACHED_CALLBACK_NAMESPACE for additional +information.

+
+
+

RETURN¶

+

memcached_behavior_get returns either the current value of the get, or 0 +or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set +returns failure or success.

+
+
+

NOTES¶

+

memcached_behavior_set in version .17 was changed from taking a pointer +to data value, to taking a uin64_t.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_callback.html b/memcached_callback.html new file mode 100644 index 00000000..cc3d4b36 --- /dev/null +++ b/memcached_callback.html @@ -0,0 +1,891 @@ + + + + + + + + + + + Setting callbacks — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Setting callbacks
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Setting callbacks¶

+

Get and set a callback

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_callback_t¶
+
+ +
+
+memcached_return_t memcached_callback_set(memcached_st *ptr, memcached_callback_t flag, const void *data)¶
+
+ +
+
+void * memcached_callback_get(memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

libmemcached(3) can have callbacks set key execution points. These either +provide function calls at points in the code, or return pointers to +structures for particular usages.

+

memcached_callback_get() takes a callback flag and returns the +structure or function set by memcached_callback_set().

+

memcached_callback_set() changes the function/structure assigned by a +callback flag. No connections are reset.

+

You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context +if required for any of the callbacks.

+
+
+MEMCACHED_CALLBACK_CLEANUP_FUNCTION¶
+
+ +

When memcached_delete() is called this function will be excuted. At +the point of its execution all connections are closed.

+
+
+MEMCACHED_CALLBACK_CLONE_FUNCTION¶
+
+ +

When memcached_delete() is called this function will be excuted. +At the point of its execution all connections are closed.

+
+
+MEMCACHED_CALLBACK_PREFIX_KEY¶
+

See MEMCACHED_CALLBACK_NAMESPACE

+
+ +
+
+MEMCACHED_CALLBACK_NAMESPACE¶
+
+ +

You can set a value which will be used to create a domain for your keys. +The value specified here will be prefixed to each of your keys. The value can +not be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE - 1 and will +reduce MEMCACHED_MAX_KEY by the value of your key.

+

The prefix key is only applied to the primary key, not the master key. +MEMCACHED_FAILURE will be returned if no key is set. In the case of +a key which is too long, MEMCACHED_BAD_KEY_PROVIDED will be returned.

+

If you set a value with the value being NULL then the prefix key is disabled.

+
+
+MEMCACHED_CALLBACK_USER_DATA¶
+
+ +

This allows you to store a pointer to a specifc piece of data. This can be +retrieved from inside of memcached_fetch_execute(). Cloning a +memcached_st will copy the pointer to the clone.

+
+
+MEMCACHED_CALLBACK_MALLOC_FUNCTION¶
+
+ +
+

Deprecated since version <0.32: Use memcached_set_memory_allocators instead.

+
+
+
+MEMCACHED_CALLBACK_REALLOC_FUNCTION¶
+
+ +
+

Deprecated since version <0.32: Use memcached_set_memory_allocators instead.

+
+
+
+MEMCACHED_CALLBACK_FREE_FUNCTION¶
+
+ +
+

Deprecated since version <0.32: Use memcached_set_memory_allocators instead.

+
+
+
+MEMCACHED_CALLBACK_GET_FAILURE¶
+
+ +

This function implements the read through cache behavior. On failure of retrieval this callback will be called.

+

You are responsible for populating the result object provided. This result object will then be stored in the server and returned to the calling process.

+

You must clone the memcached_st in order to +make use of it. The value will be stored only if you return +MEMCACHED_SUCCESS or MEMCACHED_BUFFERED. Returning +MEMCACHED_BUFFERED will cause the object to be buffered and not sent +immediatly (if this is the default behavior based on your connection setup +this will happen automatically).

+

The prototype for this is:

+
+
+memcached_return_t (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result);
+
+ +
+
+MEMCACHED_CALLBACK_DELETE_TRIGGER¶
+
+ +

This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it.

+

The prototype for this is:

+
+
+typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length);
+
+ +
+
+

RETURN¶

+

memcached_callback_get() return the function or structure that was +provided. Upon error, nothing is set, null is returned, and the +memcached_return_t argument is set to MEMCACHED_FAILURE.

+

memcached_callback_set() returns MEMCACHED_SUCCESS upon +successful setting, otherwise MEMCACHED_FAILURE on error.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_cas.html b/memcached_cas.html new file mode 100644 index 00000000..eef6d645 --- /dev/null +++ b/memcached_cas.html @@ -0,0 +1,797 @@ + + + + + + + + + + + Working with data on the server in an atomic fashion — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Working with data on the server in an atomic fashion
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Working with data on the server in an atomic fashion¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas)¶
+
+ +
+
+memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_cas() overwrites data in the server as long as the “cas” +value is still the same in the server. You can get the cas value of a result +by calling memcached_result_cas() on a memcached_result_st(3) +structure. At the point that this note was written cas is still buggy in memached. Turning on tests for it in libmemcached(3) is optional. Please see +memcached_set() for information on how to do this.

+

memcached_cas_by_key() method behaves in a similar method as the non +key methods. The difference is that it uses the group_key parameter +to map objects to particular servers.

+

memcached_cas() is testsed with the MEMCACHED_BEHAVIOR_USE_UDP behavior enabled. However, when using these operations with this behavior +on, there are limits to the size of the payload being sent to the server. The +reason for these limits is that the Memcached Server does not allow +multi-datagram requests and the current server implementation sets a datagram +size to 1400 bytes. Due to protocol overhead, the actual limit of the user +supplied data is less than 1400 bytes and depends on the protocol in use as, +well as the operation being executed. When running with the binary protocol, +MEMCACHED_BEHAVIOR_BINARY_PROTOCOL, the size of the key,value, +flags and expiry combined may not exceed 1368 bytes. When running with the +ASCII protocol, the exact limit fluctuates depending on which function is +being executed and whether the function is a cas operation or not. For +non-cas ASCII set operations, there are at least 1335 bytes available to +split among the key, key_prefix, and value; for cas ASCII operations there +are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, exceeds 1400 bytes, a MEMCACHED_WRITE_FAILURE will be returned.

+
+
+

RETURN¶

+

All methods return a value of type memcached_return_t. +On success the value will be MEMCACHED_SUCCESS. +Use memcached_strerror() to translate this value to a printable +string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemached(3) memcached_strerror(3) memcached_set(3) memcached_append(3) memcached_add(3) memcached_prepend(3) memcached_replace(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_create.html b/memcached_create.html new file mode 100644 index 00000000..48d545f7 --- /dev/null +++ b/memcached_create.html @@ -0,0 +1,812 @@ + + + + + + + + + + + Creating and destroying a memcached_st — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Creating and destroying a memcached_st
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Creating and destroying a memcached_st¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_st¶
+
+ +
+
+memcached_st* memcached_create(memcached_st *ptr)¶
+
+ +
+
+void memcached_free(memcached_st *ptr)¶
+
+ +
+
+memcached_st* memcached_clone(memcached_st *destination, memcached_st *source)¶
+
+ +
+
+void memcached_servers_reset(memcached_st)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_create() is used to create a 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 +memcached_st to 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 +memcached() over memcached_create().

+

memcached_clone() is similar to memcached_create() but +it copies the defaults and list of servers from the source +memcached_st. If you pass a null as the argument for the source +to clone, it is the same as a call to memcached_create(). +If the destination argument is NULL a memcached_st will be allocated +for you.

+

memcached_servers_reset() allows you to zero out the list of +servers that the memcached_st has.

+

To clean up memory associated with a memcached_st structure you +should pass it to memcached_free() when you are finished using it. +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 +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 (or initialized). On an allocation failure, it returns NULL.

+

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: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_delete.html b/memcached_delete.html new file mode 100644 index 00000000..7cb38e67 --- /dev/null +++ b/memcached_delete.html @@ -0,0 +1,790 @@ + + + + + + + + + + + Deleting data from a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Deleting data from a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Deleting data from a server¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_delete(memcached_st *ptr, const char *key, size_t key_length, time_t expiration)¶
+
+ +
+
+memcached_return_t memcached_delete_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_delete() is used to delete a particular key. +memcached_delete_by_key() works the same, but it takes a master key +to find the given value.

+

Expiration works by placing the item into a delete queue, which means that +it won’t be possible to retrieve it by the “get” command. The “add” and +“replace” commands with this key will also fail (the “set” command will +succeed, however). After the time passes, the item is finally deleted from server memory.

+

Please note the the Danga memcached server removed tests for expiration in +the 1.4 version.

+
+
+

RETURN¶

+

A value of type memcached_return_t is returned +On success that value will be MEMCACHED_SUCCESS. +Use memcached_strerror() to translate this value to a printable +string.

+

If you are using the non-blocking mode of the library, success only +means that the message was queued for delivery.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_dump.html b/memcached_dump.html new file mode 100644 index 00000000..0bb4bfde --- /dev/null +++ b/memcached_dump.html @@ -0,0 +1,785 @@ + + + + + + + + + + + Dumping data from a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Dumping data from a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Dumping data from a server¶

+

Get a list of keys found on memcached servers

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_dump(memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)¶
+
+ +
+
+memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_dump() is used to get a list of keys found in memcached(1) +servers. Because memcached(1) does not guarentee to dump all keys you can not +assume you have fetched all keys from the server. The function takes an array +of callbacks that it will use to execute on keys as they are found.

+

Currently the binary protocol is not testsed.

+
+
+

RETURN¶

+

A value of type memcached_return_t is returned +On success that value will be MEMCACHED_SUCCESS. +Use memcached_strerror() to translate this value to a printable +string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_flush.html b/memcached_flush.html new file mode 100644 index 00000000..10768986 --- /dev/null +++ b/memcached_flush.html @@ -0,0 +1,780 @@ + + + + + + + + + + + Wiping clean the contents of a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Wiping clean the contents of a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Wiping clean the contents of a server¶

+

Wipe contents of memcached servers

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_flush(memcached_st *ptr, time_t expiration)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

:c:func::memcached_flush is used to wipe clean the contents of memcached servers. +It will either do this immediately or expire the content based on the +expiration time passed to the method (a value of zero causes an immediate +flush). The operation is not atomic to multiple servers, just atomic to a +single server. That is, it will flush the servers in the order that they were +added.

+
+
+

RETURN¶

+

A value of type memcached_return_t is returned +On success that value will be MEMCACHED_SUCCESS. +Use memcached_strerror to translate this value to a printable string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_flush_buffers.html b/memcached_flush_buffers.html new file mode 100644 index 00000000..54b5cb35 --- /dev/null +++ b/memcached_flush_buffers.html @@ -0,0 +1,778 @@ + + + + + + + + + + + Flushing client buffers — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Flushing client buffers
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Flushing client buffers¶

+

Flush and senf buffered commands

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_flush_buffers(memcached_st *ptr)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_flush_buffers() is used in conjunction with +MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.

+
+
+

RETURN¶

+

A value of type memcached_return_t is returned +On success that value will be MEMCACHED_SUCCESS. +Use memcached_strerror() to translate this value to a printable +string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+

Trond Norbye, <trond.norbye@gmail.com>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_generate_hash_value.html b/memcached_generate_hash_value.html new file mode 100644 index 00000000..884de93c --- /dev/null +++ b/memcached_generate_hash_value.html @@ -0,0 +1,850 @@ + + + + + + + + + + + Generating hash values directly — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Generating hash values directly
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Generating hash values directly¶

+

Hash a key value

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_hash_t¶
+
+ +
+
+uint32_t memcached_generate_hash_value(const char *key, size_t key_length, memcached_hash_t hash_algorithm)¶
+
+ +
+
+uint32_t memcached_generate_hash(memcached_st *ptr, const char *key, size_t key_length)¶
+
+ +
+
+MEMCACHED_HASH_DEFAULT¶
+
+ +
+
+MEMCACHED_HASH_MD5¶
+
+ +
+
+MEMCACHED_HASH_CRC¶
+
+ +
+
+MEMCACHED_HASH_FNV1_64¶
+
+ +
+
+MEMCACHED_HASH_FNV1A_64¶
+
+ +
+
+MEMCACHED_HASH_FNV1_32¶
+
+ +
+
+MEMCACHED_HASH_FNV1A_32¶
+
+ +
+
+MEMCACHED_HASH_JENKINS¶
+
+ +
+
+MEMCACHED_HASH_MURMUR¶
+
+ +
+
+MEMCACHED_HASH_HSIEH¶
+
+ +
+
+MEMCACHED_HASH_MURMUR3¶
+
+ +

Compile and link with -lmemcachedutil -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_generate_hash_value() allows you to hash a key using one of +the hash functions defined in the library. This method is provided for +the convenience of higher-level language bindings and is not necessary +for normal memcache operations.

+

The allowed hash algorithm constants are listed in the manpage for +memcached_behavior_set().

+

memcached_generate_hash() takes a memcached_st struture +and produces the hash value that would have been generated based on the +defaults of memcached_st.

+

As of version 0.36 all hash methods have been placed into the library +libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.

+
+
+

RETURN¶

+

A 32-bit integer which is the result of hashing the given key. +For 64-bit hash algorithms, only the least-significant 32 bits are +returned.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_get.html b/memcached_get.html new file mode 100644 index 00000000..37388582 --- /dev/null +++ b/memcached_get.html @@ -0,0 +1,865 @@ + + + + + + + + + + + Retrieving data from the server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Retrieving data from the server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Retrieving data from the server¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_result_st * memcached_fetch_result(memcached_st *ptr, memcached_result_st *result, memcached_return_t *error)¶
+
+ +
+
+char * memcached_get(memcached_st *ptr, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)¶
+
+ +
+
+memcached_return_t memcached_mget(memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys)¶
+
+ +
+
+char * memcached_get_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)¶
+
+ +
+
+memcached_return_t memcached_mget_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys)¶
+
+ +
+
+memcached_return_t memcached_fetch_execute(memcached_st *ptr, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)¶
+
+ +
+
+memcached_return_t memcached_mget_execute(memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)¶
+
+ +
+
+memcached_return_t memcached_mget_execute_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)¶
+
+ +
+
+memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_get() is used to fetch an individual value from the server. +You must pass in a key and its length to fetch the object. You must supply +three pointer variables which will give you the state of the returned +object. A uint32_t pointer to contain whatever flags you stored with the value, a size_t pointer which will be filled with size of of +the object, and a memcached_return_t pointer to hold any error. The +object will be returned upon success and NULL will be returned on failure. Any +object returned by memcached_get() must be released by the caller +application.

+

memcached_mget() is used to select multiple keys at once. For +multiple key operations it is always faster to use this function. This function always works asynchronously.

+

To retrieve data after a successful execution of memcached_mget(), you will need to +call memcached_fetch_result(). You should continue to call this function until +it returns a NULL (i.e. no more values). If you need to quit in the middle of a +memcached_mget() call, you can execute a memcached_quit(), those this is not required.

+

memcached_fetch_result() is used to fetch an individual value from the server. memcached_mget() must always be called before using this method. +You must pass in a key and its length to fetch the object. You must supply +three pointer variables which will give you the state of the returned +object. A uint32_t pointer to contain whatever flags you stored with the value, a size_t pointer which will be filled with size of of the +object, and a memcached_return_t pointer to hold any error. The +object will be returned upon success and NULL will be returned on failure. MEMCACHED_END is returned by the *error value when all objects that have been found are returned. The final value upon MEMCACHED_END is null.

+

memcached_fetch_result() is used to return a memcached_result_st structure from a memcached server. The result object is forward compatible +with changes to the server. For more information please refer to the +memcached_result_st help. This function will dynamically allocate a +result structure for you if you do not pass one to the function.

+

memcached_fetch_execute() is a callback function for result sets. +Instead of returning the results to you for processing, it passes each of the +result sets to the list of functions you provide. It passes to the function +a memcached_st that can be cloned for use in the called +function (it can not be used directly). It also passes a result set which does +not need to be freed. Finally it passes a “context”. This is just a pointer to +a memory reference you supply the calling function. Currently only one value +is being passed to each function call. In the future there will be an option +to allow this to be an array.

+

memcached_mget_execute() and memcached_mget_execute_by_key() +is similar to memcached_mget(), but it may trigger the supplied +callbacks with result sets while sending out the queries. If you try to +perform a really large multiget with memcached_mget() you may +encounter a deadlock in the OS kernel (it will fail to write data to the +socket because the input buffer is full). memcached_mget_execute() +solves this problem by processing some of the results before continuing +sending out requests. Please note that this function is only available in +the binary protocol.

+

memcached_get_by_key() and memcached_mget_by_key() behave +in a similar nature as memcached_get() and memcached_mget(). +The difference is that they take a master key that is used for determining +which server an object was stored if key partitioning was used for storage.

+

All of the above functions are not tested when the +MEMCACHED_BEHAVIOR_USE_UDP has been set. Executing any of these +functions with this behavior on will result in MEMCACHED_NOT_SUPPORTED being returned, or for those functions which do not return a memcached_return_t, the error function parameter will be set to MEMCACHED_NOT_SUPPORTED.

+
+
+

RETURN¶

+

All objects retrieved via memcached_get() or memcached_get_by_key() must be freed with free(3).

+

memcached_get() will return NULL on +error. You must look at the value of error to determine what the actual error +was.

+

memcached_fetch_execute() return MEMCACHED_SUCCESS if +all keys were successful. MEMCACHED_NOTFOUND will be return if no +keys at all were found.

+

memcached_fetch_result() sets error +to MEMCACHED_END upon successful conclusion. +MEMCACHED_NOTFOUND will be return if no keys at all were found.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_memory_allocators.html b/memcached_memory_allocators.html new file mode 100644 index 00000000..ef6ce44d --- /dev/null +++ b/memcached_memory_allocators.html @@ -0,0 +1,821 @@ + + + + + + + + + + + Use custom allocators for embedded usage — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Use custom allocators for embedded usage
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Use custom allocators for embedded usage¶

+

Manage memory allocator functions

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_set_memory_allocators(memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context)¶
+
+ +
+
+void memcached_get_memory_allocators(memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc)¶
+
+ +
+
+void * memcached_get_memory_allocators_context(const memcached_st *ptr)¶
+
+ +
+
+void * (*memcached_malloc_fn)(memcached_st *ptr, const size_t size, void *context)¶
+
+ +
+
+void * (*memcached_realloc_fn)(memcached_st *ptr, void *mem, const size_t size, void *context)¶
+
+ +
+
+void (*memcached_free_fn)(memcached_st *ptr, void *mem, void *context)¶
+
+ +
+
+void * (*memcached_calloc_fn)(memcached_st *ptr, size_t nelem, const size_t elsize, void *context)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

libmemcached(3) allows you to specify your own memory allocators, optimized +for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.

+

memcached_set_memory_allocators() is used to set the memory +allocators used by the memcached instance specified by ptr. Please note that +you cannot override only one of the memory allocators, you have to specify a +complete new set if you want to override one of them. All of the memory +allocation functions should behave as specified in the C99 standard. Specify +NULL as all functions to reset them to the default values.

+

memcached_get_memory_allocators() is used to get the currently used +memory allocators by a mamcached handle.

+

memcached_get_memory_allocators_context() returns the void * that +was passed in during the call to memcached_set_memory_allocators().

+

The first argument to the memory allocator functions is a pointer to a +memcached structure, the is passed as const and you will need to clone +it in order to make use of any operation which would modify it.

+
+
+

NOTES¶

+

In version 0.38 all functions were modified to have a context void pointer +passed to them. This was so that customer allocators could have their +own space for memory.

+
+
+

RETURN¶

+

memcached_set_memory_allocators() return MEMCACHED_SUCCESS +upon success, and MEMCACHED_FAILURE if you don’t pass a complete set +of function pointers.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_pool.html b/memcached_pool.html new file mode 100644 index 00000000..04494ed9 --- /dev/null +++ b/memcached_pool.html @@ -0,0 +1,851 @@ + + + + + + + + + + + Working with memcached pools — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Working with memcached pools
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Working with memcached pools¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached_pool.h>

+
+
+memcached_pool_st¶
+
+ +
+
+memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length)¶
+
+ +
+
+memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)¶
+
+ +
+

Deprecated since version 0.46: Use memcached_pool()

+
+
+
+memcached_st* memcached_pool_destroy(memcached_pool_st* pool)¶
+
+ +
+
+memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc)¶
+
+ +
+

Deprecated since version 0.53: Use memcached_pool_fetch()

+
+
+
+memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc)¶
+
+ +
+

New in version 0.53: Synonym for memcached_pool_pop

+
+
+
+memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)¶
+
+ +
+

Deprecated since version 0.53: Use memcached_pool_push()

+
+
+
+memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc)¶
+
+ +
+

New in version 0.53: Synonym for memcached_pool_push.

+
+
+
+memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)¶
+
+ +
+
+memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)¶
+
+ +

Compile and link with -lmemcachedutil -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_pool() is used to create a connection pool of objects you +may use to remove the overhead of using memcached_clone for short lived +memcached_st objects. Please see Configuring Libmemcached for details on the format of the configuration string.

+

memcached_pool_destroy() is used to destroy the connection pool +created with memcached_pool_create() and release all allocated +resources. It will return the pointer to the memcached_st structure +passed as an argument to memcached_pool_create(), and returns the ownership of the pointer to the caller when created with memcached_pool_create(), otherwise NULL is returned..

+

memcached_pool_fetch() is used to fetch a connection structure from the +connection pool. The relative_time argument specifies if the function should +block and wait for a connection structure to be available if we try +to exceed the maximum size. You need to specify time in relative time.

+

memcached_pool_release() is used to return a connection structure back to the pool.

+

memcached_pool_behavior_get() and memcached_pool_behavior_set() is used to get/set behavior flags on all connections in the pool.

+

Both memcached_pool_release() and memcached_pool_fetch() are thread safe.

+
+
+

RETURN¶

+

memcached_pool_destroy() returns the pointer (and ownership) to the memcached_st structure used to create the pool. If connections are in use it returns NULL.

+

memcached_pool_pop() returns a pointer to a memcached_st structure from the pool (or NULL if an allocation cannot be satisfied).

+

memcached_pool_release() returns MEMCACHED_SUCCESS upon success.

+

memcached_pool_behavior_get() and memcached_pool_behavior_get() returns MEMCACHED_SUCCESS upon success.

+

If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.

+

memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+

Trond Norbye, <trond.norbye@gmail.com>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3) libmemcached_configuration(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_quit.html b/memcached_quit.html new file mode 100644 index 00000000..a73f470f --- /dev/null +++ b/memcached_quit.html @@ -0,0 +1,780 @@ + + + + + + + + + + + Disconnecting a client from a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Disconnecting a client from a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Disconnecting a client from a server¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+void memcached_quit(memcached_st *ptr)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_quit() will disconnect you from all currently connected +servers. It will also reset the state of the connection (ie, any memcached_fetch() you are in the middle of will be terminated). This function is +called automatically when you call memcached_free() on the memcached_st structure.

+

You do not need to call this on your own. All operations to change server +hashes and parameters will handle connections to the server for you. This +function is provided mainly so that you can timeout your connections or +reset connections during the middle of a memcached_fetch().

+
+
+

RETURN¶

+

A value of type memcached_return_t is returned On success that value +will be MEMCACHED_SUCCESS. Use memcached_strerror() to +translate this value to a printable string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_result_st.html b/memcached_result_st.html new file mode 100644 index 00000000..ddc29ffa --- /dev/null +++ b/memcached_result_st.html @@ -0,0 +1,869 @@ + + + + + + + + + + + Working with result sets — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Working with result sets
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Working with result sets¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached_pool.h>

+
+
+memcached_result_st¶
+
+ +
+
+memcached_result_st * memcached_result_create(memcached_st *ptr, memcached_result_st *result)¶
+
+ +
+
+void memcached_result_free(memcached_result_st *result)¶
+
+ +
+
+const char * memcached_result_key_value(memcached_result_st *result)¶
+
+ +
+
+size_t memcached_result_key_length(const memcached_result_st *result)¶
+
+ +
+
+const char *memcached_result_value(memcached_result_st *ptr)¶
+
+ +
+
+char *memcached_result_take_value(memcached_result_st *ptr)¶
+
+ +
+
+size_t memcached_result_length(const memcached_result_st *ptr)¶
+
+ +
+
+uint32_t memcached_result_flags(const memcached_result_st *result)¶
+
+ +
+
+uint64_t memcached_result_cas(const memcached_result_st *result)¶
+
+ +
+
+memcached_return_t memcached_result_set_value(memcached_result_st *ptr, const char *value, size_t length)¶
+
+ +
+
+void memcached_result_set_flags(memcached_result_st *ptr, uint32_t flags)¶
+
+ +
+
+void memcached_result_set_expiration(memcached_result_st *ptr, time_t)¶
+
+ +

Compile and link with -lmemcachedutil -lmemcached

+
+
+

DESCRIPTION¶

+

libmemcached(3) can optionally return a memcached_result_st which +acts as a result object. The result objects have added benefits over the +character pointer returns, in that they are forward compatible with new +return items that future memcached servers may implement (the best current +example of this is the CAS return item). The structures can also be reused, +which will save on calls to malloc(3). It is suggested that you use result +objects over char * return functions.

+

The structure of memcached_result_st has been encapsulated, you should +not write code to directly access members of the structure.

+

memcached_result_create() will either allocate memory for a +memcached_result_st or will initialize a structure passed to it.

+

memcached_result_free() will deallocate any memory attached to the +structure. If the structure was also allocated, it will deallocate it.

+

memcached_result_key_value() returns the key value associated with the +current result object.

+

memcached_result_key_length() returns the key length associated with +the current result object.

+

memcached_result_value() returns the result value associated with the +current result object.

+

memcached_result_take_value() returns and hands over the result value +associated with the current result object. You must call free() to release this +value, unless you have made use of a custom allocator. Use of a custom +allocator requires that you create your own custom free() to release it.

+

memcached_result_length() returns the result length associated with +the current result object.

+

memcached_result_flags() returns the flags associated with the +current result object.

+

memcached_result_cas() returns the cas associated with the +current result object. This value will only be available if the server +tests it.

+

memcached_result_set_value() takes a byte array and a size and sets +the result to this value. This function is used for trigger responses.

+

memcached_result_set_flags() takes a result structure and stores a new +value for the flags field.

+

memcached_result_set_expiration() takes a result structure and stores +a new value for the expiration field (this is only used by read through +triggers).

+

You may wish to avoid using memcached_result_create(3) with a +stack based allocation. The most common issues related to ABI safety involve +heap allocated structures.

+
+
+

RETURN¶

+

Varies, see particular functions. All structures must have +memcached_result_free() called on them for cleanup purposes. Failure +to do this will result in leaked memory.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_sasl.html b/memcached_sasl.html new file mode 100644 index 00000000..b0532db9 --- /dev/null +++ b/memcached_sasl.html @@ -0,0 +1,800 @@ + + + + + + + + + + + SASL support — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • SASL support
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

SASL support¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached_pool.h>

+
+
+void memcached_set_sasl_callbacks(memcached_st *ptr, const sasl_callback_t *callbacks)¶
+
+ +
+
+const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)¶
+
+ +
+
+memcached_return_t memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password)¶
+
+ +
+
+memcached_return_t memcached_destroy_sasl_auth_data(memcached_st *ptr)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

libmemcached(3) allows you to plug in your own callbacks function used by +libsasl to perform SASL authentication.

+

Please note that SASL requires the memcached binary protocol, and you have +to specify the callbacks before you connect to the server.

+

memcached_set_sasl_auth_data() is a helper function defining +the basic functionality for you, but it will store the username and password +in memory. If you choose to use this method you have to call +memcached_destroy_sasl_auth_data before calling +memcached_free to avoid a memory leak. You should NOT call +memcached_destroy_sasl_auth_data if you specify your own callback +function with memcached_set_sasl_callbacks().

+
+
+

RETURN¶

+

memcached_get_sasl_callbacks() returns the callbacks currently used by +this memcached handle. memcached_set_sasl_auth_data() returns +MEMCACHED_SUCCESS upon success.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+

Trond Norbye, <trond.norbye@gmail.com>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_server_st.html b/memcached_server_st.html new file mode 100644 index 00000000..9e2979a7 --- /dev/null +++ b/memcached_server_st.html @@ -0,0 +1,832 @@ + + + + + + + + + + + Managing lists of servers — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Managing lists of servers
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Managing lists of servers¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+const memcached_instance_st *
+
+ +
+
+memcached_server_list_st¶
+
+ +
+
+memcached_server_st¶
+
+ +
+
+const const memcached_instance_st * memcached_server_list(memcached_st *ptr)¶
+
+ +
+
+void memcached_server_list_free(memcached_server_list_st list)¶
+
+ +
+
+memcached_server_list_st memcached_server_list_append(memcached_server_list_st list, const char *hostname, in_port_t port, memcached_return_t *error)¶
+
+ +
+
+uint32_t memcached_server_list_count(memcached_server_list_st list)¶
+
+ +
+
+const char *memcached_server_error(const memcached_instance_st * instance)¶
+
+ +
+
+void memcached_server_error_reset(const memcached_instance_st * list)¶
+
+ +
+

Deprecated since version 0.39.

+
+
+
+void memcached_servers_parse()¶
+
+ +
+

Deprecated since version 0.39.

+
+

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

libmemcached(3) operates on a list of hosts which are stored in +memcached_server_st structures. You should not modify these structures +directly. Functions are provided to modify these structures (and more can be +added, just ask!).

+

memcached_server_list() is used to provide an array of all defined hosts. This was incorrectly documented as “requiring free” up till version 0.39.

+

memcached_server_list_free() deallocates all memory associated with the array of memcached_server_st that you passed to it.

+

memcached_server_list_append() adds a server to the end of a +memcached_server_st array. On error null will be returned and the +memcached_return_t pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default +port of a memcached server.

+

DEPRECATED memcached_servers_parse(), please see memcached()

+

memcached_server_error() can be used to look at the text of the last error message sent by the server to to the client.

+

Before version 0.39 theses functions used a memcache_server_st *. In 0.39 +memcached_server_st * was aliased to memcached_server_list_st. This was done for a style reason to help clean up some concepts in the code.

+
+
+

RETURN¶

+

Varies, see particular functions.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_servers.html b/memcached_servers.html new file mode 100644 index 00000000..bb9b5fd6 --- /dev/null +++ b/memcached_servers.html @@ -0,0 +1,838 @@ + + + + + + + + + + + Manipulate the server information stored in memcached_st — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Manipulate the server information stored in memcached_st
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Manipulate the server information stored in memcached_st¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_server_fn¶
+
+ +
+
+uint32_t memcached_server_count(memcached_st *ptr)¶
+
+ +
+
+memcached_return_t memcached_server_add(memcached_st *ptr, const char *hostname, in_port_t port)¶
+
+ +
+
+memcached_return_t memcached_server_add_udp(memcached_st *ptr, const char *hostname, in_port_t port)¶
+
+ +
+
+memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr, const char *socket)¶
+
+ +
+
+memcached_return_t memcached_server_push(memcached_st *ptr, const memcached_server_st *list)¶
+
+ +
+
+const memcached_instance_st * memcached_server_by_key(memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error)¶
+
+ +
+
+const memcached_instance_st * memcached_server_get_last_disconnect(const memcached_st *ptr)¶
+
+ +
+
+memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks)¶
+
+ +

compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

Introducing the C Client Library for memcached performs operations on a list of hosts. The order of +these hosts determine routing to keys. Functions are provided to add keys to +memcached_st structures. To manipulate lists of servers see +memcached_server_st(3).

+

memcached_server_count() provides you a count of the current number of +servers being used by a memcached_st structure.

+
+
memcached_server_add() pushes a single TCP server into the memcached_st structure. This server will be placed at the end. Duplicate servers

are allowed, so duplication is not checked. Executing this function with the MEMCACHED_BEHAVIOR_USE_UDP behavior set will result in a MEMCACHED_INVALID_HOST_PROTOCOL.

+
+
+

memcached_server_add_udp() pushes a single UDP server into the memcached_st structure. This server will be placed at the end. Duplicate +servers are allowed, so duplication is not checked. Executing this function with out setting the MEMCACHED_BEHAVIOR_USE_UDP behavior will result in a +MEMCACHED_INVALID_HOST_PROTOCOL.

+

memcached_server_add_unix_socket() pushes a single UNIX socket into the memcached_st structure. This UNIX socket will be placed at the end. +Duplicate servers are allowed, so duplication is not checked. The length +of the filename must be one character less than MEMCACHED_MAX_HOST_LENGTH.

+

memcached_server_push() pushes an array of memcached_server_st into the memcached_st structure. These servers will be placed at +the end. Duplicate servers are allowed, so duplication is not checked. A +copy is made of structure so the list provided (and any operations on +the list) are not saved.

+

memcached_server_by_key() allows you to provide a key and retrieve the +server which would be used for assignment.

+

memcached_server_get_last_disconnect() returns a pointer to the last +server for which there was a connection problem. It does not mean this +particular server is currently dead but if the library is reporting a server +is, the returned server is a very good candidate.

+

memcached_server_cursor() takes a memcached_st and loops through the +list of hosts currently in the cursor calling the list of callback +functions provided. You can optionally pass in a value via +context which will be provided to each callback function. An error +return from any callback will terminate the loop. memcached_server_cursor() is passed the original caller memcached_st in its current state.

+
+
+

RETURN¶

+

Varies, see particular functions.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_set.html b/memcached_set.html new file mode 100644 index 00000000..5e4fc2ce --- /dev/null +++ b/memcached_set.html @@ -0,0 +1,825 @@ + + + + + + + + + + + Store, replace, add, or atomically add data to the server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Store, replace, add, or atomically add data to the server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Store, replace, add, or atomically add data to the server¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_set(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)¶
+
+ +
+
+memcached_return_t memcached_add(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)¶
+
+ +
+
+memcached_return_t memcached_replace(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)¶
+
+ +
+
+memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)¶
+
+ +
+
+memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)¶
+
+ +
+
+memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_set(), memcached_add(), and memcached_replace() are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you +store the object. Keys are currently limited to 250 characters by the +memcached(1) server. You must supply both a value and a length. Optionally you +may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). “flags” is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.

+

memcached_set() will write an object to the server. If an object +already exists it will overwrite what is in the server. If the object does not +exist it will be written. If you are using the non-blocking mode this function +will always return true unless a network error occurs.

+

memcached_replace() replaces an object on the server. If the object is not found on the server an error occurs.

+

memcached_add() adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.

+

memcached_cas() overwrites data in the server as long as the “cas” +value is still the same in the server. You can get the cas value of a result by +calling memcached_result_cas() on a memcached_result_st(3) structure. At the point +that this note was written cas is still buggy in memached. Turning on tests +for it in libmemcached(3) is optional. Please see memcached_set for +information on how to do this.

+

memcached_set_by_key(), memcached_add_by_key(), and memcached_replace_by_key() methods all behave in a similar method as the non +key methods. The difference is that they use their group_key parameter to map +objects to particular servers.

+

If you are looking for performance, memcached_set() with non-blocking IO is the fastest way to store data on the server.

+

All of the above functions are testsed with the MEMCACHED_BEHAVIOR_USE_UDP behavior enabled. However, when using these operations with this behavior +on, there are limits to the size of the payload being sent to the server. +The reason for these limits is that the Memcached Server does not allow +multi-datagram requests and the current server implementation sets a datagram +size to 1400 bytes. Due to protocol overhead, the actual limit of the user supplied data is less than 1400 bytes and depends on the protocol in use as, well as the operation being +executed. When running with the binary protocol, MEMCACHED_BEHAVIOR_BINARY_PROTOCOL, the size of the key,value, flags and expiry combined may not +exceed 1368 bytes. When running with the ASCII protocol, the exact limit fluctuates depending on which function is being executed and whether the function is a cas operation or not. For non-cas ASCII set operations, there are at least +1335 bytes available to split among the key, key_prefix, and value; for cas +ASCII operations there are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, +exceeds 1400 bytes, a MEMCACHED_WRITE_FAILURE will be returned.

+
+
+

RETURN¶

+

All methods return a value of type memcached_return_t. +On success the value will be MEMCACHED_SUCCESS. +Use memcached_strerror() to translate this value to a printable string.

+

For memcached_replace() and memcached_add(), MEMCACHED_NOTSTORED is a legitmate error in the case of a collision.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemached(3) memcached_strerror(3) memcached_prepend(3) memcached_cas(3) memcached_append(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_stats.html b/memcached_stats.html new file mode 100644 index 00000000..5c778196 --- /dev/null +++ b/memcached_stats.html @@ -0,0 +1,817 @@ + + + + + + + + + + + Working with statistical information from a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Working with statistical information from a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Working with statistical information from a server¶

+

Get memcached statistics

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_stat_st¶
+
+ +
+
+memcached_return_t (*memcached_stat_fn)(const memcached_instance_st * server, const char *key, size_t key_length, const char *value, size_t value_length, void *context)¶
+
+ +
+
+memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return_t *error)¶
+
+ +
+
+memcached_return_t memcached_stat_servername(memcached_stat_st *stat, char *args, const char *hostname, in_port_t port)¶
+
+ +
+
+char * memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error)¶
+
+ +
+
+char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)¶
+
+ +
+
+memcached_return_t memcached_stat_execute(memcached_st *memc, const char *args, memcached_stat_fn func, void *context)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

libmemcached(3) has the ability to query a memcached server (or collection +of servers) for their current state. Queries to find state return a +memcached_stat_st structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. memcached_stat_get_value() has been provided to query the structure.

+

memcached_stat_execute() uses the servers found in memcached_stat_st and executes a “stat” command on each server. args is an optional argument that can be passed in to modify the behavior of “stats”. You will need to supply a callback function that will be supplied each pair of values returned by +the memcached server.

+

memcached_stat() fetches an array of memcached_stat_st structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the MEMCACHED_BEHAVIOR_USE_UDP behavior set, a NULL value is returned and the error parameter is set to MEMCACHED_NOT_SUPPORTED.

+

memcached_stat_servername() can be used standalone without a memcached_st to obtain the state of a particular server. “args” is used to define a particular state object (a list of these are not provided for by either +the memcached_stat_get_keys() call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to +obtain information on.

+

memcached_stat_get_value() returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.

+

memcached_stat_get_keys() returns a list of keys that the server has state objects on. You are responsible for freeing this list.

+

A command line tool, memstat(1), is provided so that you do not have to write +an application to do this.

+
+
+

RETURN¶

+

Varies, see particular functions.

+

Any method returning a memcached_stat_st expects you to free the +memory allocated for it.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

AUTHOR¶

+

Brian Aker, <brian@tangent.org>

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_strerror.html b/memcached_strerror.html new file mode 100644 index 00000000..9951b92b --- /dev/null +++ b/memcached_strerror.html @@ -0,0 +1,771 @@ + + + + + + + + + + + Coverting Errors, memcached_return_t, to strings — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Coverting Errors, memcached_return_t, to strings
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Coverting Errors, memcached_return_t, to strings¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+const char * memcached_strerror(memcached_st *ptr, memcached_return_t rc)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_strerror() takes a memcached_return_t value and returns a string describing the error.

+

This string must not be modified by the application.

+

memcached_return_t values are returned from nearly all libmemcached(3) functions.

+

memcached_return_t values are of an enum type so that you can set up responses with switch/case and know that you are capturing all possible return values.

+
+
+

RETURN¶

+

memcached_strerror() returns a string describing a memcached_return_t value.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_user_data.html b/memcached_user_data.html new file mode 100644 index 00000000..e8baa77b --- /dev/null +++ b/memcached_user_data.html @@ -0,0 +1,783 @@ + + + + + + + + + + + Storing custom user information in the client. — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Storing custom user information in the client.
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Storing custom user information in the client.¶

+

Manage user specific data

+
+

LIBRARY¶

+

C Client Library for memcached (libmemcached, -lmemcached)

+
+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+void *memcached_get_user_data(memcached_st *ptr)¶
+
+ +
+
+void *memcached_set_user_data(memcached_st *ptr, void *data)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

libmemcached(3) allows you to store a pointer to a user specific data inside +the memcached_st structure.

+

memcached_set_user_data() is used to set the user specific data in the +memcached_st structure.

+

memcached_get_user_data() is used to retrieve the user specific data in the memcached_st structure.

+
+
+

RETURN¶

+

memcached_set_user_data() returns the previous value of the user specific data.

+

memcached_get_user_data() returns the current value uf the user specific data.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_verbosity.html b/memcached_verbosity.html new file mode 100644 index 00000000..02a23350 --- /dev/null +++ b/memcached_verbosity.html @@ -0,0 +1,772 @@ + + + + + + + + + + + Setting the verbosity of a server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Setting the verbosity of a server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Setting the verbosity of a server¶

+

Modifiy verbosity of servers

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+memcached_return_t memcached_verbosity(memcached_st *ptr, uint32_t verbosity)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_verbosity() modifies the “verbosity” of the +memcached(1) servers referenced in the memcached_st parameter.

+
+
+

RETURN¶

+

A value of type memcached_return_t is returned.

+

On success that value will be MEMCACHED_SUCCESS.

+

Use memcached_strerror() to translate this value to a printable string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/memcached_version.html b/memcached_version.html new file mode 100644 index 00000000..e86a6026 --- /dev/null +++ b/memcached_version.html @@ -0,0 +1,779 @@ + + + + + + + + + + + Getting version information about the client and server — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Getting version information about the client and server
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Getting version information about the client and server¶

+
+

SYNOPSIS¶

+

#include <libmemcached/memcached.h>

+
+
+const char * memcached_lib_version(void)¶
+
+ +
+
+memcached_return_t memcached_version(memcached_st *ptr)¶
+
+ +

Compile and link with -lmemcached

+
+
+

DESCRIPTION¶

+

memcached_lib_version() is used to return a simple version string representing the libmemcached version (client library version, not server version)

+

memcached_version() is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.

+
+
+

RETURN¶

+

memcached_lib_version() returns a string with the version of the libmemcached driver.

+

A value of memcached_return_t is returned from :c:func:’memcached_version’

+

On success that value will be MEMCACHED_SUCCESS.

+

If called with the MEMCACHED_BEHAVIOR_USE_UDP() behavior set, the value MEMCACHED_NOT_SUPPORTED will be returned.

+

Use memcached_strerror() to translate this value to +a printable string.

+
+
+

HOME¶

+

To find out more information please check: +http://libmemcached.org/

+
+
+

SEE ALSO¶

+

memcached(1) libmemcached(3) memcached_strerror(3)

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 00000000..08ad83aa Binary files /dev/null and b/objects.inv differ diff --git a/search.html b/search.html new file mode 100644 index 00000000..f3ea6cca --- /dev/null +++ b/search.html @@ -0,0 +1,747 @@ + + + + + + + + + + + Search — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Search
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ + + + +
+ +
+ +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 00000000..8b995ec3 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["bin/memaslap","bin/memcapable","bin/memcat","bin/memcp","bin/memdump","bin/memerror","bin/memexist","bin/memflush","bin/memparse","bin/memping","bin/memrm","bin/memslap","bin/memstat","bin/memtouch","client_errors/MEMCACHED_AUTH_CONTINUE","client_errors/MEMCACHED_AUTH_FAILURE","client_errors/MEMCACHED_AUTH_PROBLEM","client_errors/MEMCACHED_BAD_KEY_PROVIDED","client_errors/MEMCACHED_BUFFERED","client_errors/MEMCACHED_CLIENT_ERROR","client_errors/MEMCACHED_CONNECTION_BIND_FAILURE","client_errors/MEMCACHED_CONNECTION_FAILURE","client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE","client_errors/MEMCACHED_DATA_DOES_NOT_EXIST","client_errors/MEMCACHED_DATA_EXISTS","client_errors/MEMCACHED_DELETED","client_errors/MEMCACHED_DEPRECATED","client_errors/MEMCACHED_E2BIG","client_errors/MEMCACHED_END","client_errors/MEMCACHED_ERRNO","client_errors/MEMCACHED_FAILURE","client_errors/MEMCACHED_FAIL_UNIX_SOCKET","client_errors/MEMCACHED_FETCH_NOTFINISHED","client_errors/MEMCACHED_HOST_LOOKUP_FAILURE","client_errors/MEMCACHED_INVALID_ARGUMENTS","client_errors/MEMCACHED_INVALID_HOST_PROTOCOL","client_errors/MEMCACHED_ITEM","client_errors/MEMCACHED_KEY_TOO_BIG","client_errors/MEMCACHED_MAXIMUM_RETURN","client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE","client_errors/MEMCACHED_NOTFOUND","client_errors/MEMCACHED_NOTSTORED","client_errors/MEMCACHED_NOT_SUPPORTED","client_errors/MEMCACHED_NO_KEY_PROVIDED","client_errors/MEMCACHED_NO_SERVERS","client_errors/MEMCACHED_PARSE_ERROR","client_errors/MEMCACHED_PARSE_USER_ERROR","client_errors/MEMCACHED_PARTIAL_READ","client_errors/MEMCACHED_PROTOCOL_ERROR","client_errors/MEMCACHED_READ_FAILURE","client_errors/MEMCACHED_SERVER_ERROR","client_errors/MEMCACHED_SERVER_MARKED_DEAD","client_errors/MEMCACHED_SOME_ERRORS","client_errors/MEMCACHED_STAT","client_errors/MEMCACHED_STORED","client_errors/MEMCACHED_SUCCESS","client_errors/MEMCACHED_TIMEOUT","client_errors/MEMCACHED_UNKNOWN_READ_FAILURE","client_errors/MEMCACHED_UNKNOWN_STAT_KEY","client_errors/MEMCACHED_VALUE","client_errors/MEMCACHED_WRITE_FAILURE","copyright","error_messages","hashkit_create","hashkit_functions","hashkit_value","index","libhashkit","libmemcached","libmemcached-1.0/index","libmemcached-1.0/memcached_set_encoding_key","libmemcached-1.0/memcached_touch","libmemcached-1.1/index","libmemcached/defaults","libmemcached/memcached_exist","libmemcached/memcached_fetch","libmemcached/memcached_last_error_message","libmemcached/memcached_return_t","libmemcached_configuration","libmemcached_examples","libmemcachedutil","memcached_analyze","memcached_append","memcached_auto","memcached_behavior","memcached_callback","memcached_cas","memcached_create","memcached_delete","memcached_dump","memcached_flush","memcached_flush_buffers","memcached_generate_hash_value","memcached_get","memcached_memory_allocators","memcached_pool","memcached_quit","memcached_result_st","memcached_sasl","memcached_server_st","memcached_servers","memcached_set","memcached_stats","memcached_strerror","memcached_user_data","memcached_verbosity","memcached_version","tap","types","versioning"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:56},filenames:["bin/memaslap.rst","bin/memcapable.rst","bin/memcat.rst","bin/memcp.rst","bin/memdump.rst","bin/memerror.rst","bin/memexist.rst","bin/memflush.rst","bin/memparse.rst","bin/memping.rst","bin/memrm.rst","bin/memslap.rst","bin/memstat.rst","bin/memtouch.rst","client_errors/MEMCACHED_AUTH_CONTINUE.rst","client_errors/MEMCACHED_AUTH_FAILURE.rst","client_errors/MEMCACHED_AUTH_PROBLEM.rst","client_errors/MEMCACHED_BAD_KEY_PROVIDED.rst","client_errors/MEMCACHED_BUFFERED.rst","client_errors/MEMCACHED_CLIENT_ERROR.rst","client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.rst","client_errors/MEMCACHED_CONNECTION_FAILURE.rst","client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.rst","client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.rst","client_errors/MEMCACHED_DATA_EXISTS.rst","client_errors/MEMCACHED_DELETED.rst","client_errors/MEMCACHED_DEPRECATED.rst","client_errors/MEMCACHED_E2BIG.rst","client_errors/MEMCACHED_END.rst","client_errors/MEMCACHED_ERRNO.rst","client_errors/MEMCACHED_FAILURE.rst","client_errors/MEMCACHED_FAIL_UNIX_SOCKET.rst","client_errors/MEMCACHED_FETCH_NOTFINISHED.rst","client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.rst","client_errors/MEMCACHED_INVALID_ARGUMENTS.rst","client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.rst","client_errors/MEMCACHED_ITEM.rst","client_errors/MEMCACHED_KEY_TOO_BIG.rst","client_errors/MEMCACHED_MAXIMUM_RETURN.rst","client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.rst","client_errors/MEMCACHED_NOTFOUND.rst","client_errors/MEMCACHED_NOTSTORED.rst","client_errors/MEMCACHED_NOT_SUPPORTED.rst","client_errors/MEMCACHED_NO_KEY_PROVIDED.rst","client_errors/MEMCACHED_NO_SERVERS.rst","client_errors/MEMCACHED_PARSE_ERROR.rst","client_errors/MEMCACHED_PARSE_USER_ERROR.rst","client_errors/MEMCACHED_PARTIAL_READ.rst","client_errors/MEMCACHED_PROTOCOL_ERROR.rst","client_errors/MEMCACHED_READ_FAILURE.rst","client_errors/MEMCACHED_SERVER_ERROR.rst","client_errors/MEMCACHED_SERVER_MARKED_DEAD.rst","client_errors/MEMCACHED_SOME_ERRORS.rst","client_errors/MEMCACHED_STAT.rst","client_errors/MEMCACHED_STORED.rst","client_errors/MEMCACHED_SUCCESS.rst","client_errors/MEMCACHED_TIMEOUT.rst","client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.rst","client_errors/MEMCACHED_UNKNOWN_STAT_KEY.rst","client_errors/MEMCACHED_VALUE.rst","client_errors/MEMCACHED_WRITE_FAILURE.rst","copyright.rst","error_messages.rst","hashkit_create.rst","hashkit_functions.rst","hashkit_value.rst","index.rst","libhashkit.rst","libmemcached.rst","libmemcached-1.0/index.rst","libmemcached-1.0/memcached_set_encoding_key.rst","libmemcached-1.0/memcached_touch.rst","libmemcached-1.1/index.rst","libmemcached/defaults.rst","libmemcached/memcached_exist.rst","libmemcached/memcached_fetch.rst","libmemcached/memcached_last_error_message.rst","libmemcached/memcached_return_t.rst","libmemcached_configuration.rst","libmemcached_examples.rst","libmemcachedutil.rst","memcached_analyze.rst","memcached_append.rst","memcached_auto.rst","memcached_behavior.rst","memcached_callback.rst","memcached_cas.rst","memcached_create.rst","memcached_delete.rst","memcached_dump.rst","memcached_flush.rst","memcached_flush_buffers.rst","memcached_generate_hash_value.rst","memcached_get.rst","memcached_memory_allocators.rst","memcached_pool.rst","memcached_quit.rst","memcached_result_st.rst","memcached_sasl.rst","memcached_server_st.rst","memcached_servers.rst","memcached_set.rst","memcached_stats.rst","memcached_strerror.rst","memcached_user_data.rst","memcached_verbosity.rst","memcached_version.rst","tap.rst","types.rst","versioning.rst"],objects:{"":{"'MEMCACHED_SERVERS,--args'":[12,3,1,"envvar-'MEMCACHED_SERVERS,--args'"],"`MEMCACHED_SERVERS`":[13,3,1,"-"],LIBMEMCACHED:[78,3,1,"-"],LIBMEMCACHED_VERSION_HEX:[68,0,1,"c.LIBMEMCACHED_VERSION_HEX"],LIBMEMCACHED_VERSION_STRING:[68,0,1,"c.LIBMEMCACHED_VERSION_STRING"],MEMCACHED_AUTH_CONTINUE:[14,1,1,"c.MEMCACHED_AUTH_CONTINUE"],MEMCACHED_AUTH_FAILURE:[15,1,1,"c.MEMCACHED_AUTH_FAILURE"],MEMCACHED_AUTH_PROBLEM:[16,1,1,"c.MEMCACHED_AUTH_PROBLEM"],MEMCACHED_BAD_KEY_PROVIDED:[17,1,1,"c.MEMCACHED_BAD_KEY_PROVIDED"],MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS:[84,1,1,"c.MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS"],MEMCACHED_BEHAVIOR_BINARY_PROTOCOL:[84,1,1,"c.MEMCACHED_BEHAVIOR_BINARY_PROTOCOL"],MEMCACHED_BEHAVIOR_BUFFER_REQUESTS:[84,1,1,"c.MEMCACHED_BEHAVIOR_BUFFER_REQUESTS"],MEMCACHED_BEHAVIOR_CACHE_LOOKUPS:[84,1,1,"c.MEMCACHED_BEHAVIOR_CACHE_LOOKUPS"],MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT:[84,1,1,"c.MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT"],MEMCACHED_BEHAVIOR_CORK:[84,1,1,"c.MEMCACHED_BEHAVIOR_CORK"],MEMCACHED_BEHAVIOR_DISTRIBUTION:[84,1,1,"c.MEMCACHED_BEHAVIOR_DISTRIBUTION"],MEMCACHED_BEHAVIOR_HASH:[84,1,1,"c.MEMCACHED_BEHAVIOR_HASH"],MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY:[84,1,1,"c.MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY"],MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK:[84,1,1,"c.MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK"],MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH:[84,1,1,"c.MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH"],MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK:[84,1,1,"c.MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK"],MEMCACHED_BEHAVIOR_KEEPALIVE:[84,1,1,"c.MEMCACHED_BEHAVIOR_KEEPALIVE"],MEMCACHED_BEHAVIOR_KEEPALIVE_IDLE:[84,1,1,"c.MEMCACHED_BEHAVIOR_KEEPALIVE_IDLE"],MEMCACHED_BEHAVIOR_KETAMA:[84,1,1,"c.MEMCACHED_BEHAVIOR_KETAMA"],MEMCACHED_BEHAVIOR_KETAMA_COMPAT:[84,1,1,"c.MEMCACHED_BEHAVIOR_KETAMA_COMPAT"],MEMCACHED_BEHAVIOR_KETAMA_HASH:[84,1,1,"c.MEMCACHED_BEHAVIOR_KETAMA_HASH"],MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED:[84,1,1,"c.MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED"],MEMCACHED_BEHAVIOR_NOREPLY:[84,1,1,"c.MEMCACHED_BEHAVIOR_NOREPLY"],MEMCACHED_BEHAVIOR_NO_BLOCK:[84,1,1,"c.MEMCACHED_BEHAVIOR_NO_BLOCK"],MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS:[84,1,1,"c.MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS"],MEMCACHED_BEHAVIOR_POLL_TIMEOUT:[84,1,1,"c.MEMCACHED_BEHAVIOR_POLL_TIMEOUT"],MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ:[84,1,1,"c.MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ"],MEMCACHED_BEHAVIOR_RCV_TIMEOUT:[84,1,1,"c.MEMCACHED_BEHAVIOR_RCV_TIMEOUT"],MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS:[84,1,1,"c.MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS"],MEMCACHED_BEHAVIOR_RETRY_TIMEOUT:[84,1,1,"c.MEMCACHED_BEHAVIOR_RETRY_TIMEOUT"],MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT:[84,1,1,"c.MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT"],MEMCACHED_BEHAVIOR_SND_TIMEOUT:[84,1,1,"c.MEMCACHED_BEHAVIOR_SND_TIMEOUT"],MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE:[84,1,1,"c.MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE"],MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE:[84,1,1,"c.MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE"],MEMCACHED_BEHAVIOR_SORT_HOSTS:[84,1,1,"c.MEMCACHED_BEHAVIOR_SORT_HOSTS"],MEMCACHED_BEHAVIOR_SUPPORT_CAS:[84,1,1,"c.MEMCACHED_BEHAVIOR_SUPPORT_CAS"],MEMCACHED_BEHAVIOR_TCP_NODELAY:[84,1,1,"c.MEMCACHED_BEHAVIOR_TCP_NODELAY"],MEMCACHED_BEHAVIOR_USER_DATA:[84,1,1,"c.MEMCACHED_BEHAVIOR_USER_DATA"],MEMCACHED_BEHAVIOR_USE_UDP:[84,1,1,"c.MEMCACHED_BEHAVIOR_USE_UDP"],MEMCACHED_BEHAVIOR_VERIFY_KEY:[84,1,1,"c.MEMCACHED_BEHAVIOR_VERIFY_KEY"],MEMCACHED_BUFFERED:[18,1,1,"c.MEMCACHED_BUFFERED"],MEMCACHED_CALLBACK_CLEANUP_FUNCTION:[85,1,1,"c.MEMCACHED_CALLBACK_CLEANUP_FUNCTION"],MEMCACHED_CALLBACK_CLONE_FUNCTION:[85,1,1,"c.MEMCACHED_CALLBACK_CLONE_FUNCTION"],MEMCACHED_CALLBACK_DELETE_TRIGGER:[85,1,1,"c.MEMCACHED_CALLBACK_DELETE_TRIGGER"],MEMCACHED_CALLBACK_FREE_FUNCTION:[85,1,1,"c.MEMCACHED_CALLBACK_FREE_FUNCTION"],MEMCACHED_CALLBACK_GET_FAILURE:[85,1,1,"c.MEMCACHED_CALLBACK_GET_FAILURE"],MEMCACHED_CALLBACK_MALLOC_FUNCTION:[85,1,1,"c.MEMCACHED_CALLBACK_MALLOC_FUNCTION"],MEMCACHED_CALLBACK_NAMESPACE:[85,1,1,"c.MEMCACHED_CALLBACK_NAMESPACE"],MEMCACHED_CALLBACK_PREFIX_KEY:[85,1,1,"c.MEMCACHED_CALLBACK_PREFIX_KEY"],MEMCACHED_CALLBACK_REALLOC_FUNCTION:[85,1,1,"c.MEMCACHED_CALLBACK_REALLOC_FUNCTION"],MEMCACHED_CALLBACK_USER_DATA:[85,1,1,"c.MEMCACHED_CALLBACK_USER_DATA"],MEMCACHED_CLIENT_ERROR:[19,1,1,"c.MEMCACHED_CLIENT_ERROR"],MEMCACHED_CONNECTION_BIND_FAILURE:[20,1,1,"c.MEMCACHED_CONNECTION_BIND_FAILURE"],MEMCACHED_CONNECTION_FAILURE:[21,1,1,"c.MEMCACHED_CONNECTION_FAILURE"],MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE:[22,1,1,"c.MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE"],MEMCACHED_CONTINUUM_ADDITION:[73,0,1,"c.MEMCACHED_CONTINUUM_ADDITION"],MEMCACHED_DATA_DOES_NOT_EXIST:[23,1,1,"c.MEMCACHED_DATA_DOES_NOT_EXIST"],MEMCACHED_DATA_EXISTS:[24,1,1,"c.MEMCACHED_DATA_EXISTS"],MEMCACHED_DEFAULT_CONNECT_TIMEOUT:[73,0,1,"c.MEMCACHED_DEFAULT_CONNECT_TIMEOUT"],MEMCACHED_DEFAULT_PORT:[68,0,1,"c.MEMCACHED_DEFAULT_PORT"],MEMCACHED_DEFAULT_TIMEOUT:[73,0,1,"c.MEMCACHED_DEFAULT_TIMEOUT"],MEMCACHED_DELETED:[25,1,1,"c.MEMCACHED_DELETED"],MEMCACHED_DEPRECATED:[26,1,1,"c.MEMCACHED_DEPRECATED"],MEMCACHED_E2BIG:[27,1,1,"c.MEMCACHED_E2BIG"],MEMCACHED_END:[28,1,1,"c.MEMCACHED_END"],MEMCACHED_ERRNO:[29,1,1,"c.MEMCACHED_ERRNO"],MEMCACHED_FAILURE:[30,1,1,"c.MEMCACHED_FAILURE"],MEMCACHED_FAIL_UNIX_SOCKET:[31,1,1,"c.MEMCACHED_FAIL_UNIX_SOCKET"],MEMCACHED_FETCH_NOTFINISHED:[32,1,1,"c.MEMCACHED_FETCH_NOTFINISHED"],MEMCACHED_HASH_CRC:[92,1,1,"c.MEMCACHED_HASH_CRC"],MEMCACHED_HASH_DEFAULT:[92,1,1,"c.MEMCACHED_HASH_DEFAULT"],MEMCACHED_HASH_FNV1A_32:[92,1,1,"c.MEMCACHED_HASH_FNV1A_32"],MEMCACHED_HASH_FNV1A_64:[92,1,1,"c.MEMCACHED_HASH_FNV1A_64"],MEMCACHED_HASH_FNV1_32:[92,1,1,"c.MEMCACHED_HASH_FNV1_32"],MEMCACHED_HASH_FNV1_64:[92,1,1,"c.MEMCACHED_HASH_FNV1_64"],MEMCACHED_HASH_HSIEH:[92,1,1,"c.MEMCACHED_HASH_HSIEH"],MEMCACHED_HASH_JENKINS:[92,1,1,"c.MEMCACHED_HASH_JENKINS"],MEMCACHED_HASH_MD5:[92,1,1,"c.MEMCACHED_HASH_MD5"],MEMCACHED_HASH_MURMUR3:[92,1,1,"c.MEMCACHED_HASH_MURMUR3"],MEMCACHED_HASH_MURMUR:[92,1,1,"c.MEMCACHED_HASH_MURMUR"],MEMCACHED_HOST_LOOKUP_FAILURE:[33,1,1,"c.MEMCACHED_HOST_LOOKUP_FAILURE"],MEMCACHED_INVALID_ARGUMENTS:[34,1,1,"c.MEMCACHED_INVALID_ARGUMENTS"],MEMCACHED_INVALID_HOST_PROTOCOL:[35,1,1,"c.MEMCACHED_INVALID_HOST_PROTOCOL"],MEMCACHED_ITEM:[36,1,1,"c.MEMCACHED_ITEM"],MEMCACHED_KEY_TOO_BIG:[37,1,1,"c.MEMCACHED_KEY_TOO_BIG"],MEMCACHED_MAXIMUM_RETURN:[38,1,1,"c.MEMCACHED_MAXIMUM_RETURN"],MEMCACHED_MAX_BUFFER:[68,0,1,"c.MEMCACHED_MAX_BUFFER"],MEMCACHED_MAX_HOST_LENGTH:[68,0,1,"c.MEMCACHED_MAX_HOST_LENGTH"],MEMCACHED_MAX_KEY:[68,0,1,"c.MEMCACHED_MAX_KEY"],MEMCACHED_MEMORY_ALLOCATION_FAILURE:[39,1,1,"c.MEMCACHED_MEMORY_ALLOCATION_FAILURE"],MEMCACHED_NOTFOUND:[40,1,1,"c.MEMCACHED_NOTFOUND"],MEMCACHED_NOTSTORED:[41,1,1,"c.MEMCACHED_NOTSTORED"],MEMCACHED_NOT_SUPPORTED:[42,1,1,"c.MEMCACHED_NOT_SUPPORTED"],MEMCACHED_NO_KEY_PROVIDED:[43,1,1,"c.MEMCACHED_NO_KEY_PROVIDED"],MEMCACHED_NO_SERVERS:[44,1,1,"c.MEMCACHED_NO_SERVERS"],MEMCACHED_PARSE_ERROR:[45,1,1,"c.MEMCACHED_PARSE_ERROR"],MEMCACHED_PARSE_USER_ERROR:[46,1,1,"c.MEMCACHED_PARSE_USER_ERROR"],MEMCACHED_PARTIAL_READ:[47,1,1,"c.MEMCACHED_PARTIAL_READ"],MEMCACHED_PREFIX_KEY_MAX_SIZE:[68,0,1,"c.MEMCACHED_PREFIX_KEY_MAX_SIZE"],MEMCACHED_PROTOCOL_ERROR:[48,1,1,"c.MEMCACHED_PROTOCOL_ERROR"],MEMCACHED_READ_FAILURE:[49,1,1,"c.MEMCACHED_READ_FAILURE"],MEMCACHED_SERVERS:[0,3,1,"-"],MEMCACHED_SERVER_ERROR:[50,1,1,"c.MEMCACHED_SERVER_ERROR"],MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT:[73,0,1,"c.MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT"],MEMCACHED_SERVER_FAILURE_LIMIT:[73,0,1,"c.MEMCACHED_SERVER_FAILURE_LIMIT"],MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT:[73,0,1,"c.MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT"],MEMCACHED_SERVER_MARKED_DEAD:[51,1,1,"c.MEMCACHED_SERVER_MARKED_DEAD"],MEMCACHED_SOME_ERRORS:[52,1,1,"c.MEMCACHED_SOME_ERRORS"],MEMCACHED_STAT:[53,1,1,"c.MEMCACHED_STAT"],MEMCACHED_STORED:[54,1,1,"c.MEMCACHED_STORED"],MEMCACHED_STRIDE:[68,0,1,"c.MEMCACHED_STRIDE"],MEMCACHED_SUCCESS:[55,1,1,"c.MEMCACHED_SUCCESS"],MEMCACHED_TIMEOUT:[56,1,1,"c.MEMCACHED_TIMEOUT"],MEMCACHED_UNKNOWN_READ_FAILURE:[57,1,1,"c.MEMCACHED_UNKNOWN_READ_FAILURE"],MEMCACHED_UNKNOWN_STAT_KEY:[58,1,1,"c.MEMCACHED_UNKNOWN_STAT_KEY"],MEMCACHED_VALUE:[59,1,1,"c.MEMCACHED_VALUE"],MEMCACHED_VERSION_STRING_LENGTH:[73,0,1,"c.MEMCACHED_VERSION_STRING_LENGTH"],MEMCACHED_WRITE_FAILURE:[60,1,1,"c.MEMCACHED_WRITE_FAILURE"],bool:[108,1,1,"c.bool"],hashkit_clone:[63,2,1,"c.hashkit_clone"],hashkit_crc32:[64,2,1,"c.hashkit_crc32"],hashkit_create:[63,2,1,"c.hashkit_create"],hashkit_default:[64,2,1,"c.hashkit_default"],hashkit_fnv1_32:[64,2,1,"c.hashkit_fnv1_32"],hashkit_fnv1_64:[64,2,1,"c.hashkit_fnv1_64"],hashkit_fnv1a_32:[64,2,1,"c.hashkit_fnv1a_32"],hashkit_fnv1a_64:[64,2,1,"c.hashkit_fnv1a_64"],hashkit_free:[63,2,1,"c.hashkit_free"],hashkit_hsieh:[64,2,1,"c.hashkit_hsieh"],hashkit_is_allocated:[63,2,1,"c.hashkit_is_allocated"],hashkit_jenkins:[64,2,1,"c.hashkit_jenkins"],hashkit_md5:[64,2,1,"c.hashkit_md5"],hashkit_murmur:[64,2,1,"c.hashkit_murmur"],hashkit_st:[63,1,1,"c.hashkit_st"],hashkit_value:[65,2,1,"c.hashkit_value"],in_port_t:[108,1,1,"c.in_port_t"],libmemcached_check_configuration:[78,2,1,"c.libmemcached_check_configuration"],memcached:[78,2,1,"c.memcached"],memcached_add:[101,2,1,"c.memcached_add"],memcached_add_by_key:[101,2,1,"c.memcached_add_by_key"],memcached_analysis_st:[81,1,1,"c.memcached_analysis_st"],memcached_analyze:[81,2,1,"c.memcached_analyze"],memcached_append:[82,2,1,"c.memcached_append"],memcached_append_by_key:[82,2,1,"c.memcached_append_by_key"],memcached_behavior_get:[84,2,1,"c.memcached_behavior_get"],memcached_behavior_set:[84,2,1,"c.memcached_behavior_set"],memcached_behavior_t:[84,1,1,"c.memcached_behavior_t"],memcached_callback_get:[85,2,1,"c.memcached_callback_get"],memcached_callback_set:[85,2,1,"c.memcached_callback_set"],memcached_callback_t:[85,1,1,"c.memcached_callback_t"],memcached_calloc_fn:[94,2,1,"c.memcached_calloc_fn"],memcached_cas:[86,2,1,"c.memcached_cas"],memcached_cas_by_key:[86,2,1,"c.memcached_cas_by_key"],memcached_clone:[87,2,1,"c.memcached_clone"],memcached_continue:[77,2,1,"c.memcached_continue"],memcached_create:[87,2,1,"c.memcached_create"],memcached_decrement:[83,2,1,"c.memcached_decrement"],memcached_decrement_by_key:[83,2,1,"c.memcached_decrement_by_key"],memcached_decrement_with_initial:[83,2,1,"c.memcached_decrement_with_initial"],memcached_decrement_with_initial_by_key:[83,2,1,"c.memcached_decrement_with_initial_by_key"],memcached_delete:[88,2,1,"c.memcached_delete"],memcached_delete_by_key:[88,2,1,"c.memcached_delete_by_key"],memcached_destroy_sasl_auth_data:[98,2,1,"c.memcached_destroy_sasl_auth_data"],memcached_dump:[89,2,1,"c.memcached_dump"],memcached_dump_fn:[89,1,1,"c.memcached_dump_fn"],memcached_execute_fn:[93,1,1,"c.memcached_execute_fn"],memcached_exist:[74,2,1,"c.memcached_exist"],memcached_exist_by_key:[74,2,1,"c.memcached_exist_by_key"],memcached_failed:[77,2,1,"c.memcached_failed"],memcached_fatal:[77,2,1,"c.memcached_fatal"],memcached_fetch:[75,2,1,"c.memcached_fetch"],memcached_fetch_execute:[93,2,1,"c.memcached_fetch_execute"],memcached_fetch_result:[93,2,1,"c.memcached_fetch_result"],memcached_flush:[90,2,1,"c.memcached_flush"],memcached_flush_buffers:[91,2,1,"c.memcached_flush_buffers"],memcached_free:[87,2,1,"c.memcached_free"],memcached_free_fn:[94,2,1,"c.memcached_free_fn"],memcached_generate_hash:[92,2,1,"c.memcached_generate_hash"],memcached_generate_hash_value:[92,2,1,"c.memcached_generate_hash_value"],memcached_get:[93,2,1,"c.memcached_get"],memcached_get_by_key:[93,2,1,"c.memcached_get_by_key"],memcached_get_memory_allocators:[94,2,1,"c.memcached_get_memory_allocators"],memcached_get_memory_allocators_context:[94,2,1,"c.memcached_get_memory_allocators_context"],memcached_get_sasl_callbacks:[98,2,1,"c.memcached_get_sasl_callbacks"],memcached_get_user_data:[104,2,1,"c.memcached_get_user_data"],memcached_hash_t:[92,1,1,"c.memcached_hash_t"],memcached_increment:[83,2,1,"c.memcached_increment"],memcached_increment_by_key:[83,2,1,"c.memcached_increment_by_key"],memcached_increment_with_initial:[83,2,1,"c.memcached_increment_with_initial"],memcached_increment_with_initial_by_key:[83,2,1,"c.memcached_increment_with_initial_by_key"],memcached_last_error_message:[76,2,1,"c.memcached_last_error_message"],memcached_lib_version:[106,2,1,"c.memcached_lib_version"],memcached_malloc_fn:[94,2,1,"c.memcached_malloc_fn"],memcached_mget:[93,2,1,"c.memcached_mget"],memcached_mget_by_key:[93,2,1,"c.memcached_mget_by_key"],memcached_mget_execute:[93,2,1,"c.memcached_mget_execute"],memcached_mget_execute_by_key:[93,2,1,"c.memcached_mget_execute_by_key"],memcached_pool:[95,2,1,"c.memcached_pool"],memcached_pool_behavior_get:[95,2,1,"c.memcached_pool_behavior_get"],memcached_pool_behavior_set:[95,2,1,"c.memcached_pool_behavior_set"],memcached_pool_create:[95,2,1,"c.memcached_pool_create"],memcached_pool_destroy:[95,2,1,"c.memcached_pool_destroy"],memcached_pool_fetch:[95,2,1,"c.memcached_pool_fetch"],memcached_pool_pop:[95,2,1,"c.memcached_pool_pop"],memcached_pool_push:[95,2,1,"c.memcached_pool_push"],memcached_pool_release:[95,2,1,"c.memcached_pool_release"],memcached_pool_st:[95,1,1,"c.memcached_pool_st"],memcached_prepend:[82,2,1,"c.memcached_prepend"],memcached_prepend_by_key:[82,2,1,"c.memcached_prepend_by_key"],memcached_quit:[96,2,1,"c.memcached_quit"],memcached_realloc_fn:[94,2,1,"c.memcached_realloc_fn"],memcached_replace:[101,2,1,"c.memcached_replace"],memcached_replace_by_key:[101,2,1,"c.memcached_replace_by_key"],memcached_result_cas:[97,2,1,"c.memcached_result_cas"],memcached_result_create:[97,2,1,"c.memcached_result_create"],memcached_result_flags:[97,2,1,"c.memcached_result_flags"],memcached_result_free:[97,2,1,"c.memcached_result_free"],memcached_result_key_length:[97,2,1,"c.memcached_result_key_length"],memcached_result_key_value:[97,2,1,"c.memcached_result_key_value"],memcached_result_length:[97,2,1,"c.memcached_result_length"],memcached_result_set_expiration:[97,2,1,"c.memcached_result_set_expiration"],memcached_result_set_flags:[97,2,1,"c.memcached_result_set_flags"],memcached_result_set_value:[97,2,1,"c.memcached_result_set_value"],memcached_result_st:[97,1,1,"c.memcached_result_st"],memcached_result_take_value:[97,2,1,"c.memcached_result_take_value"],memcached_result_value:[97,2,1,"c.memcached_result_value"],memcached_return_t:[77,1,1,"c.memcached_return_t"],memcached_server_add:[100,2,1,"c.memcached_server_add"],memcached_server_add_udp:[100,2,1,"c.memcached_server_add_udp"],memcached_server_add_unix_socket:[100,2,1,"c.memcached_server_add_unix_socket"],memcached_server_by_key:[100,2,1,"c.memcached_server_by_key"],memcached_server_count:[100,2,1,"c.memcached_server_count"],memcached_server_cursor:[100,2,1,"c.memcached_server_cursor"],memcached_server_error:[99,2,1,"c.memcached_server_error"],memcached_server_error_reset:[99,2,1,"c.memcached_server_error_reset"],memcached_server_fn:[100,1,1,"c.memcached_server_fn"],memcached_server_get_last_disconnect:[100,2,1,"c.memcached_server_get_last_disconnect"],memcached_server_list:[99,2,1,"c.memcached_server_list"],memcached_server_list_append:[99,2,1,"c.memcached_server_list_append"],memcached_server_list_count:[99,2,1,"c.memcached_server_list_count"],memcached_server_list_free:[99,2,1,"c.memcached_server_list_free"],memcached_server_list_st:[99,1,1,"c.memcached_server_list_st"],memcached_server_push:[100,2,1,"c.memcached_server_push"],memcached_server_st:[99,1,1,"c.memcached_server_st"],memcached_servers_parse:[99,2,1,"c.memcached_servers_parse"],memcached_servers_reset:[87,2,1,"c.memcached_servers_reset"],memcached_set:[101,2,1,"c.memcached_set"],memcached_set_by_key:[101,2,1,"c.memcached_set_by_key"],memcached_set_encoding_key:[70,2,1,"c.memcached_set_encoding_key"],memcached_set_memory_allocators:[94,2,1,"c.memcached_set_memory_allocators"],memcached_set_sasl_auth_data:[98,2,1,"c.memcached_set_sasl_auth_data"],memcached_set_sasl_callbacks:[98,2,1,"c.memcached_set_sasl_callbacks"],memcached_set_user_data:[104,2,1,"c.memcached_set_user_data"],memcached_st:[87,1,1,"c.memcached_st"],memcached_stat:[102,2,1,"c.memcached_stat"],memcached_stat_execute:[102,2,1,"c.memcached_stat_execute"],memcached_stat_fn:[102,1,1,"c.memcached_stat_fn"],memcached_stat_get_keys:[102,2,1,"c.memcached_stat_get_keys"],memcached_stat_get_value:[102,2,1,"c.memcached_stat_get_value"],memcached_stat_servername:[102,2,1,"c.memcached_stat_servername"],memcached_stat_st:[102,1,1,"c.memcached_stat_st"],memcached_strerror:[103,2,1,"c.memcached_strerror"],memcached_success:[77,2,1,"c.memcached_success"],memcached_touch:[71,2,1,"c.memcached_touch"],memcached_touch_by_key:[71,2,1,"c.memcached_touch_by_key"],memcached_verbosity:[105,2,1,"c.memcached_verbosity"],memcached_version:[106,2,1,"c.memcached_version"],sasl_callback_t:[108,1,1,"c.sasl_callback_t"],size_t:[108,1,1,"c.size_t"],time_t:[108,1,1,"c.time_t"],timespec:[108,1,1,"c.timespec"],uint32_t:[108,1,1,"c.uint32_t"],uint64_t:[108,1,1,"c.uint64_t"]},memaslap:{"--help":[0,4,1,"cmdoption-memaslap-help"]},memcapable:{"-c":[1,4,1,"cmdoption-memcapable-c"],"-h":[1,4,1,"cmdoption-memcapable-h"],"-p":[1,4,1,"cmdoption-memcapable-p"],"-t":[1,4,1,"cmdoption-memcapable-t"],"-v":[1,4,1,"cmdoption-memcapable-v"]},memcat:{"--help":[2,4,1,"cmdoption-memcat-help"],"--servers":[2,4,1,"cmdoption-memcat-servers"]},memcp:{"--help":[3,4,1,"cmdoption-memcp-help"],"--servers":[3,4,1,"cmdoption-memcp-servers"]},memdump:{"--help":[4,4,1,"cmdoption-memdump-help"]},memerror:{"--help":[5,4,1,"cmdoption-memerror-help"]},memexist:{"--help":[6,4,1,"cmdoption-memexist-help"],"--servers":[6,4,1,"cmdoption-memexist-servers"]},memflush:{"--help":[7,4,1,"cmdoption-memflush-help"],"--servers":[7,4,1,"cmdoption-memflush-servers"]},memparse:{"--help":[8,4,1,"cmdoption-memparse-help"]},memping:{"--help":[9,4,1,"cmdoption-memping-help"],"--servers":[9,4,1,"cmdoption-memping-servers"]},memrm:{"--help":[10,4,1,"cmdoption-memrm-help"],"--servers":[10,4,1,"cmdoption-memrm-servers"]},memslap:{"--help":[11,4,1,"cmdoption-memslap-help"],"--servers":[11,4,1,"cmdoption-memslap-servers"]},memstat:{"--analyze":[12,4,1,"cmdoption-memstat-analyze"],"--help":[12,4,1,"cmdoption-memstat-help"],"--servers":[12,4,1,"cmdoption-memstat-servers"]},memtouch:{"--help":[13,4,1,"cmdoption-memtouch-help"],"--servers":[13,4,1,"cmdoption-memtouch-servers"]}},objnames:{"0":["c","macro","C macro"],"1":["c","type","C type"],"2":["c","function","C function"],"3":["std","envvar","environment variable"],"4":["std","cmdoption","program option"]},objtypes:{"0":"c:macro","1":"c:type","2":"c:function","3":"std:envvar","4":"std:cmdoption"},terms:{"0x00048000":68,"10k":0,"10m":0,"10s":0,"11k":0,"16g":0,"20s":0,"30s":0,"32k":0,"40k":0,"46k":0,"4byte":[82,101],"byte":[0,78,82,84,86,97,101],"case":[0,57,79,82,84,85,101,103],"char":[64,65,70,71,74,75,76,77,78,79,82,83,85,86,88,89,92,93,95,97,98,99,100,101,102,103,106],"const":[63,64,65,70,71,76,77,78,79,82,83,85,86,88,89,92,93,94,95,97,98,99,100,101,102,103,106],"default":[0,1,63,66,68,78,84,85,87,92,94,99,107],"enum":103,"final":[3,6,9,13,72,75,88,93],"function":[0,34,63,64,65,66,68,72,75,80,82,84,85,86,87,89,92,93,94,95,96,97,98,99,100,101,102,103],"import":[0,68],"int":[79,84,95],"long":[0,84,85,86,101],"new":[0,74,78,87,94,95,97],"null":[0,63,68,75,76,78,81,85,87,93,94,95,99,102],"return":[2,28,53,59,68,79],"short":95,"static":[68,87],"switch":103,"throw":78,"true":[0,63,101],"try":[0,21,22,39,45,60,80,84,93,95],"void":[63,70,85,87,89,93,94,96,97,98,99,100,102,104,106],"while":[21,22,39,45,60,65,79,84,93,95,102],AES:70,AND:61,ARE:61,And:0,BUT:61,CAS:[78,84,97],DNS:[33,84],FOR:61,For:[0,2,3,4,5,6,7,8,9,10,11,12,13,79,82,83,84,86,92,93,101,109],NOT:[61,98],Not:84,Ops:0,SUCH:61,THE:61,TPS:0,That:[78,90],The:[0,1,3,15,17,18,23,24,25,26,28,34,35,37,40,41,42,47,51,54,55,58,63,64,65,68,72,75,79,81,82,83,84,85,86,87,88,89,90,92,93,94,95,97,100,101,102,109],Then:0,There:[0,68],These:[64,68,79,85,100],USE:[61,78],Use:[0,43,66,70,71,75,82,83,85,86,88,89,90,91,95,96,97,101,105,106],Used:8,Using:84,WITH:78,abi:[87,97],abil:[81,83,102],abl:20,about:[66,84,107],abov:[0,61,75,79,82,83,93,101],ac_subst:68,access:[68,78,80,97,102],accomplish:78,accord:0,account:0,accumul:0,accur:84,act:[84,97],action:84,actual:[82,86,93,101],add:[0,66,68,84,88,99,100],added:[44,78,84,90,97,99],adding:78,addit:[0,84],advanc:66,advantag:84,advis:[61,102],affin:0,after:[0,84,88,93],again:0,against:[68,84],aker:[0,2,3,4,5,6,7,8,9,10,11,13,61,70,71,85,88,89,90,91,92,95,96,98,102],algorithm:[0,64,67,68,84,92],alia:84,alias:99,all:[0,4,12,28,61,66,68,75,78,79,82,83,84,85,86,87,89,91,92,93,94,95,96,97,99,101,102,103],allevi:68,alloc:[39,63,66,68,76,78,81,87,93,95,97,102],allow:[0,68,75,82,84,85,86,87,92,93,94,98,100,101,104],alogrthm:78,alongsid:[82,101],alreadi:101,alwai:[75,78,79,84,93,101],among:[68,82,86,101],amount:84,analyz:[12,81],anaylz:66,ani:[0,2,3,61,63,75,79,81,84,85,93,94,95,96,97,100,102],api:[66,68],append:[66,84],appli:[68,85],applic:[0,66,68,78,81,84,87,93,94,102,103],appropri:[64,84,99],arg:[12,102],argument:[12,34,63,64,65,85,87,94,95,102],aris:61,arrai:[89,93,97,99,100,102],ascii:[0,75,82,86,101],ask:99,assign:[0,85,100],associ:[79,87,97,99],assum:[0,84,89],asychron:84,asynchron:[0,68,93],atom:[66,90],attach:97,attempt:84,atwood:[2,3,7,10],authent:[14,16,98],automat:[84,85,96],autotool:68,avail:[66,82,83,84,86,93,95,97,101,102],averag:0,avg:0,avoid:[82,87,97,98,101],back:[0,84,95],bake:0,base:[0,68,78,81,84,85,87,90,92,97],basic:[0,66,98],becaus:[0,4,84,89,93],been:[14,18,25,26,32,36,37,44,51,52,53,54,59,68,75,84,92,93,97,102],befor:[0,75,82,84,93,98,99],begin:0,behav:[66,82,86,93,94,101],behavior:[75,78,82,84,85,86,93,95,100,101,102,106],behind:68,being:[63,72,75,78,82,84,85,86,93,100,101,106],below:[0,82,84,101],benchmark:66,benefit:[0,97],best:[0,79,97,109],better:[0,84],between:[0,68,84],bewar:78,binari:[1,35,61,78,82,83,84,86,89,93,98,101],bind:[0,20,92],bit:[64,65,84,92],bitmap:[82,101],block:[0,82,84,88,95,101],bool:[63,77,95,108],both:[0,68,82,84,95,101],bottleneck:0,bound:0,brian:[0,2,3,4,5,6,7,8,9,10,11,13,61,70,71,85,88,89,90,91,92,95,96,98,102],buffer:[0,18,66,68,78,84,85,93],bug:57,buggi:[86,101],build:[73,84],built:[64,80,84],busi:61,c99:94,cach:[0,68,84,85],cache_s:0,calcul:[0,64,78],call:[68,75,78,81,84,85,86,87,93,94,96,97,98,100,101,102,106],callback:[66,89,93,98,100,102],caller:[75,93,95,100],came:76,can:[0,2,3,6,7,8,9,10,11,12,13,64,68,74,78,84,85,86,89,93,96,97,99,100,101,102,103],candid:100,cannot:[0,84,94,95],capabl:1,capibl:66,captur:103,care:84,cas:[82,86,97,101],cast:84,cat:66,caus:[0,61,78,84,85,90],certain:84,cfg_cmd:0,chang:[84,85,93,96],charact:[0,82,97,100,101],check:[0,2,3,4,5,7,8,9,10,11,12,13,63,64,65,66,67,68,70,71,74,75,76,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],choos:98,chunk:84,clean:[66,87,99],cleanup:97,client:[0,19,66,67,78,80,84,99,100],clone:[68,80,85,87,93,94],close:[0,84,85],cluster:[6,84],cmd:0,cmd_get:0,cmd_proport:0,cmd_set:0,cmd_type:0,cnf:0,code:[61,66,68,79,85,97,99,106],collect:[0,3,10,67,81,102],collis:101,com:[0,1,2,3,7,10,61,78,79,91,95,98],combin:[82,84,86,101],come:0,command:[1,3,6,9,12,13,53,81,82,84,86,88,91,101,102],comment:0,common:[87,97],commun:[0,58,84,87],compar:68,comparison:1,compat:[66,84,93,97],compil:[63,64,65,68,70,71,74,75,76,78,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107],complet:[4,28,68,94],concept:99,conclus:[75,93],concurr:11,condit:[59,61],config_str:[78,79],configur:[11,45,46,66,84,95,107],configut:78,conjunct:91,conn_sock:0,connect:[1,9,11,21,22,31,35,78,84,85,95,96,98,100,106],consequenti:61,consist:[68,84],consisten:84,constant:92,consum:63,contain:[0,68,75,78,93,102],content:[7,66],context:[78,85,89,93,94,100,102],continu:[78,84,93],continuum:[73,84],contract:61,contributor:61,control:0,conveni:92,copi:[2,66,68,85,87,100],core:0,coredump:1,could:[0,94,95],count:[0,100],covert:66,cpu:0,crash:0,creat:[0,66,68,78,84,85,95,97],credenti:15,current:[0,1,70,81,82,84,86,89,93,94,96,97,98,100,101,102,104],cursor:100,custom:[66,78,85,97],dai:0,damag:61,danga:88,data:[0,12,23,24,61,66,68,70,78,84,85,95,104],databas:68,datadifferenti:61,datagram:[82,86,101],date:[0,79],dead:[51,100],deadlock:[84,93],dealloc:[87,97,99],decim:0,declar:87,decreas:0,decrement:66,decrypt:70,dedic:84,defeat:84,defin:[58,79,92,98,99,102],delai:84,delet:[7,25,66,85],deliv:84,deliveri:88,dep:68,depend:[82,86,101],deprec:[20,22,26,30,43,66,72,75,84,85,95,99],deps_cflag:68,deps_lib:68,deriv:[61,66],describ:[0,103],descriptor:22,design:[68,78],destin:[63,87],destroi:[66,79,95],detail:[78,81,95],detect:[1,83],determin:[1,45,66,78,84,93,100],develop:[0,68,109],deviat:0,differ:[0,82,84,86,93,101],direct:61,directli:[66,68,78,93,97,99,102],directori:3,disabl:[84,85,107],discard:0,disclaim:61,disconnect:[0,66],disord:0,displai:[0,12],dist:0,distribut:[61,65,67,68,78,79,84],divis:0,document:[61,68,92,99],doe:[0,4,13,35,74,76,82,83,84,86,89,93,100,101],doesn:0,domain:[31,85],don:[0,84,94],done:[0,84,99],down:84,drain:84,driver:[29,66,106],drop:0,dtrace:107,dubiou:57,due:[82,86,101],dump:[12,66],duplic:100,dure:[16,84,94,96,107,109],dynam:[0,68,93],each:[0,68,78,79,84,85,93,100,102,106],edit:0,effici:0,either:[3,6,9,13,22,57,68,80,82,84,85,87,90,97,101,102],elsiz:94,embed:[66,68],enab:84,enabl:[0,64,68,78,82,84,86,94,101,107],encapsul:[68,97],encount:93,encrypt:66,end:[0,78,82,99,100],end_len:0,endors:61,enjoi:68,enough:0,ensur:[0,84],entir:84,environ:[0,2,3,6,7,9,10,11,12,13,84],equal:0,equival:83,errno:[29,84],error:[0,1,2,19,21,22,29,36,39,45,46,48,50,52,60,66,74,75,78,81,84,85,93,99,100,101,102],error_buff:78,error_buffer_s:78,establish:31,etc:[0,12],ethernet:57,even:[0,61],event:[0,61],everi:0,exact:[82,86,101],exampl:[66,97],example1:0,example2:0,exce:[82,86,95,101],except:0,excut:85,execut:[55,75,82,84,85,86,89,93,100,101,102],execute_numb:0,exemplari:61,exist:[66,71,83,101],exit:0,exp_verifi:0,expect:[0,11,81,102],expens:84,expir:[0,71,82,83,86,88,90,97,101],expired_get:0,expiri:[82,86,101],exponenti:0,express:61,extra:[73,80],fail:[0,41,83,88,93],failur:[30,33,49,57,63,75,78,79,81,84,85,87,93,97],fallenpegasu:[2,3,7,10],fals:[0,63,79],fashion:66,faster:[0,84,93],fastest:[82,84,101],featur:[68,84],fetch:[4,32,36,75,89,93,95,102],field:[82,97,101],file:[3,22,67,78,80],filenam:100,filepath:78,fill:[0,75,93],find:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,63,64,65,67,68,70,71,74,75,76,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],finish:[32,87],fire:84,first:[0,84,94],fit:[61,78],fix:0,fixed_s:0,flag:[64,67,75,79,80,82,83,84,85,86,93,95,97,101,107],fluctuat:[82,86,101],flush:[66,84,90],follow:[0,61,68,84],foo:79,food:79,forc:78,forget:84,fork:68,form:61,format:95,formula:0,forward:[93,97],found:[2,23,24,40,74,75,79,89,93,101,102,109],free:[63,79,81,93,95,97,99,102],freed:[75,79,81,93,102],frequenc:0,from:[0,1,4,5,59,61,64,65,66,68,70,75,76,78,79,80,84,85,87,95,100,103,106],fudg:79,full:[2,3,4,5,6,7,8,9,10,11,12,13,68,79,84,93],func:[90,102,106],furthermor:0,futur:[93,97],gather:66,gener:[1,11,64,65,66,68,78,83],geo:0,geo_dist:0,geometr:0,get:[4,11,66,78,84,85,86,88,89,94,95,101,102],get_miss:0,get_prop:0,give:[75,83,93],given:[0,23,24,34,37,42,65,71,88,92],global:[0,68],gmail:[1,91,95,98],gnu:68,good:[61,100],gotten:0,govern:0,greater:[0,85],greatest:68,group:[12,68],group_kei:[71,74,82,83,86,88,93,101],group_key_length:[71,74,82,83,86,88,93,101],guarente:[4,89],guid:68,half:0,hand:97,handl:[0,68,79,94,96,98],happen:[0,83,85],has:[0,14,16,18,19,21,22,25,26,28,29,30,32,33,35,36,37,39,45,46,48,49,50,51,52,53,54,56,58,59,60,68,75,76,81,84,87,93,97,102],hash:[63,65,66,67,68,78,84,96],hash_algorithm:92,hash_hsieh:84,hashkit:[64,65,66,67],hashkit_clon:63,hashkit_cr:[63,64,65],hashkit_crc32:64,hashkit_default:64,hashkit_fnv1_32:64,hashkit_fnv1_64:64,hashkit_fnv1a_32:64,hashkit_fnv1a_64:64,hashkit_fre:63,hashkit_hsieh:64,hashkit_is_alloc:63,hashkit_jenkin:64,hashkit_md5:64,hashkit_murmur:64,hashkit_set_continuum_hash_fn:64,hashkit_set_distribut:65,hashkit_set_hash_fn:[63,64,65],hashkit_st:[63,65],hashkit_valu:[63,64,66],have:[0,44,52,68,75,81,83,84,85,89,92,93,94,97,98,102],heap:[87,97],help:[0,2,3,4,5,6,7,8,9,10,11,12,13,93,99],helper:98,hengtiansoft:0,here:85,hex:68,high:[0,68,84],higher:[0,92],highli:78,histor:109,hit:84,hold:[75,93],holder:61,hope:68,host10:[78,79],host11:[78,79],host:[78,84,99,100],hostnam:[1,68,76,99,100,102],hour:0,how:[0,66,68,73,86,101],howev:[0,61,68,82,86,88,101],http:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,61,63,64,65,67,68,70,71,74,75,76,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],human:5,identifi:0,idl:84,illeg:0,immedi:90,immediatli:85,implement:[68,78,80,82,84,85,86,94,97,101],impli:61,impos:84,improv:[0,84],in_port_t:[99,100,102,108],inc:61,incident:61,includ:[0,61,63,64,65,67,68,70,71,74,75,76,77,78,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,109],incorrectli:99,increas:22,increment:66,index:66,indic:0,indirect:61,individu:[68,75,93],infinit:84,infoerror:5,inform:[1,2,3,4,6,7,8,9,10,11,12,13,57,63,64,65,66,67,68,70,71,74,75,76,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,101,103,105,107],initi:[0,63,65,68,78,83,87,95,97],input:[84,93],insid:[63,85,94,104],insist:0,inspect:81,instanc:[0,68,80,84,94,99],instead:[0,43,63,75,84,85,93],integ:92,intend:68,interfac:[66,109],intern:[19,36,38,59],interrupt:61,introduc:[66,100],invalid:[35,95],involv:[87,97],issu:[16,87,97],item:[10,12,27,36,84,88,97],its:[0,1,61,68,75,76,82,85,92,93,100,101],itself:0,java:84,just:[0,84,90,93,99],keep:[0,68],keepal:78,keepidl:78,kei:[2,3,4,10,11,17,23,24,25,37,43,58,64,65,66,68,71,75,78,79,82,83,84,85,86,88,89,92,93,97,100,101,102],kernel:[84,93],key_length:[64,65,71,74,75,79,82,83,85,86,88,89,92,93,100,101,102],key_prefix:[82,86,101],key_siz:0,keylength:83,kick:0,know:[78,84,103],kop:0,lai:109,languag:[78,92],larg:[27,37,68,84,93],larger:75,largest:75,last:[32,76,82,84,99,100],latenc:84,latest:0,layer:0,leak:[97,98],least:[0,82,84,86,92,101],legitm:101,length:[0,68,75,78,82,93,97,100,101],less:[0,82,86,100,101],level:92,lhashkit:[63,64,65,67],liabil:61,liabl:61,libev:0,libhashkit:[63,64,65,66,92],libmemach:[82,84,86,101],libmemcacach:109,libmemcach:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,63,64,65,67,68,70,71,74,75,76,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,109],libmemcached_check_configur:78,libmemcached_configur:95,libmemcached_exampl:68,libmemcached_version_hex:68,libmemcached_version_str:68,libmemcachedutil:66,librari:[64,66,67,79,80,82,84,88,92,100,101,106],libsasl:98,life:0,light:68,like:[0,22,35,63],limit:[0,61,68,78,82,84,86,101],line:[3,6,9,13,81,102],link:[63,64,65,68,70,71,74,75,76,78,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],linux:[84,107],list:[0,2,3,4,5,6,7,8,9,10,11,12,13,61,66,84,87,89,92,93,100,102],live:95,lmemcach:[68,70,71,74,75,76,78,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],lmemcachedutil:[80,92,95,97],load:[66,68,78,84],local:[0,68],localhost:[0,1],locat:0,lock:[68,95],log2:0,logarithm:0,look:[79,82,93,99,101],lookup:84,loop:100,loss:[61,84],lost:0,lot:0,machin:0,made:[32,52,84,97,100],mai:[0,61,81,82,83,84,86,87,93,95,97,101],main:[79,82,101],mainli:96,major:106,make:[0,79,82,84,85,87,94,101],malloc:[94,97],mamcach:94,man:84,manag:[0,66,68,94,104],mani:[0,73,82,101],manipul:[66,84],manpag:[68,78,92,107],map:[68,82,84,86,101],mark:[2,3,7,10,51,84],master:[68,71,83,85,88,93],match:68,materi:61,max:[0,78,95],maxim:78,maximum:[0,68,95],md5:84,mean:[0,7,84,88,100],meant:[82,101],mechan:0,mem:94,mem_calloc:94,mem_fre:94,mem_malloc:94,mem_realloc:94,memach:[86,101],memaslap:66,member:97,memc:[78,79,102],memc_ptr:79,memcach:[0,2,3,4,5,6,7,8,9,10,11,12,13,66,70,71,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,96,97,98,99,100,101,102,103,104,105,106,109],memcache_server_st:99,memcached_add:[68,82,86,101],memcached_add_by_kei:101,memcached_analysis_st:81,memcached_analyz:81,memcached_append:[68,82,86,101],memcached_append_by_kei:82,memcached_auth_continu:[62,77],memcached_auth_failur:[62,77],memcached_auth_problem:[62,77],memcached_bad_key_provid:[43,62,77,85],memcached_behavior:91,memcached_behavior_auto_eject_host:84,memcached_behavior_binary_protocol:[82,84,86,101],memcached_behavior_buffer_request:[78,84,91],memcached_behavior_cache_lookup:84,memcached_behavior_connect_timeout:[78,84],memcached_behavior_cork:84,memcached_behavior_distribut:84,memcached_behavior_get:84,memcached_behavior_hash:84,memcached_behavior_hash_with_prefix_kei:84,memcached_behavior_io_bytes_watermark:84,memcached_behavior_io_key_prefetch:84,memcached_behavior_io_msg_watermark:84,memcached_behavior_keepal:84,memcached_behavior_keepalive_idl:84,memcached_behavior_ketama:84,memcached_behavior_ketama_compat:84,memcached_behavior_ketama_hash:84,memcached_behavior_ketama_weight:84,memcached_behavior_no_block:84,memcached_behavior_norepli:84,memcached_behavior_number_of_replica:84,memcached_behavior_poll_timeout:84,memcached_behavior_randomize_replica_read:84,memcached_behavior_rcv_timeout:84,memcached_behavior_remove_failed_serv:[78,84],memcached_behavior_retry_timeout:[78,84],memcached_behavior_server_failure_limit:[78,84],memcached_behavior_set:[68,78,84,92],memcached_behavior_snd_timeout:[78,84],memcached_behavior_socket_recv_s:[78,84],memcached_behavior_socket_send_s:[78,84],memcached_behavior_sort_host:84,memcached_behavior_support_ca:[78,84],memcached_behavior_t:[84,95],memcached_behavior_tcp_keepal:78,memcached_behavior_tcp_nodelai:[78,84],memcached_behavior_use_udp:[75,78,82,84,86,93,100,101,102,106],memcached_behavior_user_data:84,memcached_behavior_verify_kei:84,memcached_buff:[62,77,85],memcached_ca:[82,86,101],memcached_callback_cleanup_funct:85,memcached_callback_clone_funct:85,memcached_callback_delete_trigg:85,memcached_callback_free_funct:85,memcached_callback_get:[68,85],memcached_callback_get_failur:85,memcached_callback_malloc_funct:85,memcached_callback_namespac:[84,85],memcached_callback_prefix_kei:85,memcached_callback_realloc_funct:85,memcached_callback_set:[68,85],memcached_callback_t:85,memcached_callback_user_data:85,memcached_calloc_fn:94,memcached_cas_by_kei:86,memcached_client_error:[62,77],memcached_clon:[68,87,95],memcached_connection_bind_failur:[62,77],memcached_connection_failur:[62,77],memcached_connection_socket_create_failur:[62,77],memcached_continu:77,memcached_continuum_addit:73,memcached_cr:[68,79,87],memcached_data_does_not_exist:[62,77],memcached_data_exist:[62,77],memcached_decr:[68,83],memcached_decrement_by_kei:83,memcached_decrement_with_initi:83,memcached_decrement_with_initial_by_kei:83,memcached_default_connect_timeout:73,memcached_default_port:68,memcached_default_timeout:73,memcached_delet:[62,68,77,85,88],memcached_delete_by_kei:[68,88],memcached_deprec:[62,77],memcached_destroy_sasl_auth_data:98,memcached_distribution_consist:84,memcached_distribution_consistent_ketama:84,memcached_distribution_modula:84,memcached_dump:[68,89],memcached_dump_fn:89,memcached_e2big:[62,77],memcached_end:[62,75,77,93],memcached_errno:[62,77],memcached_execute_fn:93,memcached_exist:74,memcached_exist_by_kei:74,memcached_expiration_not_add:83,memcached_fail:77,memcached_fail_unix_socket:[62,77],memcached_failur:[62,77,85,94],memcached_fat:77,memcached_fetch:[66,68,79,84,96],memcached_fetch_execut:[68,84,85,93],memcached_fetch_notfinish:[62,77],memcached_fetch_result:[68,75,84,93],memcached_flush:90,memcached_flush_buff:91,memcached_fre:[68,78,79,87,96,98],memcached_free_fn:94,memcached_generate_hash:92,memcached_generate_hash_valu:92,memcached_get:[68,84,93],memcached_get_by_kei:[68,84,93],memcached_get_memory_alloc:[68,94],memcached_get_memory_allocators_context:94,memcached_get_sasl_callback:98,memcached_get_user_data:[68,104],memcached_hash_crc:[84,92],memcached_hash_default:[84,92],memcached_hash_fnv1_32:[84,92],memcached_hash_fnv1_64:[84,92],memcached_hash_fnv1a_32:[84,92],memcached_hash_fnv1a_64:[84,92],memcached_hash_hsieh:[84,92],memcached_hash_jenkin:[84,92],memcached_hash_md5:[84,92],memcached_hash_murmur3:92,memcached_hash_murmur:[84,92],memcached_hash_t:92,memcached_host_lookup_failur:[62,77],memcached_in_progress:95,memcached_incr:[68,83],memcached_increment_by_kei:83,memcached_increment_with_initi:83,memcached_increment_with_initial_by_kei:83,memcached_instance_st:[99,100,102],memcached_invalid_argu:[62,77,95],memcached_invalid_host_protocol:[62,77,84,100],memcached_item:[62,77],memcached_ketama_compat_libmemcach:84,memcached_ketama_compat_spi:84,memcached_key_too_big:[62,75,77],memcached_last_error_messag:76,memcached_lib_vers:[68,106],memcached_malloc_fn:94,memcached_max_buff:68,memcached_max_host_length:[68,100],memcached_max_kei:[68,75,79,85],memcached_maximum_return:62,memcached_memory_allocation_failur:[62,77],memcached_mget:[68,75,79,84,93],memcached_mget_by_kei:[68,84,93],memcached_mget_execut:93,memcached_mget_execute_by_kei:93,memcached_no_key_provid:[62,77],memcached_no_serv:[62,77],memcached_not_support:[62,75,77,84,93,102,106],memcached_notfound:[62,74,75,77,93,95],memcached_notstor:[62,77,101],memcached_parse_error:[62,77],memcached_parse_user_error:[62,77],memcached_partial_read:[62,77],memcached_pool:[79,95,97,98],memcached_pool_behavior_get:95,memcached_pool_behavior_set:95,memcached_pool_cr:[80,95],memcached_pool_destroi:[79,80,95],memcached_pool_fetch:95,memcached_pool_pop:[79,80,95],memcached_pool_push:[79,80,95],memcached_pool_releas:95,memcached_pool_st:[79,95],memcached_prefix_key_max_s:[68,73,85],memcached_prepend:[68,82,86,101],memcached_prepend_by_kei:82,memcached_protocol_error:[62,77],memcached_quit:[68,93,96],memcached_read_failur:[62,77],memcached_realloc_fn:94,memcached_replac:[68,82,86,101],memcached_replace_by_kei:101,memcached_result_ca:[68,86,97,101],memcached_result_cr:[68,97],memcached_result_flag:[68,97],memcached_result_fre:[68,97],memcached_result_key_length:[68,97],memcached_result_key_valu:[68,97],memcached_result_length:[68,97],memcached_result_set_expir:97,memcached_result_set_flag:97,memcached_result_set_valu:[68,97],memcached_result_st:[68,85,86,93,97,101],memcached_result_take_valu:97,memcached_result_valu:[68,97],memcached_return_t:[66,68,70,71,74,75,78,79,81,82,83,84,85,86,88,89,90,91,93,94,95,96,97,98,99,100,101,102,105,106],memcached_serv:[0,2,3,6,7,9,10,11,12,13],memcached_server_add:[68,100],memcached_server_add_udp:100,memcached_server_add_unix_socket:[68,100],memcached_server_by_kei:100,memcached_server_count:[68,100],memcached_server_cursor:100,memcached_server_error:[62,77,99],memcached_server_error_reset:99,memcached_server_failure_dead_timeout:73,memcached_server_failure_limit:73,memcached_server_failure_retry_timeout:73,memcached_server_fn:100,memcached_server_get_last_disconnect:100,memcached_server_list:[68,99],memcached_server_list_append:[68,99],memcached_server_list_count:[68,99],memcached_server_list_fre:[68,99],memcached_server_list_st:99,memcached_server_marked_dead:[62,77],memcached_server_push:[68,100],memcached_server_st:[99,100],memcached_servers_pars:99,memcached_servers_reset:87,memcached_set:[68,79,82,84,86,101],memcached_set_by_kei:101,memcached_set_encoding_kei:70,memcached_set_memory_alloc:[68,85,94],memcached_set_sasl_auth_data:98,memcached_set_sasl_callback:98,memcached_set_user_data:[68,104],memcached_some_error:[62,77],memcached_st:[44,66,68,70,71,74,75,76,77,78,79,80,81,82,83,84,85,86,88,89,90,91,92,93,94,95,96,97,98,99,101,102,103,104,105,106],memcached_stat:[62,77,84,102],memcached_stat_execut:102,memcached_stat_fn:102,memcached_stat_get_kei:102,memcached_stat_get_valu:102,memcached_stat_servernam:102,memcached_stat_st:[81,102],memcached_stor:[62,77],memcached_strerror:[68,70,71,74,75,76,77,78,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,105,106],memcached_strid:68,memcached_success:[62,70,71,74,77,79,82,83,84,85,86,88,89,90,91,93,94,95,96,98,101,105,106],memcached_timeout:[62,77,95],memcached_touch:[66,69],memcached_touch_by_kei:[66,69],memcached_trigger_delete_kei:85,memcached_trigger_kei:85,memcached_unix_socket_path_too_big:77,memcached_unknown_read_failur:[62,77],memcached_unknown_stat_kei:[62,77],memcached_util:80,memcached_valu:[62,77],memcached_verbos:[68,105],memcached_vers:[68,84,106],memcached_version_string_length:73,memcached_worker_error:77,memcached_write_failur:[62,77,82,86,101],memcap:66,memcat:[66,68],memcp:[66,68],memdump:[66,68],memerror:[66,68],memexist:66,memflush:[66,68],memori:[0,22,39,63,68,79,81,87,88,93,94,97,98,99,102],memp:66,mempars:[45,66],memrm:[66,68],memslap:[0,66,68],memstat:[66,68,81,102],memtouch:66,merchant:61,messag:[0,66,76,84,88,99],met:61,method:[26,42,68,75,81,82,84,86,90,92,93,95,98,101,102],michael:61,micro:106,microsecond:84,middl:[93,96],millisecond:84,min:[0,78],mingqiang:0,mingqiangzhuang:0,minim:84,minimum:0,minor:106,minu:72,minut:0,miss:[0,11,84],mmc:95,mode:[84,88,101],model:78,modif:61,modifi:[66,78,82,94,99,102,103,105],modifii:105,modul:0,modular:68,more:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,63,64,65,67,68,70,71,74,75,76,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107],most:[0,35,82,87,97,101],msg:78,much:[0,63],mulit:0,multi:[52,82,86,101],multiget:[84,93],multipl:[0,2,68,80,84,90,93],must:[0,61,68,75,81,82,84,85,93,97,100,101,102,103],name:[3,6,9,13,61,78,84],namespac:[68,78],natur:[0,68,93],nearli:[68,103],necessari:92,need:[0,22,76,84,85,93,94,95,96,102],neglig:61,neither:61,nelem:94,net:0,net_rat:0,network:[68,101],never:0,next:[0,84],nic:57,nodelai:78,non:[0,63,82,84,86,88,101],nor:[61,102],norby:[1,91,95,98],norepli:78,normal:[84,92],note:[86,87,88,93,98,101],noth:85,notic:[61,79],now:84,nth:0,number:[1,22,52,68,78,84,100],number_of_callback:[89,93,100],number_of_kei:93,nummber:78,object:[0,25,28,40,41,44,54,63,65,68,75,78,79,82,83,84,85,86,93,95,97,101,102],object_byt:0,obtain:[95,102],occur:[0,16,19,21,22,29,30,33,39,45,46,48,49,50,52,57,60,76,78,84,95,101],off:84,offset:[0,83],old:0,older:35,onc:[0,84,93],one:[0,3,68,83,92,93,94,100],onli:[0,1,36,38,47,57,59,64,68,70,78,83,84,85,87,88,92,93,94,97],open:[0,68,84],oper:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,56,68,79,82,83,84,86,90,92,93,94,96,99,100,101],ops:0,optim:94,option:[66,68,81,82,84,86,93,97,100,101,102],option_str:[78,95],option_string_length:95,optional_port:78,optional_weight:78,order:[0,68,78,84,85,90,94,100],org:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,63,64,65,67,68,70,71,74,75,76,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],origin:[75,100],other:[0,61,83,84,87],otherwis:[61,63,85,95,101],out:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,22,56,61,63,64,65,67,68,70,71,74,75,76,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,109],output:2,outsid:0,over:[87,97],overflow:83,overhead:[82,86,95,101],overrid:94,overwrit:[0,11,86,101],overwritten:0,own:[68,94,96,97,98],ownership:95,pack:0,packag:0,packet:0,packet_disord:0,packet_drop:0,page:66,pair:[0,102],parallel:0,paramet:[0,75,82,86,93,95,96,101,102,105],pars:[45,46,66],part:0,partcial:47,particular:[61,68,82,84,85,86,88,97,99,100,101,102],partit:[68,93],pass:[63,75,78,83,84,87,88,90,93,94,95,97,99,100,102],password:98,path:3,paus:14,payload:[82,86,101],penalti:84,per:[0,68],perform:[0,68,82,84,93,98,100,101],permiss:61,permit:61,piec:[63,82,85],ping:9,pipe:84,pkg_check_modul:68,place:[0,78,82,84,88,92,100],platform:[66,84],pleas:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,63,64,65,67,68,70,71,74,75,76,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107],plug:98,point:[84,85,86,101],pointer:[68,75,78,81,83,84,85,87,93,94,95,97,99,100,104],poll:[78,84],pool:[0,66,80],poor:84,popul:85,port:[0,1,68,76,99,100,102],possibl:[4,61,68,88,102,103],practic:[79,109],pre:63,precis:0,prefetch:78,prefix:[0,78,84,85],prepend:[66,78,84],preset:0,previou:104,primari:[84,85],print:1,printabl:[68,70,71,82,83,86,88,89,90,91,96,101,105,106],prior:61,problem:[0,93,100],problemat:84,process:[0,78,84,85,91,93],procur:61,produc:92,product:61,profit:61,promot:61,proper:0,properli:68,proport:[0,11],protocol:[1,35,48,53,58,68,78,82,83,84,86,89,93,98,101,102],prototyp:85,provid:[0,4,15,17,37,43,61,67,68,76,78,79,80,81,83,85,92,93,96,99,100,102],ptr:[63,70,71,74,75,77,81,82,83,84,85,86,87,88,89,90,91,92,93,94,96,97,98,99,100,101,102,103,104,105,106],pull:79,purpos:[0,61,97],push:[68,84,100],queri:[81,93,102],queu:88,queue:[84,88],quick:84,quit:[84,93],random:[0,78,84],randomli:[0,78],rang:0,rare:57,rate:[0,11],rcv:78,read:[0,47,49,57,68,78,84,85,97],read_byt:0,readabl:5,realli:[84,93],reason:[0,82,86,99,101],receiv:84,reciev:70,recommend:[0,68,78],reconnect:0,recv:78,redistribut:61,reduc:85,refer:[0,68,93],referenc:105,rel:95,relat:[87,97],relative_tim:95,releas:[79,93,95,97],reliabl:68,remot:84,remov:[66,84,88,95],remove_failed_serv:78,reorder:0,rep_writ:0,replac:[66,84,88],repli:78,replic:[68,78,84],replica:[68,78,84],report:[57,63,100],repres:106,reproduc:61,request:[18,23,24,25,26,28,32,40,41,51,52,54,55,78,82,84,86,93,101],requir:[66,84,85,93,97,98,99],reserv:61,reset:[7,78,84,85,94,96],resourc:[63,95],resp_freq:0,respond:[76,84],respons:[0,1,81,85,97,102,103],rest:[0,84],result:[0,66,68,75,81,84,85,86,92,93,100,101],retain:61,retri:78,retriev:[66,68,85,88,100,104],return_kei:79,return_key_length:79,return_valu:79,return_value_length:79,reus:97,right:61,round:0,rout:[68,100],run:[1,2,3,4,5,6,7,8,9,10,11,12,13,79,82,86,101],safe:[67,68,80,84,95],safeti:[87,97],same:[0,68,71,80,84,86,87,88,101],sampl:0,sasl:66,sasl_callback_t:[98,108],satisfi:95,save:[0,97,100],schooner:0,search:66,second:[0,1,84],section:0,see:[66,107],seed:83,segment:82,select:[0,78,84,93],self:0,send:[0,78,84,91,93],senf:91,sent:[0,12,70,82,84,85,86,99,101],sequenc:83,sequenti:0,server:[6,13,15,21,22,27,28,30,31,32,35,37,42,44,50,51,54,57,58,59,60,66,68,70,74,75,76,78,83,84,85,87,91,97,98],servernam:78,servic:61,set:[0,1,2,11,29,63,66,68,74,75,78,81,82,83,84,86,88,93,94,95,99,100,101,102,103,104,106],set_prop:0,setup:85,sever:0,shall:61,share:[68,83,84],should:[0,45,73,80,82,84,87,93,94,95,97,98,99,101,109],shown:0,side:68,sign:84,signific:92,similar:[0,2,3,82,86,87,93,101],simpl:[84,106],simul:0,sinc:[0,20,22,30,43,75,84,85,95,99],singl:[0,2,12,68,84,90,100],size:[11,12,68,75,78,82,84,86,93,94,95,97,101],size_t:[64,65,70,71,74,75,78,79,82,83,85,86,88,89,92,93,94,95,97,100,101,102,108],slab:12,slight:84,slot:73,small:[0,67,68,80],smugmug:61,snd:78,so_rcvbuf:84,so_rcvtimeo:84,so_sndbuf:84,so_sndtimeo:84,sock:0,socket:[0,20,31,78,84,93,100],softwar:61,solv:93,some:[0,52,68,84,93,99],someth:0,son:79,sort:[78,84],sourc:[61,68,87],space:[0,82,94,101],speak:35,special:[0,61],specif:[0,61,66,68,76,84,104],specifc:85,specifi:[0,1,2,3,6,7,9,10,11,12,13,63,68,83,84,85,94,95,98,102],speed:[0,68],split:[82,86,101],spy:84,ssd:0,stack:[87,97],standalon:[64,102],standard:[0,2,3,94],stapex:107,start:[0,84],start_len:0,startup:0,stat:[12,53,58,81,102],stat_freq:0,state:[12,38,75,81,93,96,100,102],statement:84,statist:66,statu:12,std:0,std_dev:0,stdout:[2,12],still:[72,84,86,101],storag:[68,84,93],store:[0,2,27,41,54,66,68,75,78,82,84,85,93,97,98,99],strict:61,stride:68,string:[0,45,46,66,68,70,71,78,82,83,86,88,89,90,91,95,96,101,105,106],string_length:[70,78],strive:84,strlen:[78,79],struct:[95,108],structur:[66,68,81,84,85,86,87,93,94,95,96,97,99,100,101,102,104,106],strutur:92,style:99,sub:[82,101],substitut:61,succe:[83,88],success:[47,63,70,71,75,81,82,83,84,85,86,88,89,90,91,93,94,95,96,98,101,105,106],successfulli:[54,55],suffix:0,suggest:97,suppli:[34,63,68,75,82,86,93,101,102],support:[42,66,68,70,78,84],sure:[0,87],synchron:68,synonym:95,system:[0,68,84],systemtap:66,tabl:0,take:[9,71,82,83,84,85,88,89,92,93,97,100,101,103],tangent:[0,2,3,4,5,6,7,8,9,10,11,13,70,71,85,88,89,90,91,92,95,96,98,102],tcp:[78,84,100],tcp_keepal:84,technolgi:0,ten:0,termin:[96,100,102],test:[66,75,79,82,84,86,88,93,97,101],tests:[0,82,84,86,89,101],testss:0,text:[82,99,101],textual:84,than:[0,82,84,86,100,101],thei:[0,82,84,89,90,93,97,101,102],them:[0,94,97],theori:[0,61],theses:99,thi:[0,7,15,36,38,59,61,65,68,70,71,75,76,78,81,82,83,84,85,86,88,89,90,91,92,93,94,96,97,98,99,100,101,102,103,105,106,107],thing:83,those:[75,93],though:0,thread:[11,67,95],three:[75,79,93],through:[68,85,97,100],throughput:[0,11],till:99,time:[11,56,71,80,82,83,84,88,90,95,101],time_t:[71,79,82,83,86,88,90,97,101,108],timeout:[0,1,78,84,95,96],timespec:[95,108],togeth:[0,84],toggl:84,told:4,too:[27,35,37,76,85],tool:[0,2,3,4,5,6,7,8,9,10,11,12,13,68,81,102],top:80,topic:66,tort:61,total:[0,82,86,101],touch:66,tps:0,traffic:84,translat:[66,68,70,71,82,83,86,88,89,90,91,96,101,105,106],transport:[68,84],tri:[0,1],trigger:[85,93,97],trond:[1,91,95,98],tunabl:68,tune:84,turn:[84,86,101],two:[0,83],type:[0,65,66,70,71,82,83,86,88,89,90,91,96,101,103,105],typedef:85,udp:[78,84,100],udp_timeout:0,uin64_t:84,uint32_t:[64,65,75,79,82,83,86,89,92,93,97,99,100,101,105,108],uint64_t:[0,83,84,86,95,97,108],underflow:83,understand:68,undertermin:52,unexpir:0,unexpired_unget:0,uniqu:0,unix:[2,3,31,78,100],unknown:[16,19,21,30,48,50,57],unless:[97,101],unlik:78,unreli:0,unsign:[79,84],until:[84,93],updat:[0,71],upon:[74,75,85,93,94,95,98],usag:[66,68,79,84,85],use:[0,45,61,63,64,68,78,79,80,81,82,83,84,85,86,87,89,93,94,95,97,98,101],used:[0,8,9,12,61,64,65,68,70,71,74,75,76,78,79,82,84,85,87,88,89,90,91,93,94,95,97,98,99,100,101,102,104,106,109],useful:[67,81],user:[0,63,66,68,82,86,101],usernam:98,uses:[0,86,102],using:[0,63,64,68,75,78,82,83,84,86,87,88,92,93,95,97,101],util:[0,2,80],valid:[8,15,17,34,84],valu:[2,3,6,9,11,13,59,66,68,70,71,73,74,75,78,81,82,84,85,86,88,89,90,91,93,94,95,96,97,99,100,101,102,103,104,105,106],value_length:[75,79,82,86,93,101,102],value_s:0,vari:[97,99,100,102],variabl:[0,2,3,6,7,9,10,11,12,13,68,75,93],varieti:64,variou:[1,64],verbos:[0,66],veri:[0,100],verifi:[0,1,78,84],verify_fail:0,verify_miss:0,version:[0,1,20,22,30,43,66,68,74,75,82,84,85,88,92,94,95,99,101],via:[0,2,3,6,7,9,10,11,12,13,31,83,93,100,107],wai:[0,61,82,84,87,101],wait:[0,95],wallner:61,want:[0,68,80,84,94,102],warranti:61,watermark:78,weak:84,web:68,weight:[78,84],well:[0,82,86,101],were:[20,34,63,75,84,90,93,94],what:[45,93,101],whatev:[75,93],when:[0,1,57,68,75,78,79,82,83,84,85,86,87,93,95,96,101],whenev:75,where:[57,63,84],whether:[0,61,82,84,86,101],which:[0,12,29,58,68,75,76,78,82,84,85,86,88,92,93,94,97,99,100,101],whole:0,win_siz:0,wipe:66,wish:[87,97,102],within:[0,6,78,84],without:[3,61,68,84,102],won:88,work:[0,66,68,71,79,84,88,93],workload:[0,11],would:[92,94,100,109],write:[0,60,68,81,84,87,93,97,101,102],written:[0,61,68,86,101],written_byt:0,you:[0,2,3,6,7,9,10,11,12,13,22,35,45,58,63,68,75,78,79,80,81,82,83,84,85,86,87,88,89,92,93,94,95,96,97,98,99,100,101,102,103,104,109],your:[0,66,68,78,84,85,94,96,97,98],zero:[83,87,90,99],zhuang:0},titles:["memaslap - Load testing and benchmarking a server","memcapable - Checking a Memcached server capibilities and compatibility","memcat - \u201ccat\u201d data from a server","memcp - Copy data to a server","memdump - Dumping your server","memerror - translate an error code to a string","memexist - Check for the existance of a key","memflush - flush all data from a server","memparse - Parse an option string","memping - Test to see if a server is available.","memrm - Remove data from a server","memslap - Load testing and benchmarking a server","memstat - Gather statistics from a server","memtouch - Touches a key.","MEMCACHED_AUTH_CONTINUE","MEMCACHED_AUTH_FAILURE","MEMCACHED_AUTH_PROBLEM","MEMCACHED_BAD_KEY_PROVIDED","MEMCACHED_BUFFERED","MEMCACHED_CLIENT_ERROR","MEMCACHED_CONNECTION_BIND_FAILURE","MEMCACHED_CONNECTION_FAILURE","MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE","MEMCACHED_DATA_DOES_NOT_EXIST","MEMCACHED_DATA_EXISTS","MEMCACHED_DELETED","MEMCACHED_DEPRECATED","MEMCACHED_E2BIG","MEMCACHED_END","MEMCACHED_ERRNO","MEMCACHED_FAILURE","MEMCACHED_FAIL_UNIX_SOCKET","MEMCACHED_FETCH_NOTFINISHED","MEMCACHED_HOST_LOOKUP_FAILURE","MEMCACHED_INVALID_ARGUMENTS","MEMCACHED_INVALID_HOST_PROTOCOL","MEMCACHED_ITEM","MEMCACHED_KEY_TOO_BIG","MEMCACHED_MAXIMUM_RETURN","MEMCACHED_MEMORY_ALLOCATION_FAILURE","MEMCACHED_NOTFOUND","MEMCACHED_NOTSTORED","MEMCACHED_NOT_SUPPORTED","MEMCACHED_NO_KEY_PROVIDED","MEMCACHED_NO_SERVERS","MEMCACHED_PARSE_ERROR","MEMCACHED_PARSE_USER_ERROR","MEMCACHED_PARTIAL_READ","MEMCACHED_PROTOCOL_ERROR","MEMCACHED_READ_FAILURE","MEMCACHED_SERVER_ERROR","MEMCACHED_SERVER_MARKED_DEAD","MEMCACHED_SOME_ERRORS","MEMCACHED_STAT","MEMCACHED_STORED","MEMCACHED_SUCCESS","MEMCACHED_TIMEOUT","MEMCACHED_UNKNOWN_READ_FAILURE","MEMCACHED_UNKNOWN_STAT_KEY","MEMCACHED_VALUE","MEMCACHED_WRITE_FAILURE","Copyright","Client Error messages","Creating a hashkit structure","Available Hashes","hashkit_value","Welcome to the libmemcached documentation","Introducing libhashkit","Introducing the C Client Library for memcached","libmemcached 1.0 API","Set encryption key","memcached_touch, memcached_touch_by_key","libmemcached 1.1 API","DEFAULTS","Determine if a keys exists.","memcached_fetch","Retrieving errors","Error Codes (memcached_return_t)","Configuring Libmemcached","Examples","Introducing libmemcachedutil","Anaylzing servers","Appending or Prepending to data on the server","Incrementing and Decrementing Values","Modifying how the driver behaves","Setting callbacks","Working with data on the server in an atomic fashion","Creating and destroying a memcached_st","Deleting data from a server","Dumping data from a server","Wiping clean the contents of a server","Flushing client buffers","Generating hash values directly","Retrieving data from the server","Use custom allocators for embedded usage","Working with memcached pools","Disconnecting a client from a server","Working with result sets","SASL support","Managing lists of servers","Manipulate the server information stored in memcached_st","Store, replace, add, or atomically add data to the server","Working with statistical information from a server","Coverting Errors, memcached_return_t, to strings","Storing custom user information in the client.","Setting the verbosity of a server","Getting version information about the client and server","Systemtap support","Required C types","Versioning"],titleterms:{"default":73,"return":[63,64,65,70,71,74,75,76,77,78,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],AND:68,Adding:79,Use:94,Used:108,Useful:0,about:106,add:101,all:7,alloc:94,also:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,63,64,65,67,68,70,71,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],anaylz:81,api:[69,72],append:82,atom:[86,101],author:[0,1,2,3,4,5,6,7,8,9,10,11,13,70,71,85,88,89,90,91,92,95,96,98,102],avail:[9,64],behav:84,benchmark:[0,11],binari:0,buffer:91,callback:85,capibl:1,cat:2,check:[1,6],clean:90,client:[62,68,91,96,104,106],code:[5,77],command:0,compat:1,concurr:0,config:0,configur:[0,78],connect:[0,79],constant:68,content:90,copi:3,copyright:61,covert:103,creat:[63,79,87],custom:[94,104],data:[2,3,7,10,82,86,88,89,93,101],decrement:83,delet:88,descript:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,63,64,65,67,68,70,71,74,75,76,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],destroi:87,detail:0,determin:74,directli:92,disconnect:96,distribut:0,document:66,driver:84,dump:[0,4,89],effect:0,embed:94,encrypt:70,error:[5,62,76,77,103],exampl:[0,78,79],execut:0,exist:[6,74],facebook:0,fashion:86,featur:0,fetch:79,file:0,flush:[7,91],format:0,from:[2,7,10,12,88,89,93,96,102],gather:12,gener:[0,92],get:[0,106],hash:[64,92],hashkit:63,hashkit_valu:65,home:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,63,64,65,67,68,70,71,74,75,76,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],how:84,implement:0,increment:83,indic:66,inform:[0,100,102,104,106],introduc:[67,68,80],kei:[0,6,13,70,74],libhashkit:67,libmemcach:[66,69,72,77,78],libmemcachedutil:80,librari:[68,104],limit:1,list:99,load:[0,11],manag:99,manipul:100,mecach:78,memaslap:0,memcach:[1,68,95],memcached_auth_continu:14,memcached_auth_failur:15,memcached_auth_problem:16,memcached_bad_key_provid:17,memcached_buff:18,memcached_client_error:19,memcached_connection_bind_failur:20,memcached_connection_failur:21,memcached_connection_socket_create_failur:22,memcached_data_does_not_exist:23,memcached_data_exist:24,memcached_delet:25,memcached_deprec:26,memcached_e2big:27,memcached_end:28,memcached_errno:29,memcached_fail_unix_socket:31,memcached_failur:30,memcached_fetch:75,memcached_fetch_notfinish:32,memcached_host_lookup_failur:33,memcached_invalid_argu:34,memcached_invalid_host_protocol:35,memcached_item:36,memcached_key_too_big:37,memcached_maximum_return:38,memcached_memory_allocation_failur:39,memcached_no_key_provid:43,memcached_no_serv:44,memcached_not_support:42,memcached_notfound:40,memcached_notstor:41,memcached_parse_error:45,memcached_parse_user_error:46,memcached_partial_read:47,memcached_protocol_error:48,memcached_read_failur:49,memcached_return_t:[77,103],memcached_server_error:50,memcached_server_marked_dead:51,memcached_some_error:52,memcached_st:[87,100],memcached_stat:53,memcached_stor:54,memcached_success:55,memcached_timeout:56,memcached_touch:71,memcached_touch_by_kei:71,memcached_unknown_read_failur:57,memcached_unknown_stat_kei:58,memcached_valu:59,memcached_write_failur:60,memcap:1,memcat:2,memcp:3,memdump:4,memerror:5,memexist:6,memflush:7,memp:9,mempars:8,memrm:10,memslap:11,memstat:12,memtouch:13,messag:62,mode:0,modifi:84,multi:0,multipl:79,network:0,note:[84,94],number:0,option:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,78],other:78,output:0,pars:8,period:0,pool:[78,79,95],prepend:82,process:68,protocol:0,remov:10,replac:101,replic:0,requir:108,result:97,retriev:[76,93],run:0,sasl:98,schedul:0,see:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,63,64,65,67,68,70,71,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],server:[0,1,2,3,4,7,9,10,11,12,79,81,82,86,88,89,90,93,96,99,100,101,102,105,106],set:[70,85,97,105],simpl:0,size:0,statist:[0,12,102],store:[100,101,104],string:[5,8,103],structur:63,support:[0,98,107],synopsi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,63,64,65,68,70,71,74,75,76,77,78,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106],systemtap:107,tabl:66,task:0,tcp:0,test:[0,9,11],thousand:0,thread:[0,68,80],time:0,touch:13,translat:5,type:[77,108],udp:0,usag:[0,94],useful:0,user:104,valu:[0,63,64,65,79,83,92],verbos:105,verif:0,version:[106,109],welcom:66,where:0,window:0,wipe:90,work:[86,95,97,102],your:4}}) \ No newline at end of file diff --git a/tap.html b/tap.html new file mode 100644 index 00000000..810baa11 --- /dev/null +++ b/tap.html @@ -0,0 +1,743 @@ + + + + + + + + + + + Systemtap support — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Systemtap support
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Systemtap support¶

+

By default on Linux libmemcached is compiled to support Systemtap. This enabled/disabled during compiles via the dtrace configure flag.

+

Please see :manpage: stapex for more information about Systemtap.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/types.html b/types.html new file mode 100644 index 00000000..09f254f3 --- /dev/null +++ b/types.html @@ -0,0 +1,787 @@ + + + + + + + + + + + Required C types — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Required C types
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Required C types¶

+
+

Types¶

+
+
+

C Types Used¶

+
+
+bool¶
+
+ +
+
+uint32_t¶
+
+ +
+
+uint64_t¶
+
+ +
+
+in_port_t¶
+
+ +
+
+size_t¶
+
+ +
+
+time_t¶
+
+ +
+
+struct timespec¶
+
+ +
+
+sasl_callback_t¶
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/versioning.html b/versioning.html new file mode 100644 index 00000000..4b6c7369 --- /dev/null +++ b/versioning.html @@ -0,0 +1,743 @@ + + + + + + + + + + + Versioning — libmemcached documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Versioning
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ +
+

Versioning¶

+

Libmemcached is layed out by interface version. The 1.0 version would be found in: libmemcached-1.0/memcached.h

+

The historic libmemcached/memcached.h includes libmemcached-1.0/memcached.h. For best practice you should include the version of libmemcacached that you used during development.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file