- All Superinterfaces:
NamedService
,ProtocolConfig
,Prototype.Api
- All Known Implementing Classes:
WsConfig.BuilderBase.WsConfigImpl
WebSocket protocol configuration.
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
Fluent API builder forWsConfig
.static class
WsConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends WsConfig> Fluent API builder base forWsConfig
. -
Method Summary
Modifier and TypeMethodDescriptionstatic WsConfig.Builder
builder()
Create a new fluent API builder to customize configuration.static WsConfig.Builder
Create a new fluent API builder from an existing instance.static WsConfig
create()
Create a new instance with default values.static WsConfig
Create a new instance from configuration.int
Max WebSocket frame size supported by the server on a read operation.name()
Name of this configuration.origins()
WebSocket origins.default String
type()
Protocol configuration type.
-
Method Details
-
builder
Create a new fluent API builder to customize configuration.- Returns:
- a new builder
-
builder
Create a new fluent API builder from an existing instance.- Parameters:
instance
- an existing instance used as a base for the builder- Returns:
- a builder based on an instance
-
create
Create a new instance from configuration.- Parameters:
config
- used to configure the new instance- Returns:
- a new instance configured from configuration
-
create
Create a new instance with default values.- Returns:
- a new instance
-
origins
WebSocket origins.- Returns:
- origins
-
type
Protocol configuration type.- Specified by:
type
in interfaceNamedService
- Returns:
- type of this configuration
-
name
String name()Name of this configuration.- Specified by:
name
in interfaceNamedService
- Returns:
- configuration name
-
maxFrameLength
int maxFrameLength()Max WebSocket frame size supported by the server on a read operation. Default is 1 MB.- Returns:
- max frame size to read
-