blob: 9f3673862fcd6d926c2da8ed5a44f764f7bf242d (
plain) (
blame)
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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include "ithrottlepolicy.h"
namespace mbus {
/**
* This is an implementatin of the {@link ThrottlePolicy} that offers static limits to the amount of pending
* data a {@link SourceSession} is allowed to have. You may choose to set a limit to the total number of
* pending messages (by way of {@link #setMaxPendingCount(int)}), the total size of pending messages (by way
* of {@link #setMaxPendingSize(long)}), or some combination thereof.
*
* <b>NOTE:</b> By context, "pending" is refering to the number of sent messages that have not been replied to
* yet.
*/
class StaticThrottlePolicy: public IThrottlePolicy {
private:
uint32_t _maxPendingCount;
uint64_t _maxPendingSize;
uint64_t _pendingSize;
public:
/**
* Convenience typedefs.
*/
using UP = std::unique_ptr<StaticThrottlePolicy>;
using SP = std::shared_ptr<StaticThrottlePolicy>;
/**
* Constructs a new instance of this policy and sets the appropriate default values of member data.
*/
StaticThrottlePolicy();
/**
* Returns the maximum number of pending messages allowed.
*
* @return The max limit.
*/
uint32_t getMaxPendingCount() const;
/**
* Sets the maximum number of pending messages allowed.
*
* @param maxCount The max count.
* @return This, to allow chaining.
*/
StaticThrottlePolicy &setMaxPendingCount(uint32_t maxCount);
/**
* Returns the maximum total size of pending messages allowed.
*
* @return The max limit.
*/
uint64_t getMaxPendingSize() const;
/**
* Sets the maximum total size of pending messages allowed. This size is relative to the value returned by
* {@link com.yahoo.messagebus.Message#getApproxSize()}.
*
* @param maxSize The max size.
* @return This, to allow chaining.
*/
StaticThrottlePolicy &setMaxPendingSize(uint64_t maxSize);
/**
* Returns the total size of pending messages.
*
* @return The size.
*/
uint64_t getPendingSize() const;
bool canSend(const Message &msg, uint32_t pendingCount) override;
void processMessage(Message &msg) override;
void processReply(Reply &reply) override;
};
} // namespace mbus
|
