-/*
- * Summary: interface for memcached server
- * Description: main include file for libmemcached
+/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
+ *
+ * Libmemcached library
*
- * Copy: See Copyright for the status of this software.
+ * Copyright (C) 2011 Data Differential, http://datadifferential.com/
+ * Copyright (C) 2006-2009 Brian Aker All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * * 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.
+ *
+ * * The names of its contributors may not 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
+ * OWNER 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.
*
- * Author: Brian Aker
*/
-#ifndef __MEMCACHED_H__
-#define __MEMCACHED_H__
+#pragma once
-#include <stdlib.h>
#include <inttypes.h>
-#if !defined(__cplusplus)
-# include <stdbool.h>
-#endif
+#include <stdlib.h>
#include <sys/types.h>
-#include <netinet/in.h>
-#include <libmemcached/visibility.h>
-#include <libmemcached/memcached_configure.h>
-#include <libmemcached/memcached_constants.h>
-#include <libmemcached/memcached_types.h>
-#include <libmemcached/memcached_get.h>
-#include <libmemcached/memcached_server.h>
-#include <libmemcached/memcached_string.h>
-#include <libmemcached/memcached_result.h>
-#include <libmemcached/memcached_storage.h>
-#ifdef __cplusplus
-extern "C" {
+#if !defined(__cplusplus)
+# include <stdbool.h>
#endif
-#define MEMCACHED_VERSION_STRING_LENGTH 24
-
-struct memcached_analysis_st {
- uint32_t average_item_size;
- uint32_t longest_uptime;
- uint32_t least_free_server;
- uint32_t most_consumed_server;
- uint32_t oldest_server;
- double pool_hit_ratio;
- uint64_t most_used_bytes;
- uint64_t least_remaining_bytes;
-};
-
-struct memcached_stat_st {
- uint32_t connection_structures;
- uint32_t curr_connections;
- uint32_t curr_items;
- uint32_t pid;
- uint32_t pointer_size;
- uint32_t rusage_system_microseconds;
- uint32_t rusage_system_seconds;
- uint32_t rusage_user_microseconds;
- uint32_t rusage_user_seconds;
- uint32_t threads;
- uint32_t time;
- uint32_t total_connections;
- uint32_t total_items;
- uint32_t uptime;
- uint64_t bytes;
- uint64_t bytes_read;
- uint64_t bytes_written;
- uint64_t cmd_get;
- uint64_t cmd_set;
- uint64_t evictions;
- uint64_t get_hits;
- uint64_t get_misses;
- uint64_t limit_maxbytes;
- char version[MEMCACHED_VERSION_STRING_LENGTH];
-};
+#include <libmemcached/visibility.h>
+#include <libmemcached/configure.h>
+#include <libmemcached/platform.h>
+#include <libmemcached/constants.h>
+#include <libmemcached/return.h>
+#include <libmemcached/types.h>
+#include <libmemcached/string.h>
+#include <libmemcached/array.h>
+#include <libmemcached/error.h>
+#include <libmemcached/stats.h>
+#include <libhashkit/hashkit.h>
+
+// Everything above this line must be in the order specified.
+#include <libmemcached/allocators.h>
+#include <libmemcached/analyze.h>
+#include <libmemcached/auto.h>
+#include <libmemcached/behavior.h>
+#include <libmemcached/callback.h>
+#include <libmemcached/delete.h>
+#include <libmemcached/dump.h>
+#include <libmemcached/fetch.h>
+#include <libmemcached/flush.h>
+#include <libmemcached/flush_buffers.h>
+#include <libmemcached/get.h>
+#include <libmemcached/hash.h>
+#include <libmemcached/options.h>
+#include <libmemcached/parse.h>
+#include <libmemcached/quit.h>
+#include <libmemcached/result.h>
+#include <libmemcached/server.h>
+#include <libmemcached/server_list.h>
+#include <libmemcached/storage.h>
+#include <libmemcached/strerror.h>
+#include <libmemcached/verbosity.h>
+#include <libmemcached/version.h>
+#include <libmemcached/sasl.h>
struct memcached_st {
- uint8_t purging;
- bool is_allocated;
- uint8_t distribution;
- uint8_t hash;
- uint32_t continuum_points_counter;
- memcached_server_st *hosts;
+ /**
+ @note these are static and should not change without a call to behavior.
+ */
+ struct {
+ bool is_purging:1;
+ bool is_processing_input:1;
+ bool is_time_for_rebuild:1;
+ } state;
+
+ struct {
+ // Everything below here is pretty static.
+ bool auto_eject_hosts:1;
+ bool binary_protocol:1;
+ bool buffer_requests:1;
+ bool hash_with_prefix_key:1;
+ bool no_block:1; // Don't block
+ bool no_reply:1;
+ bool randomize_replica_read:1;
+ bool support_cas:1;
+ bool tcp_nodelay:1;
+ bool use_sort_hosts:1;
+ bool use_udp:1;
+ bool verify_key:1;
+ bool tcp_keepalive:1;
+ } flags;
+
+ memcached_server_distribution_t distribution;
+ hashkit_st hashkit;
+ uint32_t number_of_hosts;
+ memcached_server_st *servers;
memcached_server_st *last_disconnected_server;
int32_t snd_timeout;
int32_t rcv_timeout;
uint32_t io_msg_watermark;
uint32_t io_bytes_watermark;
uint32_t io_key_prefetch;
- uint32_t number_of_hosts;
- uint32_t cursor_server;
- int cached_errno;
- uint32_t flags;
+ uint32_t tcp_keepidle;
int32_t poll_timeout;
int32_t connect_timeout;
int32_t retry_timeout;
- uint32_t continuum_count;
int send_size;
int recv_size;
void *user_data;
- time_t next_distribution_rebuild;
- size_t prefix_key_length;
- memcached_hash hash_continuum;
- memcached_result_st result;
- memcached_continuum_item_st *continuum;
- memcached_clone_func on_clone;
- memcached_cleanup_func on_cleanup;
- memcached_free_function call_free;
- memcached_malloc_function call_malloc;
- memcached_realloc_function call_realloc;
- memcached_calloc_function call_calloc;
- memcached_trigger_key get_key_failure;
- memcached_trigger_delete_key delete_trigger;
- char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE];
+ uint64_t query_id;
uint32_t number_of_replicas;
- memcached_callback_st *callbacks;
-};
-
-LIBMEMCACHED_API
-memcached_return memcached_version(memcached_st *ptr);
-
-/* Public API */
+ hashkit_st distribution_hashkit;
+ memcached_result_st result;
-LIBMEMCACHED_API
-const char * memcached_lib_version(void);
+ struct {
+ bool weighted;
+ uint32_t continuum_count; // Ketama
+ uint32_t continuum_points_counter; // Ketama
+ time_t next_distribution_rebuild; // Ketama
+ memcached_continuum_item_st *continuum; // Ketama
+ } ketama;
-LIBMEMCACHED_API
-memcached_st *memcached_create(memcached_st *ptr);
-LIBMEMCACHED_API
-void memcached_free(memcached_st *ptr);
-LIBMEMCACHED_API
-memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
+ struct memcached_virtual_bucket_t *virtual_bucket;
-LIBMEMCACHED_API
-memcached_return memcached_delete(memcached_st *ptr, const char *key, size_t key_length,
- time_t expiration);
-LIBMEMCACHED_API
-memcached_return memcached_increment(memcached_st *ptr,
- const char *key, size_t key_length,
- uint32_t offset,
- uint64_t *value);
-LIBMEMCACHED_API
-memcached_return memcached_decrement(memcached_st *ptr,
- const char *key, size_t key_length,
- uint32_t offset,
- uint64_t *value);
+ struct memcached_allocator_t allocators;
-LIBMEMCACHED_API
-memcached_return memcached_increment_by_key(memcached_st *ptr,
- const char *master_key, size_t master_key_length,
- const char *key, size_t key_length,
- uint64_t offset,
- uint64_t *value);
+ memcached_clone_fn on_clone;
+ memcached_cleanup_fn on_cleanup;
+ memcached_trigger_key_fn get_key_failure;
+ memcached_trigger_delete_key_fn delete_trigger;
+ memcached_callback_st *callbacks;
+ struct memcached_sasl_st sasl;
+ struct memcached_error_t *error_messages;
+ struct memcached_array_st *prefix_key;
+ struct {
+ uint32_t initial_pool_size;
+ uint32_t max_pool_size;
+ int32_t version; // This is used by pool and others to determine if the memcached_st is out of date.
+ struct memcached_array_st *filename;
+ } configure;
+ struct {
+ bool is_allocated:1;
+ } options;
-LIBMEMCACHED_API
-memcached_return memcached_decrement_by_key(memcached_st *ptr,
- const char *master_key, size_t master_key_length,
- const char *key, size_t key_length,
- uint64_t offset,
- uint64_t *value);
+};
-LIBMEMCACHED_API
-memcached_return 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);
-LIBMEMCACHED_API
-memcached_return 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);
-LIBMEMCACHED_API
-memcached_return memcached_increment_with_initial_by_key(memcached_st *ptr,
- const char *master_key,
- size_t master_key_length,
- const char *key,
- size_t key_length,
- uint64_t offset,
- uint64_t initial,
- time_t expiration,
- uint64_t *value);
-LIBMEMCACHED_API
-memcached_return memcached_decrement_with_initial_by_key(memcached_st *ptr,
- const char *master_key,
- size_t master_key_length,
- const char *key,
- size_t key_length,
- uint64_t offset,
- uint64_t initial,
- time_t expiration,
- uint64_t *value);
-LIBMEMCACHED_API
-void memcached_stat_free(memcached_st *, memcached_stat_st *);
-LIBMEMCACHED_API
-memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
-LIBMEMCACHED_API
-memcached_return memcached_stat_servername(memcached_stat_st *memc_stat, char *args,
- char *hostname, unsigned int port);
-LIBMEMCACHED_API
-memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
-LIBMEMCACHED_API
-memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
-LIBMEMCACHED_API
-void memcached_quit(memcached_st *ptr);
-LIBMEMCACHED_API
-const char *memcached_strerror(memcached_st *ptr, memcached_return rc);
-LIBMEMCACHED_API
-memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, uint64_t data);
-LIBMEMCACHED_API
-uint64_t memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
+#ifdef __cplusplus
+extern "C" {
+#endif
-/* The two public hash bits */
LIBMEMCACHED_API
-uint32_t memcached_generate_hash_value(const char *key, size_t key_length, memcached_hash hash_algorithm);
-LIBMEMCACHED_API
-uint32_t memcached_generate_hash(memcached_st *ptr, const char *key, size_t key_length);
+void memcached_servers_reset(memcached_st *ptr);
LIBMEMCACHED_API
-memcached_return memcached_flush_buffers(memcached_st *mem);
-
-/* Server Public functions */
+memcached_st *memcached_create(memcached_st *ptr);
LIBMEMCACHED_API
-memcached_return memcached_server_add_udp(memcached_st *ptr,
- const char *hostname,
- unsigned int port);
-LIBMEMCACHED_API
-memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
- const char *filename);
-LIBMEMCACHED_API
-memcached_return memcached_server_add(memcached_st *ptr, const char *hostname,
- unsigned int port);
+memcached_st *memcached(const char *string, size_t string_length);
LIBMEMCACHED_API
-memcached_return memcached_server_add_udp_with_weight(memcached_st *ptr,
- const char *hostname,
- unsigned int port,
- uint32_t weight);
-LIBMEMCACHED_API
-memcached_return memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
- const char *filename,
- uint32_t weight);
-LIBMEMCACHED_API
-memcached_return memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
- unsigned int port,
- uint32_t weight);
-LIBMEMCACHED_API
-void memcached_server_list_free(memcached_server_st *ptr);
-LIBMEMCACHED_API
-memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
+void memcached_free(memcached_st *ptr);
LIBMEMCACHED_API
-memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
- const char *hostname,
- unsigned int port,
- memcached_return *error);
-LIBMEMCACHED_API
-memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr,
- const char *hostname,
- unsigned int port,
- uint32_t weight,
- memcached_return *error);
-LIBMEMCACHED_API
-unsigned int memcached_server_list_count(memcached_server_st *ptr);
-LIBMEMCACHED_API
-memcached_server_st *memcached_servers_parse(const char *server_strings);
+memcached_return_t memcached_reset(memcached_st *ptr);
LIBMEMCACHED_API
-char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *memc_stat,
- const char *key, memcached_return *error);
-LIBMEMCACHED_API
-char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *memc_stat,
- memcached_return *error);
+void memcached_reset_last_disconnected_server(memcached_st *ptr);
LIBMEMCACHED_API
-memcached_return memcached_delete_by_key(memcached_st *ptr,
- const char *master_key, size_t master_key_length,
- const char *key, size_t key_length,
- time_t expiration);
+memcached_st *memcached_clone(memcached_st *clone, const memcached_st *ptr);
LIBMEMCACHED_API
-memcached_return memcached_fetch_execute(memcached_st *ptr,
- memcached_execute_function *callback,
- void *context,
- unsigned int number_of_callbacks);
+void *memcached_get_user_data(const memcached_st *ptr);
LIBMEMCACHED_API
-memcached_return memcached_callback_set(memcached_st *ptr,
- memcached_callback flag,
- void *data);
-LIBMEMCACHED_API
-void *memcached_callback_get(memcached_st *ptr,
- memcached_callback flag,
- memcached_return *error);
+void *memcached_set_user_data(memcached_st *ptr, void *data);
LIBMEMCACHED_API
-memcached_return memcached_dump(memcached_st *ptr, memcached_dump_func *function, void *context, uint32_t number_of_callbacks);
-
+memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source);
LIBMEMCACHED_API
-memcached_return memcached_set_memory_allocators(memcached_st *ptr,
- memcached_malloc_function mem_malloc,
- memcached_free_function mem_free,
- memcached_realloc_function mem_realloc,
- memcached_calloc_function mem_calloc);
+memcached_server_instance_st memcached_server_instance_by_position(const memcached_st *ptr, uint32_t server_key);
LIBMEMCACHED_API
-void memcached_get_memory_allocators(memcached_st *ptr,
- memcached_malloc_function *mem_malloc,
- memcached_free_function *mem_free,
- memcached_realloc_function *mem_realloc,
- memcached_calloc_function *mem_calloc);
+uint32_t memcached_server_count(const memcached_st *);
LIBMEMCACHED_API
-void *memcached_get_user_data(memcached_st *ptr);
-LIBMEMCACHED_API
-void *memcached_set_user_data(memcached_st *ptr, void *data);
+uint64_t memcached_query_id(const memcached_st *);
-LIBMEMCACHED_LOCAL
-memcached_return run_distribution(memcached_st *ptr);
#ifdef __cplusplus
-}
+} // extern "C"
#endif
-
-
-#endif /* __MEMCACHED_H__ */
projects / awesomized / libmemcached / blobdiff