WebSocketEndpoint (twelvet 1.0.2 API)

```
@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface WebSocketEndpoint
```
作者:

twelvet 当WebSocketEndpointExporter类通过Spring配置进行声明并被使用它将会去扫描带有@WebSocketEndpoint注解的类被注解的类将被注册成为一个WebSocket端点所有的配置项都在这个注解的属性中 ( 如:@WebSocketEndpoint("/ws") )

可选元素概要

可选元素
限定符和类型	可选元素和说明
`int`	`allIdleTimeSeconds` 与IdleStateHandler中的allIdleTimeSeconds一致，并且当它不为0时，将在pipeline中添加IdleStateHandler
`int`	`bossLoopGroupThreads` bossEventLoopGroup的线程数
`boolean`	`childOptionAllowHalfClosure` 一个连接的远端关闭时本地端是否关闭，默认值为False。
`boolean`	`childOptionSoKeepalive` 连接保活，默认值为False。
`int`	`childOptionSoLinger` 关闭Socket的延迟时间，默认值为-1，表示禁用该功能。
`int`	`childOptionSoRcvbuf` TCP数据接收缓冲区大小。
`int`	`childOptionSoSndbuf` TCP数据发送缓冲区大小。
`boolean`	`childOptionTcpNodelay` 立即发送数据，默认值为Ture（Netty默认为True而操作系统默认为False）。
`int`	`childOptionWriteBufferHighWaterMark` 写高水位标记，默认值64KB。
`int`	`childOptionWriteBufferLowWaterMark` 写低水位标记，默认值32KB。
`int`	`childOptionWriteSpinCount` 一个Loop写操作执行的最大次数，默认值为16 也就是说，对于大数据量的写操作至多进行16次，如果16次仍没有全部写完数据，此时会提交一个新的写任务给EventLoop，任务将在下次调度继续执行这样，其他的写请求才能被响应不会因为单个大数据量写请求而耽误
`String`	`corsAllowCredentials` 与spring boot的@CrossOrigin#allowCredentials一致
`String[]`	`corsOrigins` 与spring boot的@CrossOrigin#origins一致
`int`	`eventExecutorGroupThreads` eventExecutorGroup的线程数
`String`	`host` WebSocket的host,"0.0.0.0"即是所有本地地址
`int`	`maxFramePayloadLength` 最大允许帧载荷长度
`int`	`optionConnectTimeoutMillis` 连接超时毫秒数
`int`	`optionSoBacklog` 服务端接受连接的队列长度，如果队列已满，客户端连接将被拒绝
`String`	`path` WebSocket的path
`int`	`port` 访问端口
`int`	`readerIdleTimeSeconds` 与IdleStateHandler中的readerIdleTimeSeconds一致，并且当它不为0时，将在pipeline中添加IdleStateHandler
`String`	`sslKeyPassword` 与spring-boot的server.ssl.key-password一致
`String`	`sslKeyStore` 与spring-boot的server.ssl.key-store一致
`String`	`sslKeyStorePassword` 与spring-boot的server.ssl.key-store-password一致
`String`	`sslKeyStoreType` 与spring-boot的server.ssl.key-store-type一致
`String`	`sslTrustStore` 与spring-boot的server.ssl.trust-store一致
`String`	`sslTrustStorePassword` 与spring-boot的server.ssl.trust-store-password一致
`String`	`sslTrustStoreType` 与spring-boot的server.ssl.trust-store-type一致
`boolean`	`useCompressionHandler` 是否添加WebSocketServerCompressionHandler到pipeline
`boolean`	`useEventExecutorGroup` 是否使用另一个线程池来执行耗时的同步业务逻辑
`String`	`value` WebSocket的path
`int`	`workerLoopGroupThreads` workerEventLoopGroup的线程数
`int`	`writerIdleTimeSeconds` 与IdleStateHandler中的writerIdleTimeSeconds一致，并且当它不为0时，将在pipeline中添加IdleStateHandler

- 元素详细资料
  - value
```
@AliasFor(value="path")
public abstract String value
```
    WebSocket的path
    
    返回:
    
    String
    
    默认值:
    
    "/"
- - path
```
@AliasFor(value="value")
public abstract String path
```
    WebSocket的path
    
    返回:
    
    String
    
    默认值:
    
    "/"
- - host
```
public abstract String host
```
    WebSocket的host,"0.0.0.0"即是所有本地地址
    
    返回:
    
    String
    
    默认值:
    
    "0.0.0.0"
- - port
```
public abstract int port
```
    访问端口
    
    返回:
    
    int
    
    默认值:
    
    80
