1

#ifndef MEMCACHE_REQ_H

     2

#define MEMCACHE_REQ_H

     3

     4

#include <sys/queue.h>

     5

     6

#include "../memcache.h"

     7

#include "connection.h"

     8

     9

struct memcache_req {

    10

    // the memcache context that we belong to

    11

    struct memcache *mc;

    12

    13

    // the command to execute

    14

    enum memcache_command cmd_type;

    15

    16

    // the reply we have received, or MEMCACHE_REPLY_INVALID

    17

    enum memcache_reply reply_type;

    18

    19

    // our key/obj

    20

    struct memcache_key key;

    21

    struct memcache_obj obj;

    22

    struct memcache_buf buf;

    23

    27

    // our state

    28

    enum memcache_req_state state;

    29

    30

    // our user callback argument

    31

    void *cb_arg;

    32

    33

    // the conn 

    34

    struct memcache_connection *conn;

    35

    36

    // we are a member of struct memcache_server.req_queue

    37

    TAILQ_ENTRY(memcache_req) reqqueue_node;

    38

};

    39

    40

/*

    41

 * Allocate and return a new req, or NULL if unsuccesfull.

    42

 */

    44

    45

/*

    46

 * The request has been queued.

    47

 */

    48

void memcache_req_queued (struct memcache_req *req);

    49

    50

/*

    51

 * The request is being sent.

    52

 */

    53

void memcache_req_send (struct memcache_req *req);

    54

    55

/*

    56

 * The reply has been received, although if the respones also contains data, that will be notified separately.

    57

 *

    58

 * If the response doesn't contain any data, req_done will be called after this is. Otherwise, this will be called

    59

 * first, followed by zero or more calls to req_data, followed by req_reply/RPL_END + req_done.

    60

 *

    61

 * Note that no req data will not be available when this is first called, only once req_data/req_done is called.

    62

 */

    64

    65

/*

    66

 * Some amount of reply data has been received. This may be called between the req_reply/MEMCACHE_RPL_VALUE and

    67

 * req_reply/MEMCACHE_RPL_END + req_done notifications.

    68

 *

    69

 * Note that this is not always called, it is possible that one might have:

    70

 *      memcache_req_reply(req, MEMCACHE_RPL_VALUE)

    71

 *      memcache_req_reply(req, MEMCACHE_RPL_END)

    72

 *      memcache_req_done(req)

    73

 *

    74

 * This will happen if both the value and the end replies are received in the same chunk.

    75

 *

    76

 * Note also that replies may have zero-length entries, in which case req_data will never be called either.

    77

 */

    78

void memcache_req_data (struct memcache_req *req);

    79

    80

/*

    81

 * The request was sent and is now done, and is not associated with the connection anymore.

    82

 *

    83

 * This will be called before req_reply/req_data, but not before/after req_error.

    84

 */

    85

void memcache_req_done (struct memcache_req *req);

    86

    87

/*

    88

 * An error occurred, and the request must be abandoned. This will assume that the req is not active or enqueued

    89

 * anymore, and the req should not be accessed by memcache_* code after this.

    90

 */

    91

void memcache_req_error (struct memcache_req *req);

    92

    93

/*

    94

 * Free an unused req. Should always be called by the user, not via internal means.

    95

 */

    96

void memcache_req_free (struct memcache_req *req);

    97

    98

#endif /* MEMCACHE_REQ_H */