-
Notifications
You must be signed in to change notification settings - Fork 12
/
flow-controller.ts
74 lines (65 loc) · 2.38 KB
/
flow-controller.ts
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
import { xdr } from '@stellar/stellar-base';
import { isFloodMessage } from './is-flood-message';
import MessageType = xdr.MessageType;
import StellarMessage = xdr.StellarMessage;
export class FlowController {
private messagesReceivedInCurrentBatch = 0;
private bytesReceivedInCurrentBatch = 0;
/**
* Uses param names from stellar-core config. Non bytes parameters are counted in number of messages.
* The Reading capacity is the number of messages that can be processed simultaneously.
* Everytime a batch of messages is processed, we request the capacity back through sendmore messages.
* The bytes capacity should be higher than the batch size + the maximum message size, to avoid getting stuck.
* @param peerFloodReadingCapacity
* @param flowControlSendMoreBatchSize
* @param peerFloodReadingCapacityBytes
* @param flowControlSendMoreBatchSizeBytes
*/
constructor(
//we use stellar-core defaults atm
private peerFloodReadingCapacity = 200,
private flowControlSendMoreBatchSize = 40,
private peerFloodReadingCapacityBytes = 300000,
private flowControlSendMoreBatchSizeBytes = 100000
) {}
/*
* Start by sending a send-more message with the _total_ capacity available.
*/
start(): null | StellarMessage {
return xdr.StellarMessage.sendMoreExtended(
new xdr.SendMoreExtended({
numMessages: this.peerFloodReadingCapacity,
numBytes: this.peerFloodReadingCapacityBytes
})
);
}
sendMore(
messageType: MessageType,
stellarMessageSize: number
): null | xdr.StellarMessage {
if (isFloodMessage(messageType)) {
this.messagesReceivedInCurrentBatch++;
this.bytesReceivedInCurrentBatch += stellarMessageSize;
}
let shouldSendMore =
this.messagesReceivedInCurrentBatch === this.flowControlSendMoreBatchSize;
shouldSendMore =
shouldSendMore ||
this.bytesReceivedInCurrentBatch >=
this.flowControlSendMoreBatchSizeBytes;
//reclaim the capacity
let sendMoreMessage: xdr.StellarMessage;
if (shouldSendMore) {
sendMoreMessage = xdr.StellarMessage.sendMoreExtended(
new xdr.SendMoreExtended({
numMessages: this.messagesReceivedInCurrentBatch, //!request back the number of messages we received, not the total capacity like when starting!
numBytes: this.bytesReceivedInCurrentBatch
})
);
this.messagesReceivedInCurrentBatch = 0;
this.bytesReceivedInCurrentBatch = 0;
return sendMoreMessage;
}
return null;
}
}