Interface WebsocketConfig
-
public interface WebsocketConfigProvides configuration settings of the web socket endpoint.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classWebsocketConfig.WebsocketConfigValueAn enumeration of the known config path expressions and their associated default values forWebSocketConfig.
-
Field Summary
Fields Modifier and Type Field Description static StringCONFIG_PATHConfig path relative to its parent.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description intgetPublisherBackpressureBufferSize()Returns the max buffer size of how many outstanding command responses and events a single web socket client can have.intgetSubscriberBackpressureQueueSize()Returns the max queue size of how many inflight commands a single web socket client can have.ThrottlingConfiggetThrottlingConfig()Returns the throttling config for websocket.doublegetThrottlingRejectionFactor()Returns the factor of maximum throughput at which rejections were sent.default com.typesafe.config.Configrender()Render this object into a Config object from which a copy of this object can be constructed.
-
-
-
Field Detail
-
CONFIG_PATH
static final String CONFIG_PATH
Config path relative to its parent.- See Also:
- Constant Field Values
-
-
Method Detail
-
getSubscriberBackpressureQueueSize
int getSubscriberBackpressureQueueSize()
Returns the max queue size of how many inflight commands a single web socket client can have.- Returns:
- the queue size.
-
getPublisherBackpressureBufferSize
int getPublisherBackpressureBufferSize()
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.- Returns:
- the buffer size.
-
getThrottlingRejectionFactor
double getThrottlingRejectionFactor()
Returns the factor of maximum throughput at which rejections were sent. This threshold should never be reached unless Akka HTTP or the underlying TCP implementation is broken.- Returns:
- the factor of maximum throughput at which rejections are sent.
-
getThrottlingConfig
ThrottlingConfig getThrottlingConfig()
Returns the throttling config for websocket.- Returns:
- the throttling config.
-
render
default com.typesafe.config.Config render()
Render this object into a Config object from which a copy of this object can be constructed.- Returns:
- a config representation.
-
-