-
Notifications
You must be signed in to change notification settings - Fork 214
/
WebsocketConfig.java
122 lines (103 loc) · 3.93 KB
/
WebsocketConfig.java
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
* Copyright (c) 2019 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.gateway.service.util.config.streaming;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.ditto.base.service.config.ThrottlingConfig;
import org.eclipse.ditto.internal.utils.config.KnownConfigValue;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
/**
* Provides configuration settings of the web socket endpoint.
*/
public interface WebsocketConfig {
/**
* Config path relative to its parent.
*/
String CONFIG_PATH = "websocket";
/**
* Returns the max queue size of how many inflight commands a single web socket client can have.
*
* @return the queue size.
*/
int getSubscriberBackpressureQueueSize();
/**
* Returns the max buffer size of how many outstanding command responses and events a single web socket client
* can have.
* Additional command responses and events are dropped if this size is reached.
*
* @return the buffer size.
*/
int getPublisherBackpressureBufferSize();
/**
* Returns the factor of maximum throughput at which rejections were sent.
* This threshold should never be reached unless Pekko HTTP or the underlying TCP implementation is broken.
*
* @return the factor of maximum throughput at which rejections are sent.
*/
double getThrottlingRejectionFactor();
/**
* Returns the throttling config for websocket.
*
* @return the throttling config.
*/
ThrottlingConfig getThrottlingConfig();
/**
* Render this object into a Config object from which a copy of this object can be constructed.
*
* @return a config representation.
*/
default Config render() {
final Map<String, Object> map = new HashMap<>();
map.put(WebsocketConfigValue.SUBSCRIBER_BACKPRESSURE_QUEUE_SIZE.getConfigPath(),
getSubscriberBackpressureQueueSize());
map.put(WebsocketConfigValue.PUBLISHER_BACKPRESSURE_BUFFER_SIZE.getConfigPath(),
getPublisherBackpressureBufferSize());
map.put(WebsocketConfigValue.THROTTLING_REJECTION_FACTOR.getConfigPath(), getThrottlingRejectionFactor());
return ConfigFactory.parseMap(map)
.withFallback(getThrottlingConfig().render())
.atKey(CONFIG_PATH);
}
/**
* An enumeration of the known config path expressions and their associated default values for
* {@code WebSocketConfig}.
*/
enum WebsocketConfigValue implements KnownConfigValue {
/**
* The max queue size of how many inflight commands a single web socket client can have.
*/
SUBSCRIBER_BACKPRESSURE_QUEUE_SIZE("subscriber.backpressure-queue-size", 100),
/**
* The max buffer size of how many outstanding command responses and events a single web socket client can have.
*/
PUBLISHER_BACKPRESSURE_BUFFER_SIZE("publisher.backpressure-buffer-size", 200),
/**
* The factor of maximum throughput at which rejections were sent.
*/
THROTTLING_REJECTION_FACTOR("throttling-rejection-factor", 1.25);
private final String path;
private final Object defaultValue;
WebsocketConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
@Override
public String getConfigPath() {
return path;
}
}
}