WebSocketClientProtocolConfig (Netty API Reference (4.1.115.Final))

java.lang.Object
- io.netty.handler.codec.http.websocketx.WebSocketClientProtocolConfig

public final class WebSocketClientProtocolConfig
extends Object

WebSocket server configuration.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WebSocketClientProtocolConfig.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebSocketClientProtocolConfig.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`absoluteUpgradeUrl()`
`boolean`	`allowExtensions()`
`boolean`	`allowMaskMismatch()`
`HttpHeaders`	`customHeaders()`
`boolean`	`dropPongFrames()`
`long`	`forceCloseTimeoutMillis()`
`boolean`	`generateOriginHeader()`
`boolean`	`handleCloseFrames()`
`long`	`handshakeTimeoutMillis()`
`int`	`maxFramePayloadLength()`
`static WebSocketClientProtocolConfig.Builder`	`newBuilder()`
`boolean`	`performMasking()`
`WebSocketCloseStatus`	`sendCloseFrame()`
`String`	`subprotocol()`
`WebSocketClientProtocolConfig.Builder`	`toBuilder()`
`String`	`toString()`
`WebSocketVersion`	`version()`
`URI`	`webSocketUri()`
`boolean`	`withUTF8Validator()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

webSocketUri
```
public URI webSocketUri()
```

subprotocol
```
public String subprotocol()
```

version
```
public WebSocketVersion version()
```

allowExtensions
```
public boolean allowExtensions()
```

customHeaders
```
public HttpHeaders customHeaders()
```

maxFramePayloadLength
```
public int maxFramePayloadLength()
```

performMasking
```
public boolean performMasking()
```

allowMaskMismatch
```
public boolean allowMaskMismatch()
```

handleCloseFrames
```
public boolean handleCloseFrames()
```

sendCloseFrame

public WebSocketCloseStatus sendCloseFrame()

dropPongFrames
```
public boolean dropPongFrames()
```

handshakeTimeoutMillis
```
public long handshakeTimeoutMillis()
```

forceCloseTimeoutMillis
```
public long forceCloseTimeoutMillis()
```

absoluteUpgradeUrl
```
public boolean absoluteUpgradeUrl()
```

generateOriginHeader
```
public boolean generateOriginHeader()
```

withUTF8Validator
```
public boolean withUTF8Validator()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

toBuilder

public WebSocketClientProtocolConfig.Builder toBuilder()

newBuilder

public static WebSocketClientProtocolConfig.Builder newBuilder()

Class WebSocketClientProtocolConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

webSocketUri

subprotocol

version

allowExtensions

customHeaders

maxFramePayloadLength

performMasking

allowMaskMismatch

handleCloseFrames

sendCloseFrame

dropPongFrames

handshakeTimeoutMillis

forceCloseTimeoutMillis

absoluteUpgradeUrl

generateOriginHeader

withUTF8Validator

toString

toBuilder

newBuilder