X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libmemcached%2Fmemcached.h;h=099a4b306960f26323fc3f274034b4cac81c84c3;hb=4cd075fbd0fab78e393c1559db340a221196a006;hp=62d3b1dc58669dffe38a7603a90765f857408e2b;hpb=dac48f2dbe34915755f8f4f7f88419f47dc9e27f;p=awesomized%2Flibmemcached diff --git a/libmemcached/memcached.h b/libmemcached/memcached.h index 62d3b1dc..099a4b30 100644 --- a/libmemcached/memcached.h +++ b/libmemcached/memcached.h @@ -1,35 +1,63 @@ -/* 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__ +#pragma once -#include #include +#include +#include + #if !defined(__cplusplus) # include #endif -#include -#include - #include #include +#include #include +#include #include #include +#include +#include #include #include + // Everything above this line must be in the order specified. #include #include @@ -43,37 +71,17 @@ #include #include #include +#include #include #include #include #include +#include #include #include #include #include - -#ifdef __cplusplus -extern "C" { -#endif - -LIBMEMCACHED_API -void memcached_servers_reset(memcached_st *ptr); - -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, const memcached_st *ptr); - -LIBMEMCACHED_API -void *memcached_get_user_data(const memcached_st *ptr); - -LIBMEMCACHED_API -void *memcached_set_user_data(memcached_st *ptr, void *data); - +#include struct memcached_st { /** @@ -82,29 +90,28 @@ struct memcached_st { 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 cork: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 continuum_points_counter; // Ketama uint32_t number_of_hosts; memcached_server_st *servers; memcached_server_st *last_disconnected_server; @@ -114,147 +121,92 @@ struct memcached_st { uint32_t io_msg_watermark; uint32_t io_bytes_watermark; uint32_t io_key_prefetch; - int cached_errno; + 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; - hashkit_st distribution_hashkit; memcached_result_st result; - memcached_continuum_item_st *continuum; // Ketama - struct _allocators_st { - memcached_calloc_fn calloc; - memcached_free_fn free; - memcached_malloc_fn malloc; - memcached_realloc_fn realloc; - void *context; - } allocators; + 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 memcached_allocator_t allocators; 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; - char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE]; + 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; +}; + #ifdef __cplusplus - memcached_st() : - state(), - flags(), - distribution(), - hashkit(), - continuum_points_counter(), - number_of_hosts(), - servers(), - last_disconnected_server(), - snd_timeout(), - rcv_timeout(), - server_failure_limit(), - io_msg_watermark(), - io_bytes_watermark(), - io_key_prefetch(), - cached_errno(), - poll_timeout(), - connect_timeout(), - retry_timeout(), - continuum_count(), - send_size(), - recv_size(), - user_data(), - next_distribution_rebuild(), - prefix_key_length(), - number_of_replicas(), - distribution_hashkit(), - result(), - continuum(), - allocators(), - on_clone(), - on_cleanup(), - get_key_failure(), - delete_trigger(), - callbacks(), - prefix_key(), - options() - { - memcached_create(this); - } +extern "C" { +#endif + +LIBMEMCACHED_API +void memcached_servers_reset(memcached_st *ptr); - ~memcached_st() - { - memcached_free(this); - } +LIBMEMCACHED_API +memcached_st *memcached_create(memcached_st *ptr); - memcached_st(const memcached_st& source) : - state(), - flags(), - distribution(), - hashkit(), - continuum_points_counter(), - number_of_hosts(), - servers(), - last_disconnected_server(), - snd_timeout(), - rcv_timeout(), - server_failure_limit(), - io_msg_watermark(), - io_bytes_watermark(), - io_key_prefetch(), - cached_errno(), - poll_timeout(), - connect_timeout(), - retry_timeout(), - continuum_count(), - send_size(), - recv_size(), - user_data(), - next_distribution_rebuild(), - prefix_key_length(), - number_of_replicas(), - distribution_hashkit(), - result(), - continuum(), - allocators(), - on_clone(), - on_cleanup(), - get_key_failure(), - delete_trigger(), - callbacks(), - prefix_key(), - options() - { - memcached_clone(this, &source); - } +LIBMEMCACHED_API +memcached_st *memcached(const char *string, size_t string_length); - memcached_st& operator=(const memcached_st& source) - { - memcached_clone(this, &source); +LIBMEMCACHED_API +void memcached_free(memcached_st *ptr); - return *this; - } +LIBMEMCACHED_API +memcached_return_t memcached_reset(memcached_st *ptr); -#endif -}; +LIBMEMCACHED_API +void memcached_reset_last_disconnected_server(memcached_st *ptr); + +LIBMEMCACHED_API +memcached_st *memcached_clone(memcached_st *clone, const memcached_st *ptr); + +LIBMEMCACHED_API +void *memcached_get_user_data(const memcached_st *ptr); + +LIBMEMCACHED_API +void *memcached_set_user_data(memcached_st *ptr, void *data); -// Local Only Inline -static inline memcached_server_st *memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key) -{ - return &ptr->servers[server_key]; -} +LIBMEMCACHED_API +memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source); +LIBMEMCACHED_API +memcached_server_instance_st memcached_server_instance_by_position(const memcached_st *ptr, uint32_t server_key); + +LIBMEMCACHED_API +uint32_t memcached_server_count(const memcached_st *); + +LIBMEMCACHED_API +uint64_t memcached_query_id(const memcached_st *); #ifdef __cplusplus } // extern "C" #endif - - -#endif /* __MEMCACHED_H__ */