模块 org.redkale

注释类型 RestWebSocket


  • @Inherited
    @Documented
    @Target(TYPE)
    @Retention(RUNTIME)
    public @interface RestWebSocket
    只能依附在WebSocket类上,name默认为Service的类名小写并去掉Service字样及后面的字符串 (如HelloWebSocket/HelloWebSocketImpl,的默认路径为 hello)。
    注意: 被标记@RestWebSocket的WebSocket不能被修饰为abstract或final, 且其内部标记为@Resource的字段只能是protected或public,且必须要有一个protected或public的空参数构造函数。
    name值支持含{system.property.xxx}模式

    详情见: https://redkale.org

    作者:
    zhangjx
    另请参阅:
    RestOnMessage
    • 可选元素概要

      可选元素 
      修饰符和类型 可选元素 说明
      boolean anyuser
      WebSocket.createUserid返回的值是否不能表示用户登录态, 比如createUserid返回随机的UUID那么anyuser应该为true
      boolean binary
      是否为二进制消息, 默认为文本消息
      String catalog
      目录名, 不能含特殊字符, 只能小写字母+数字,且不能以数字开头
      String comment
      备注描述
      Class<? extends Cryptor> cryptor
      加密解密器
      boolean ignore
      是否屏蔽该类的转换
      int liveinterval
      WebScoket服务器给客户端进行ping操作的间隔时间, 单位: 秒, 默认值:15秒
      String name
      模块名, 只能是模块名,不能含特殊字符, 只能小写字母+数字,且不能以数字开头
      boolean repair
      同@WebServlet的repair属性
      boolean single
      是否单用户单连接, 默认单用户单连接
      int wsmaxbody
      最大消息体长度, 小于1表示无限制
      int wsmaxconns
      最大连接数, 小于1表示无限制
      int wsthreads
      操作WebSocketNode对应CacheSource并发数, 为-1表示无限制,为0表示系统默认值(CPU*8)
    • 元素详细资料

      • name

        String name
        模块名, 只能是模块名,不能含特殊字符, 只能小写字母+数字,且不能以数字开头
        返回:
        模块名
        默认值:
        ""
      • catalog

        String catalog
        目录名, 不能含特殊字符, 只能小写字母+数字,且不能以数字开头
        返回:
        目录名
        默认值:
        ""
      • binary

        boolean binary
        是否为二进制消息, 默认为文本消息
        返回:
        boolean
        默认值:
        false
      • single

        boolean single
        是否单用户单连接, 默认单用户单连接
        返回:
        是否单用户单连接
        默认值:
        true
      • anyuser

        boolean anyuser
        WebSocket.createUserid返回的值是否不能表示用户登录态, 比如createUserid返回随机的UUID那么anyuser应该为true
        返回:
        默认false
        默认值:
        false
      • liveinterval

        int liveinterval
        WebScoket服务器给客户端进行ping操作的间隔时间, 单位: 秒, 默认值:15秒
        返回:
        int
        默认值:
        15
      • cryptor

        Class<? extends Cryptor> cryptor
        加密解密器
        返回:
        Cryptor
        默认值:
        org.redkale.net.Cryptor.class
      • wsmaxconns

        int wsmaxconns
        最大连接数, 小于1表示无限制
        返回:
        最大连接数
        默认值:
        0
      • wsthreads

        int wsthreads
        操作WebSocketNode对应CacheSource并发数, 为-1表示无限制,为0表示系统默认值(CPU*8)
        返回:
        最大连接数
        默认值:
        0
      • wsmaxbody

        int wsmaxbody
        最大消息体长度, 小于1表示无限制
        返回:
        最大消息体长度
        默认值:
        32768
      • ignore

        boolean ignore
        是否屏蔽该类的转换
        返回:
        默认false
        默认值:
        false
      • repair

        boolean repair
        同@WebServlet的repair属性
        返回:
        默认true
        默认值:
        true
      • comment

        String comment
        备注描述
        返回:
        备注描述
        默认值:
        ""