Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 392 lines (341 sloc) 10.411 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 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 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
* Copyright 2010 NorthScale, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/*! \mainpage libvbucket
*
* \section intro_sec Introduction
*
* libvbucket helps you understand and make use of vbuckets for
* scaling kv services.
*
* \section docs_sec API Documentation
*
* Jump right into <a href="modules.html">the modules docs</a> to get started.
*/

/**
* VBucket Utility Library.
*
* \defgroup CD Creation and Destruction
* \defgroup cfg Config Access
* \defgroup cfgcmp Config Comparison
* \defgroup vb VBucket Access
* \defgroup err Error handling
*/

#ifndef LIBVBUCKET_VBUCKET_H
#define LIBVBUCKET_VBUCKET_H 1

#include <stddef.h>
#include "visibility.h"

#ifdef __cplusplus
extern "C" {
#endif

    struct vbucket_config_st;

    /**
* Opaque config representation.
*/
    typedef struct vbucket_config_st* VBUCKET_CONFIG_HANDLE;

    /**
* Type of distribution used to map keys to servers. It is possible to
* select algorithm using "locator" key in config.
*/
    typedef enum {
        VBUCKET_DISTRIBUTION_VBUCKET = 0,
        VBUCKET_DISTRIBUTION_KETAMA = 1
    } VBUCKET_DISTRIBUTION_TYPE;

    /**
* \addtogroup cfgcmp
* @{
*/

    /**
* Difference between two vbucket configs.
*/
    typedef struct {
        /**
* NULL-terminated list of server names that were added.
*/
        char **servers_added;
        /**
* NULL-terminated list of server names that were removed.
*/
        char **servers_removed;
        /**
* Number of vbuckets that changed. -1 if the total number changed
*/
        int n_vb_changes;
        /**
* non-null if the sequence of servers changed.
*/
        int sequence_changed;
    } VBUCKET_CONFIG_DIFF;

    /**
* @}
*/

    /**
* \addtogroup CD
* @{
*/

    /**
* Create a new vbucket config handle
* @return handle or NULL if there is no more memory
*/
    LIBVBUCKET_PUBLIC_API
    VBUCKET_CONFIG_HANDLE vbucket_config_create(void);

    typedef enum {
        LIBVBUCKET_SOURCE_FILE,
        LIBVBUCKET_SOURCE_MEMORY
    } vbucket_source_t;

    /**
* Parse a vbucket configuration
* @param handle the vbucket config handle to store the result
* @param data_source what kind of datasource to parse
* @param data A zero terminated string representing the data to parse.
* For LIBVBUCKET_SOURCE_FILE this is the file to parse,
* for LIBVBUCKET_SOURCE_MEMORY it is the actual JSON body.
* @return 0 for success, the appropriate error code otherwise
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_config_parse(VBUCKET_CONFIG_HANDLE handle,
                             vbucket_source_t data_source,
                             const char *data);

    /**
* Parse a vbucket configuration and substitute local address if needed
* @param handle the vbucket config handle to store the result
* @param data_source what kind of datasource to parse
* @param data A zero terminated string representing the data to parse.
* For LIBVBUCKET_SOURCE_FILE this is the file to parse,
* for LIBVBUCKET_SOURCE_MEMORY it is the actual JSON body.
* @param peername a string, representing address of local peer
* (usually 127.0.0.1)
* @return 0 for success, the appropriate error code otherwise
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_config_parse2(VBUCKET_CONFIG_HANDLE handle,
                              vbucket_source_t data_source,
                              const char *data,
                              const char *peername);

    LIBVBUCKET_PUBLIC_API
    const char *vbucket_get_error_message(VBUCKET_CONFIG_HANDLE handle);


    /**
* Create an instance of vbucket config from a file.
*
* @param filename the vbucket config to parse
*/
    LIBVBUCKET_PUBLIC_API
    VBUCKET_CONFIG_HANDLE vbucket_config_parse_file(const char *filename);

    /**
* Create an instance of vbucket config from a string.
*
* @param data a vbucket config string.
*/
    LIBVBUCKET_PUBLIC_API
    VBUCKET_CONFIG_HANDLE vbucket_config_parse_string(const char *data);

    /**
* Destroy a vbucket config.
*
* @param h the vbucket config handle
*/
    LIBVBUCKET_PUBLIC_API
    void vbucket_config_destroy(VBUCKET_CONFIG_HANDLE h);

    /**
* @}
*/

    /**
* \addtogroup err
* @{
*/

    /**
* Get the most recent vbucket error.
*
* This is currently not threadsafe.
*/
    LIBVBUCKET_PUBLIC_API
    const char *vbucket_get_error(void);

    /**
* Tell libvbucket it told you the wrong server ID.
*
* This will cause libvbucket to do whatever is necessary to try
* to figure out a better answer.
*
* @param h the vbucket config handle.
* @param vbucket the vbucket ID
* @param wrongserver the incorrect server ID
*
* @return the correct server ID
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_found_incorrect_master(VBUCKET_CONFIG_HANDLE h,
                                       int vbucket,
                                       int wrongserver);

    /**
* @}
*/

    /**
* \addtogroup cfg
* @{
*/

    /**
* Get the number of replicas configured for each vbucket.
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_config_get_num_replicas(VBUCKET_CONFIG_HANDLE h);

    /**
* Get the total number of vbuckets;
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_config_get_num_vbuckets(VBUCKET_CONFIG_HANDLE h);

    /**
* Get the total number of known servers.
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_config_get_num_servers(VBUCKET_CONFIG_HANDLE h);

    /**
* Get the optional SASL user.
*
* @return a string or NULL.
*/
    LIBVBUCKET_PUBLIC_API
    const char *vbucket_config_get_user(VBUCKET_CONFIG_HANDLE h);

    /**
* Get the optional SASL password.
*
* @return a string or NULL.
*/
    LIBVBUCKET_PUBLIC_API
    const char *vbucket_config_get_password(VBUCKET_CONFIG_HANDLE h);

    /**
* Get the server at the given index.
*
* @return a string in the form of hostname:port
*/
    LIBVBUCKET_PUBLIC_API
    const char *vbucket_config_get_server(VBUCKET_CONFIG_HANDLE h, int i);

    /**
* Get the CouchDB API endpoint at the given index.
*
* @return a string or NULL.
*/
    LIBVBUCKET_PUBLIC_API
    const char *vbucket_config_get_couch_api_base(VBUCKET_CONFIG_HANDLE vb, int i);

    /**
* Get the REST API endpoint at the given index.
*
* @return a string or NULL.
*/
    LIBVBUCKET_PUBLIC_API
    const char *vbucket_config_get_rest_api_server(VBUCKET_CONFIG_HANDLE vb, int i);

    /**
* Check if the server was used for configuration
*
* @return non-zero for configuration node
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_config_is_config_node(VBUCKET_CONFIG_HANDLE h, int i);

    /**
* Get the distribution type. Currently can be or "vbucket" (for
* eventually persisted nodes) either "ketama" (for plain memcached
* nodes).
*
* @return a member of VBUCKET_DISTRIBUTION_TYPE enum.
*/
    LIBVBUCKET_PUBLIC_API
    VBUCKET_DISTRIBUTION_TYPE vbucket_config_get_distribution_type(VBUCKET_CONFIG_HANDLE vb);
    /**
* @}
*/

    /**
* \addtogroup vb
* @{
*/


    /**
* Map given key to server index. It is aware about current distribution
* type.
*
* @param h the vbucket config
* @param key pointer to the beginning of the key
* @param nkey the size of the key
* @param vbucket_id the vbucket identifier when vbucket distribution is
* used or zero otherwise.
* @param server_idx the server index
*
* @return zero on success
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_map(VBUCKET_CONFIG_HANDLE h, const void *key, size_t nkey,
                    int *vbucket_id, int *server_idx);

    /**
* Get the vbucket number for the given key.
*
* @param h the vbucket config
* @param key pointer to the beginning of the key
* @param nkey the size of the key
*
* @return a key
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_get_vbucket_by_key(VBUCKET_CONFIG_HANDLE h,
                                   const void *key, size_t nkey);

    /**
* Get the master server for the given vbucket.
*
* @param h the vbucket config
* @param id the vbucket identifier
*
* @return the server index
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_get_master(VBUCKET_CONFIG_HANDLE h, int id);

    /**
* Get a given replica for a vbucket.
*
* @param h the vbucket config
* @param id the vbucket id
* @param n the replica number
*
* @return the server ID
*/
    LIBVBUCKET_PUBLIC_API
    int vbucket_get_replica(VBUCKET_CONFIG_HANDLE h, int id, int n);

    /**
* @}
*/

    /**
* \addtogroup cfgcmp
* @{
*/

    /**
* Compare two vbucket handles.
*
* @param from the source vbucket config
* @param to the destination vbucket config
*
* @return what changed between the "from" config and the "to" config
*/
    LIBVBUCKET_PUBLIC_API
    VBUCKET_CONFIG_DIFF* vbucket_compare(VBUCKET_CONFIG_HANDLE from,
                                         VBUCKET_CONFIG_HANDLE to);

    /**
* Free a vbucket diff.
*
* @param diff the diff to free
*/
    LIBVBUCKET_PUBLIC_API
    void vbucket_free_diff(VBUCKET_CONFIG_DIFF *diff);

    /**
* @}
*/

#ifdef __cplusplus
}
#endif

#endif
Something went wrong with that request. Please try again.