Package reactor.netty.http.websocket
Interface WebsocketSpec
- All Known Subinterfaces:
WebsocketClientSpec
,WebsocketServerSpec
- All Known Implementing Classes:
WebsocketSpecImpl
public interface WebsocketSpec
Wrapper for websocket configuration.
- Since:
- 0.9.5
- Author:
- Dmitrii Borin, Violeta Georgieva
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
WebsocketSpec.Builder<SPEC extends WebsocketSpec.Builder<SPEC>>
-
Method Summary
Modifier and TypeMethodDescriptionboolean
compress()
Returns whether the websocket compression extension is enabled.boolean
Returns whether to proxy websocket PING frames or respond to them.int
Returns the configured maximum allowable frame payload length.@Nullable String
Returns the configured sub protocols.
-
Method Details
-
protocols
@Nullable String protocols()Returns the configured sub protocols.- Returns:
- returns the configured sub protocols.
-
maxFramePayloadLength
int maxFramePayloadLength()Returns the configured maximum allowable frame payload length.Note: When a websocket compression extension is enabled, this setting is applied on the compressed data.
- Returns:
- returns the configured maximum allowable frame payload length.
-
handlePing
boolean handlePing()Returns whether to proxy websocket PING frames or respond to them.- Returns:
- returns whether to proxy websocket PING frames or respond to them.
-
compress
boolean compress()Returns whether the websocket compression extension is enabled.- Returns:
- returns whether the websocket compression extension is enabled.
-