Package com.linecorp.armeria.server.websocket

Class WebSocketServiceBuilder

java.lang.Object

com.linecorp.armeria.server.websocket.WebSocketServiceBuilder

@UnstableApi
public final class WebSocketServiceBuilder
extends Object

Builds a WebSocketService.

Method Summary

Modifier and Type	Method	Description
WebSocketServiceBuilder	allowedOrigins(Iterable<String> allowedOrigins)	Sets the allowed origins.
WebSocketServiceBuilder	allowedOrigins(String... allowedOrigins)	Sets the allowed origins.
WebSocketServiceBuilder	allowMaskMismatch(boolean allowMaskMismatch)	Sets whether the decoder allows to loosen the masking requirement on received frames.
WebSocketService	build()	Returns a newly-created WebSocketService with the properties set so far.
WebSocketServiceBuilder	maxFramePayloadLength(int maxFramePayloadLength)	Sets the maximum length of a frame's payload.
WebSocketServiceBuilder	subprotocols(Iterable<String> subprotocols)	Sets the subprotocols to use with the WebSocket Protocol.
WebSocketServiceBuilder	subprotocols(String... subprotocols)	Sets the subprotocols to use with the WebSocket Protocol.

Methods inherited from class java.lang.Object

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

Method Details

maxFramePayloadLength

public WebSocketServiceBuilder maxFramePayloadLength(int maxFramePayloadLength)

Sets the maximum length of a frame's payload. If the size of a payload data exceeds the value, WebSocketCloseStatus.MESSAGE_TOO_BIG is sent to the peer. 65535 is used by default.

allowMaskMismatch

public WebSocketServiceBuilder allowMaskMismatch(boolean allowMaskMismatch)

Sets whether the decoder allows to loosen the masking requirement on received frames. It's not allowed by default.

subprotocols

public WebSocketServiceBuilder subprotocols(String... subprotocols)

Sets the subprotocols to use with the WebSocket Protocol.

See Also:

• Subprotocols Using the WebSocket Protocol

subprotocols

public WebSocketServiceBuilder subprotocols(Iterable<String> subprotocols)

Sets the subprotocols to use with the WebSocket Protocol.

See Also:

• Subprotocols Using the WebSocket Protocol

allowedOrigins

public WebSocketServiceBuilder allowedOrigins(String... allowedOrigins)

Sets the allowed origins. The same-origin is allowed by default. Specify "*" to allow any origins.

See Also:

• Origin Considerations

allowedOrigins

public WebSocketServiceBuilder allowedOrigins(Iterable<String> allowedOrigins)

Sets the allowed origins. The same-origin is allowed by default. Specify "*" to allow any origins.

See Also:

• Origin Considerations

build

public WebSocketService build()

Returns a newly-created WebSocketService with the properties set so far.