- - bossLoopGroupThreads
```
public abstract int bossLoopGroupThreads
```
    bossEventLoopGroup的线程数
    
    返回:
    
    int
    
    默认值:
    
    1
- - workerLoopGroupThreads
```
public abstract int workerLoopGroupThreads
```
    workerEventLoopGroup的线程数
    
    返回:
    
    int
    
    默认值:
    
    0
- - useCompressionHandler
```
public abstract boolean useCompressionHandler
```
    是否添加WebSocketServerCompressionHandler到pipeline
    
    返回:
    
    boolean
    
    默认值:
    
    false
- - optionConnectTimeoutMillis
```
public abstract int optionConnectTimeoutMillis
```
    连接超时毫秒数
    
    返回:
    
    int
    
    默认值:
    
    30000
- - optionSoBacklog
```
public abstract int optionSoBacklog
```
    服务端接受连接的队列长度，如果队列已满，客户端连接将被拒绝
    
    返回:
    
    int
    
    默认值:
    
    128
- - childOptionWriteSpinCount
```
public abstract int childOptionWriteSpinCount
```
    一个Loop写操作执行的最大次数，默认值为16 也就是说，对于大数据量的写操作至多进行16次，如果16次仍没有全部写完数据，此时会提交一个新的写任务给EventLoop，任务将在下次调度继续执行这样，其他的写请求才能被响应不会因为单个大数据量写请求而耽误
    
    返回:
    
    int
    
    默认值:
    
    16
- - childOptionWriteBufferHighWaterMark
```
public abstract int childOptionWriteBufferHighWaterMark
```
    写高水位标记，默认值64KB。如果Netty的写缓冲区中的字节超过该值，Channel的isWritable()返回False
    
    返回:
    
    int
    
    默认值:
    
    65536
- - childOptionWriteBufferLowWaterMark
```
public abstract int childOptionWriteBufferLowWaterMark
```
    写低水位标记，默认值32KB。当Netty的写缓冲区中的字节超过高水位之后若下降到低水位，则Channel的isWritable()返回True。写高低水位标记使用户可以控制写入数据速度，从而实现流量控制。推荐做法是：每次调用channel.write(msg)方法首先调用channel.isWritable()判断是否可写。
    
    返回:
    
    int
    
    默认值:
    
    32768
- - childOptionSoRcvbuf
```
public abstract int childOptionSoRcvbuf
```
    TCP数据接收缓冲区大小。该缓冲区即TCP接收滑动窗口，linux操作系统可使用命令：cat /proc/sys/net/ipv4/tcp_rmem查询其大小。一般情况下，该值可由用户在任意时刻设置，但当设置值超过64KB时，需要在连接到远端之前设置。
    
    返回:
    
    int
    
    默认值:
    
    -1
- - childOptionSoSndbuf
```
public abstract int childOptionSoSndbuf
```
    TCP数据发送缓冲区大小。该缓冲区即TCP发送滑动窗口，linux操作系统可使用命令：cat /proc/sys/net/ipv4/tcp_smem查询其大小
    
    返回:
    
    int
    
    默认值:
    
    -1
- - childOptionTcpNodelay
```
public abstract boolean childOptionTcpNodelay
```
    立即发送数据，默认值为Ture（Netty默认为True而操作系统默认为False）。该值设置Nagle算法的启用，改算法将小的碎片数据连接成更大的报文来最小化所发送的报文的数量，如果需要发送一些较小的报文，则需要禁用该算法。 Netty默认禁用该算法，从而最小化报文传输延时
    
    返回:
    
    boolean
    
    默认值:
    
    true
- - childOptionSoKeepalive
```
public abstract boolean childOptionSoKeepalive
```
    连接保活，默认值为False。启用该功能时，TCP会主动探测空闲连接的有效性。可以将此功能视为TCP的心跳机制，需要注意的是：默认的心跳间隔是7200s即2小时。Netty默认关闭该功能。
    
    返回:
    
    boolean
    
    默认值:
    
    false
- - childOptionSoLinger
```
public abstract int childOptionSoLinger
```
    关闭Socket的延迟时间，默认值为-1，表示禁用该功能。 -1表示socket.close()方法立即返回，但OS底层会将发送缓冲区全部发送到对端。 0表示socket.close()方法立即返回，OS放弃发送缓冲区的数据直接向对端发送RST包，对端收到复位错误。非0整数值表示调用socket.close()方法的线程被阻塞直到延迟时间到或发送缓冲区中的数据发送完毕，若超时，则对端会收到复位错误。
    
    返回:
    
    int
    
    默认值:
    
    -1
