forked from couchbase/kv_engine
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mcbp_validators.h
76 lines (64 loc) · 2.42 KB
/
mcbp_validators.h
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
/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
* Copyright 2018-Present Couchbase, Inc.
*
* Use of this software is governed by the Business Source License included
* in the file licenses/BSL-Couchbase.txt. As of the Change Date specified
* in that file, in accordance with the Business Source License, use of this
* software will be governed by the Apache License, Version 2.0, included in
* the file licenses/APL2.txt.
*/
/*
* memcached binary protocol packet validators
*/
#pragma once
#include <mcbp/protocol/datatype.h>
#include <mcbp/protocol/opcode.h>
#include <mcbp/protocol/status.h>
#include <array>
#include <functional>
class Cookie;
/**
* The MCBP validator.
*
* Class stores a validator per opcode and invokes the validator if one is
* configured for that opcode.
*/
class McbpValidator {
public:
using ClientOpcode = cb::mcbp::ClientOpcode;
using Status = cb::mcbp::Status;
enum class ExpectedKeyLen { Zero, NonZero, Any };
enum class ExpectedValueLen { Zero, NonZero, Any };
enum class ExpectedCas { Set, NotSet, Any };
/// Yes commands that generate/use a DocKey (collection+key)
enum class GeneratesDocKey { Yes, No };
constexpr static uint8_t AllSupportedDatatypes =
cb::mcbp::datatype::highest;
McbpValidator();
/**
* Invoke the validator for the command if one is configured. Otherwise
* Success is returned
*/
Status validate(ClientOpcode command, Cookie& cookie);
static Status verify_header(Cookie& cookie,
uint8_t expected_extlen,
ExpectedKeyLen expected_keylen,
ExpectedValueLen expected_valuelen,
ExpectedCas expected_cas,
GeneratesDocKey generates_dockey,
uint8_t expected_datatype_mask);
protected:
/**
* Validate the key for operations which will create a DocKey
* @param cookie non const reference as failure will update the error
* context
* @return true if the key data represents a valid key for the connection
*/
static bool is_document_key_valid(Cookie& cookie);
/**
* Installs a validator for the given command
*/
void setup(ClientOpcode command, Status (*f)(Cookie&));
std::array<std::function<Status(Cookie&)>, 0x100> validators;
};