Module bus.http
Package org.miaixz.bus.http.socket

Interface WebSocket

All Known Implementing Classes:
RealWebSocket
public interface WebSocket
到web socket的非阻塞接口。使用factory 通常是Httpd 在正常操作时，每个web套接字将通过一系列状态进行处理
Since:
Java 17+
Author:
Kimi Liu

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    WebSocket.Factory
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancel()
    立即并强烈地释放这个web套接字持有的资源，丢弃任何排队的消息 如果web套接字已经关闭或取消，则此操作不执行任何操作
    boolean
    close(int code, String reason)
    尝试启动此web套接字的正常关闭。
    long
    queueSize()
     
    Request
    request()
     
    boolean
    send(String text)
    尝试将text编码为UTF-8并将其作为文本(类型为0x1)消息的数据发送 如果消息被加入队列，此方法将返回true。
    boolean
    send(org.miaixz.bus.core.io.ByteString bytes)
    尝试将bytes作为二进制(类型为0x2)消息的数据发送 如果消息被加入队列，此方法将返回true。

  • Method Details

    • request

      Request request()
      Returns:
      返回初始化此web套接字的请求

    • queueSize

      long queueSize()
      Returns:
      所有排队等待发送到服务器的消息的大小(以字节为单位)。这还不包括帧开销 它也不包括任何由操作系统或网络中介体缓冲的字节。如果队列中没有消息等待，则此方法返回0 如果在web套接字被取消后可能返回一个非零值;这表示未传输排队消息

    • send

      boolean send(String text)
      尝试将text编码为UTF-8并将其作为文本(类型为0x1)消息的数据发送 如果消息被加入队列，此方法将返回true。将溢出传出消息缓冲区的消息将被拒绝， 并触发此web套接字的graceful shutdown。此方法在这种情况下返回false， 在此web套接字关闭、关闭或取消的任何其他情况下也返回false
      Parameters:
      text - 文本信息
      Returns:
      the true/false

    • send

      boolean send(org.miaixz.bus.core.io.ByteString bytes)
      尝试将bytes作为二进制(类型为0x2)消息的数据发送 如果消息被加入队列，此方法将返回true。将溢出传出消息缓冲区(16 MiB)的消息将被拒绝， 并触发此web套接字的graceful shutdown。此方法在这种情况下返回false， 在此web套接字关闭、关闭或取消的任何其他情况下也返回false
      Parameters:
      bytes - 缓存流
      Returns:
      the true/false

    • close

      boolean close(int code, String reason)
      尝试启动此web套接字的正常关闭。任何已加入队列的消息将在发送关闭消息之前发送， 但是随后对send(java.lang.String)的调用将返回false，它们的消息将不被加入队列
      Parameters:
      code - RFC 6455第7.4节定义的状态码
      reason - 关闭或null的原因
      Returns:
      the true/false
      Throws:
      IllegalArgumentException - 如果状态码无效

    • cancel

      void cancel()
      立即并强烈地释放这个web套接字持有的资源，丢弃任何排队的消息 如果web套接字已经关闭或取消，则此操作不执行任何操作