- - childOptionAllowHalfClosure
```
public abstract boolean childOptionAllowHalfClosure
```
    一个连接的远端关闭时本地端是否关闭，默认值为False。值为False时，连接自动关闭；为True时，触发ChannelInboundHandler的userEventTriggered()方法，事件为ChannelInputShutdownEvent。
    
    返回:
    
    boolean
    
    默认值:
    
    false
- - readerIdleTimeSeconds
```
public abstract int readerIdleTimeSeconds
```
    与IdleStateHandler中的readerIdleTimeSeconds一致，并且当它不为0时，将在pipeline中添加IdleStateHandler
    
    返回:
    
    int
    
    默认值:
    
    0
- - writerIdleTimeSeconds
```
public abstract int writerIdleTimeSeconds
```
    与IdleStateHandler中的writerIdleTimeSeconds一致，并且当它不为0时，将在pipeline中添加IdleStateHandler
    
    返回:
    
    int
    
    默认值:
    
    0
- - allIdleTimeSeconds
```
public abstract int allIdleTimeSeconds
```
    与IdleStateHandler中的allIdleTimeSeconds一致，并且当它不为0时，将在pipeline中添加IdleStateHandler
    
    返回:
    
    int
    
    默认值:
    
    0
- - maxFramePayloadLength
```
public abstract int maxFramePayloadLength
```
    最大允许帧载荷长度
    
    返回:
    
    int
    
    默认值:
    
    65536
- - useEventExecutorGroup
```
public abstract boolean useEventExecutorGroup
```
    是否使用另一个线程池来执行耗时的同步业务逻辑
    
    返回:
    
    boolean
    
    默认值:
    
    true
- - eventExecutorGroupThreads
```
public abstract int eventExecutorGroupThreads
```
    eventExecutorGroup的线程数
    
    返回:
    
    int
    
    默认值:
    
    16
- - sslKeyPassword
```
public abstract String sslKeyPassword
```
    与spring-boot的server.ssl.key-password一致
    
    返回:
    
    String
    
    默认值:
    
    ""
- - sslKeyStore
```
public abstract String sslKeyStore
```
    与spring-boot的server.ssl.key-store一致
    
    返回:
    
    String
    
    默认值:
    
    ""
- - sslKeyStorePassword
```
public abstract String sslKeyStorePassword
```
    与spring-boot的server.ssl.key-store-password一致
    
    返回:
    
    String
    
    默认值:
    
    ""
- - sslKeyStoreType
```
public abstract String sslKeyStoreType
```
    与spring-boot的server.ssl.key-store-type一致
    
    返回:
    
    String
    
    默认值:
    
    ""
- - sslTrustStore
```
public abstract String sslTrustStore
```
    与spring-boot的server.ssl.trust-store一致
    
    返回:
    
    String
    
    默认值:
    
    ""
- - sslTrustStorePassword
```
public abstract String sslTrustStorePassword
```
    与spring-boot的server.ssl.trust-store-password一致
    
    返回:
    
    String
    
    默认值:
    
    ""
- - sslTrustStoreType
```
public abstract String sslTrustStoreType
```
    与spring-boot的server.ssl.trust-store-type一致
    
    返回:
    
    String
    
    默认值:
    
    ""
- - corsOrigins
```
public abstract String[] corsOrigins
```
    与spring boot的@CrossOrigin#origins一致
    
    返回:
    
    String[]
    
    默认值:
    
    {}
- - corsAllowCredentials
```
public abstract String corsAllowCredentials
```
    与spring boot的@CrossOrigin#allowCredentials一致
    
    返回:
    
    String
    
    默认值:
    
    ""

注释类型 WebSocketEndpoint

可选元素概要

元素详细资料

value

path

host

port

bossLoopGroupThreads

workerLoopGroupThreads

useCompressionHandler

optionConnectTimeoutMillis

optionSoBacklog

childOptionWriteSpinCount

childOptionWriteBufferHighWaterMark

childOptionWriteBufferLowWaterMark

childOptionSoRcvbuf

childOptionSoSndbuf

childOptionTcpNodelay

childOptionSoKeepalive

childOptionSoLinger

childOptionAllowHalfClosure

readerIdleTimeSeconds

writerIdleTimeSeconds

allIdleTimeSeconds

maxFramePayloadLength

useEventExecutorGroup

eventExecutorGroupThreads

sslKeyPassword

sslKeyStore

sslKeyStorePassword

sslKeyStoreType

sslTrustStore

sslTrustStorePassword

sslTrustStoreType

corsOrigins

corsAllowCredentials