X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libmemcached%2Fmemcached.h;h=e3817892139f3afcc784dfedeaca669026219b49;hb=b048aacba5d279f3271163cfaa0704684beca1e2;hp=e4510d6d9290f2f26f3c8e63c35c85b4b3b032d5;hpb=3928e14fbe1ed17cefe9bdbbb282fb7ecf053e7a;p=awesomized%2Flibmemcached diff --git a/libmemcached/memcached.h b/libmemcached/memcached.h index e4510d6d..e3817892 100644 --- a/libmemcached/memcached.h +++ b/libmemcached/memcached.h @@ -1,260 +1,215 @@ -/* LibMemcached - * Copyright (C) 2006-2009 Brian Aker - * All rights reserved. +/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab: + * + * Libmemcached library * - * Use and distribution licensed under the BSD license. See - * the COPYING file in the parent directory for full text. + * Copyright (C) 2011 Data Differential, http://datadifferential.com/ + * Copyright (C) 2006-2009 Brian Aker All rights reserved. * - * Summary: interface for memcached server - * Description: main include file for libmemcached + * 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. * */ -#ifndef __MEMCACHED_H__ -#define __MEMCACHED_H__ +#ifndef __LIBMEMCACHED_MEMCACHED_H__ +#define __LIBMEMCACHED_MEMCACHED_H__ -#include #include +#include +#include + #if !defined(__cplusplus) # include #endif -#include -#include - #include #include +#include #include #include #include +#include +#include #include +#include // Everything above this line must be in the order specified. +#include #include #include #include #include +#include #include +#include +#include +#include #include +#include +#include +#include +#include #include #include +#include #include - -#ifdef __cplusplus -extern "C" { -#endif +#include +#include +#include +#include struct memcached_st { - struct { - bool is_allocated:1; - bool is_initialized:1; - bool is_purging:1; - bool is_processing_input:1; - } options; - memcached_server_distribution_t distribution; - memcached_hash_t hash; - uint32_t continuum_points_counter; // Ketama - memcached_server_st *servers; - memcached_server_st *last_disconnected_server; - int32_t snd_timeout; - int32_t rcv_timeout; - uint32_t server_failure_limit; - uint32_t io_msg_watermark; - uint32_t io_bytes_watermark; - uint32_t io_key_prefetch; - uint32_t number_of_hosts; - int cached_errno; /** @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 ketama_weighted:1; - bool no_block:1; + bool no_block:1; // Don't block bool no_reply:1; bool randomize_replica_read:1; - bool reuse_memory:1; bool support_cas:1; bool tcp_nodelay:1; - bool use_cache_lookups: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 server_failure_limit; + uint32_t io_msg_watermark; + uint32_t io_bytes_watermark; + uint32_t io_key_prefetch; + uint32_t tcp_keepidle; int32_t poll_timeout; int32_t connect_timeout; int32_t retry_timeout; - uint32_t continuum_count; // Ketama int send_size; int recv_size; void *user_data; - time_t next_distribution_rebuild; // Ketama - size_t prefix_key_length; + uint64_t query_id; uint32_t number_of_replicas; - memcached_hash_t distribution_hash; + hashkit_st distribution_hashkit; memcached_result_st result; - memcached_continuum_item_st *continuum; // Ketama + + 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; + + struct memcached_virtual_bucket_t *virtual_bucket; + + struct _allocators_st { + memcached_calloc_fn calloc; + memcached_free_fn free; + memcached_malloc_fn malloc; + memcached_realloc_fn realloc; + void *context; + } allocators; + memcached_clone_fn on_clone; memcached_cleanup_fn on_cleanup; - memcached_free_fn call_free; - memcached_malloc_fn call_malloc; - memcached_realloc_fn call_realloc; - memcached_calloc_fn call_calloc; memcached_trigger_key_fn get_key_failure; memcached_trigger_delete_key_fn delete_trigger; memcached_callback_st *callbacks; - char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE]; + struct memcached_sasl_st sasl; + struct memcached_error_st *error_messages; + struct memcached_array_st *prefix_key; + struct { + struct memcached_array_st *filename; + } configure; + struct { + bool is_allocated:1; + } options; + }; -LIBMEMCACHED_API -memcached_return_t memcached_version(memcached_st *ptr); +#ifdef __cplusplus +extern "C" { +#endif LIBMEMCACHED_API void memcached_servers_reset(memcached_st *ptr); -// Local Only Inline -static inline memcached_server_st *memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key) -{ - return &ptr->servers[server_key]; -} - -/* Public API */ - -LIBMEMCACHED_API -const char * memcached_lib_version(void); - 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); - -LIBMEMCACHED_API -memcached_return_t memcached_delete(memcached_st *ptr, const char *key, size_t key_length, - time_t expiration); - -LIBMEMCACHED_API -memcached_return_t memcached_flush(memcached_st *ptr, time_t expiration); - -LIBMEMCACHED_API -memcached_return_t 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_t rc); - -/* The two public hash bits */ -LIBMEMCACHED_API -uint32_t memcached_generate_hash_value(const char *key, size_t key_length, memcached_hash_t hash_algorithm); - -LIBMEMCACHED_API -uint32_t memcached_generate_hash(memcached_st *ptr, const char *key, size_t key_length); - -LIBMEMCACHED_API -memcached_return_t memcached_flush_buffers(memcached_st *mem); - -/* Server Public functions */ - -LIBMEMCACHED_API -memcached_return_t memcached_server_add_udp(memcached_st *ptr, - const char *hostname, - in_port_t port); -LIBMEMCACHED_API -memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr, - const char *filename); -LIBMEMCACHED_API -memcached_return_t memcached_server_add(memcached_st *ptr, - const char *hostname, in_port_t port); LIBMEMCACHED_API -memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr, - const char *hostname, - in_port_t port, - uint32_t weight); -LIBMEMCACHED_API -memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr, - const char *filename, - uint32_t weight); -LIBMEMCACHED_API -memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname, - in_port_t port, - uint32_t weight); -LIBMEMCACHED_API -void memcached_server_list_free(memcached_server_st *ptr); +memcached_st *memcached_create_with_options(const char *string, size_t length); LIBMEMCACHED_API -memcached_return_t 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, - in_port_t port, - memcached_return_t *error); -LIBMEMCACHED_API -memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr, - const char *hostname, - in_port_t port, - uint32_t weight, - memcached_return_t *error); -LIBMEMCACHED_API -unsigned int memcached_server_list_count(memcached_server_st *ptr); +memcached_return_t memcached_reset(memcached_st *ptr); LIBMEMCACHED_API -memcached_server_st *memcached_servers_parse(const char *server_strings); +void memcached_reset_last_disconnected_server(memcached_st *ptr); LIBMEMCACHED_API -char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *memc_stat, - const char *key, memcached_return_t *error); -LIBMEMCACHED_API -char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *memc_stat, - memcached_return_t *error); +memcached_st *memcached_clone(memcached_st *clone, const memcached_st *ptr); LIBMEMCACHED_API -memcached_return_t 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); +void *memcached_get_user_data(const memcached_st *ptr); LIBMEMCACHED_API -memcached_return_t memcached_fetch_execute(memcached_st *ptr, - memcached_execute_fn *callback, - void *context, - unsigned int number_of_callbacks); +void *memcached_set_user_data(memcached_st *ptr, void *data); LIBMEMCACHED_API -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); +memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source); LIBMEMCACHED_API -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); +memcached_server_instance_st memcached_server_instance_by_position(const memcached_st *ptr, uint32_t server_key); LIBMEMCACHED_API -void *memcached_get_user_data(memcached_st *ptr); -LIBMEMCACHED_API -void *memcached_set_user_data(memcached_st *ptr, void *data); - -LIBMEMCACHED_LOCAL -memcached_return_t run_distribution(memcached_st *ptr); - -#define memcached_is_allocated(__object) ((__object)->options.is_allocated) -#define memcached_is_initialized(__object) ((__object)->options.is_initialized) +uint32_t memcached_server_count(const memcached_st *); #ifdef __cplusplus -} +} // extern "C" #endif +#endif /* __LIBMEMCACHED_MEMCACHED_H__ */ -#endif /* __MEMCACHED_H__ */