Package io.micronaut.http.client

Class HttpClientConfiguration.WebSocketCompressionConfiguration

java.lang.Object

io.micronaut.http.client.HttpClientConfiguration.WebSocketCompressionConfiguration

All Implemented Interfaces:

Toggleable

Direct Known Subclasses:

DefaultHttpClientConfiguration.DefaultWebSocketCompressionConfiguration, ServiceHttpClientConfiguration.ServiceWebSocketCompressionConfiguration

Enclosing class:

HttpClientConfiguration

public static class HttpClientConfiguration.WebSocketCompressionConfiguration
extends Object
implements Toggleable

Configuration for WebSocket client compression extensions.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ENABLED	The default enable value.
static final String	PREFIX	The prefix to use for configuration.

Constructor Summary

Constructors

Constructor	Description
WebSocketCompressionConfiguration()

Method Summary

Modifier and Type	Method	Description
boolean	isEnabled()	Whether deflate compression is enabled for client WebSocket connections.
void	setEnabled(boolean enabled)	Sets whether the per message deflate extension is enabled for WebSocket connections.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PREFIX

public static final String PREFIX

The prefix to use for configuration.

See Also:

• Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

• Constant Field Values

Constructor Details

WebSocketCompressionConfiguration

public WebSocketCompressionConfiguration()

Method Details

isEnabled

public boolean isEnabled()

Whether deflate compression is enabled for client WebSocket connections.

Specified by:

isEnabled in interface Toggleable

Returns:

True if the per message deflate extension is enabled.

setEnabled

public void setEnabled(boolean enabled)

Sets whether the per message deflate extension is enabled for WebSocket connections. Default value (DEFAULT_ENABLED).

Parameters:

enabled - True is it is enabled.