1

#ifndef MEMCACHE_H

     2

#define MEMCACHE_H

     3

     4

/*

     5

 * A libevent based memcached client that aims for high performance, concurrency and low latency.

     6

 */

     7

     8

#include "config.h"

     9

    10

/*

    11

 * Used to store the global information for a memcache context. A context contains both servers and active connections.

    12

 */

    13

struct memcache;

    14

    15

/*

    16

 * A transaction.

    17

 */

    18

struct memcache_req;

    19

    20

/*

    21

 * Keys used

    22

 */

    23

struct memcache_key {

    24

    char *buf;

    25

    size_t len;

    26

};

    27

    28

/*

    29

 * Object attributes

    30

 */

    31

struct memcache_obj {

    32

    unsigned int flags;

    33

    time_t exptime;

    34

    size_t bytes;

    35

    unsigned long long cas;

    36

};

    37

    38

/*

    39

 * Available commands

    40

 */

    41

enum memcache_command {

    42

    FETCH_GET,

    43

    STORE_SET,

    44

    STORE_ADD,

    45

    STORE_REPLACE,

    46

    STORE_APPEND,

    47

    STORE_PREPEND,

    48

    STORE_CAS,

    49

};

    50

    51

enum memcache_req_state {

    52

    STATE_INVALID,

    53

    54

    STATE_ERROR,

    55

};

    56

    57

/*

    58

 * Callback used

    59

 */

    60

typedef int (*memcache_cb) (struct memcache_req *, void*);

    61

    62

/*

    63

 * Allocate a new memcache context for use with other methods.

    64

 */

    65

struct memcache *memcache_alloc (memcache_cb cb_fn);

    66

    67

/*

    68

 * Add a server to the pool of available servers.

    69

 */

    70

int memcache_add_server (struct memcache *mc, struct config_endpoint *endpoint, int max_connections);

    71

    72

/*

    73

 * Attempt to fetch a key from the cache.

    74

 */

    75

struct memcache_req *memcache_fetch (struct memcache *mc, const struct memcache_key *key, void *cb_arg);

    76

    77

/*

    78

 * Attempt to store a key into the cache

    79

 */

    80

struct memcache_req *memcache_store (struct memcache *mc, enum memcache_command cmd, const struct memcache_key *key, const struct memcache_obj *obj, void *cb_arg);

    81

    82

/*

    83

 * Request state

    84

 */ 

    85

enum memcache_req_state memcache_req_state (struct memcache_req *req);

    86

    87

/*

    88

 * Request key

    89

 */

    90

int memcache_req_key (struct memcache_req *req, const struct memcache_key *key);

    91

    92

/*

    93

 * Request data

    94

 */

    95

int memcache_req_obj (struct memcache_req *req, const struct memcache_obj *obj);

    96

    97

#endif /* MEMCACHE_H */