Package io.deephaven.server.jetty

Enum JettyConfig.WebsocketsSupport

java.lang.Object

java.lang.Enum<JettyConfig.WebsocketsSupport>

io.deephaven.server.jetty.JettyConfig.WebsocketsSupport

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JettyConfig.WebsocketsSupport>

Enclosing class:

JettyConfig

public static enum JettyConfig.WebsocketsSupport
extends java.lang.Enum<JettyConfig.WebsocketsSupport>

Values to indicate what kind of websocket support should be offered.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	Enables both GRPC_WEBSOCKET and GRPC_WEBSOCKET_MULTIPLEXED, letting the client specify which to use via websocket subprotocols.
GRPC_WEBSOCKET	Establish one websocket per grpc stream (including unary calls).
GRPC_WEBSOCKET_MULTIPLEXED	Allows reuse of a single websocket for many grpc streams, even between services.
NONE	Disable all websockets.

Method Summary

Modifier and Type	Method	Description
static JettyConfig.WebsocketsSupport	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static JettyConfig.WebsocketsSupport[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final JettyConfig.WebsocketsSupport NONE

Disable all websockets. Recommended for use with https, including behind a proxy that will offer its own https.

GRPC_WEBSOCKET

public static final JettyConfig.WebsocketsSupport GRPC_WEBSOCKET

Establish one websocket per grpc stream (including unary calls). Compatible with the websocket client provided by improbable-eng/grpc-web, but not recommended.

GRPC_WEBSOCKET_MULTIPLEXED

public static final JettyConfig.WebsocketsSupport GRPC_WEBSOCKET_MULTIPLEXED

Allows reuse of a single websocket for many grpc streams, even between services. This reduces latency by avoiding a fresh websocket handshake per rpc.

BOTH

public static final JettyConfig.WebsocketsSupport BOTH

Enables both GRPC_WEBSOCKET and GRPC_WEBSOCKET_MULTIPLEXED, letting the client specify which to use via websocket subprotocols.

Method Detail

values

public static JettyConfig.WebsocketsSupport[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JettyConfig.WebsocketsSupport c : JettyConfig.WebsocketsSupport.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JettyConfig.WebsocketsSupport valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null