Package org.miaixz.bus.http.socket

Class WebSocketListener

java.lang.Object

org.miaixz.bus.http.socket.WebSocketListener

Direct Known Subclasses:

CoverCall.Listener

public abstract class WebSocketListener
extends Object

web socket 监听器

Since:

Java 17+

Author:

Kimi Liu

Constructor Summary

Constructors

Constructor	Description
WebSocketListener()

Method Summary

Modifier and Type	Method	Description
void	onClosed(WebSocket webSocket, int code, String reason)	当两个对等点都指示不再传输任何消息且连接已成功释放时调用。
void	onClosing(WebSocket webSocket, int code, String reason)	当远程对等点指示不再传输传入消息时调用
void	onFailure(WebSocket webSocket, Throwable throwable, Response response)	当web套接字由于从网络读取或写入错误而关闭时调用。
void	onMessage(WebSocket webSocket, String text)	当收到文本(类型为0x1)消息时调用
void	onMessage(WebSocket webSocket, org.miaixz.bus.core.io.ByteString bytes)	当接收到二进制(类型为0x2)消息时调用
void	onOpen(WebSocket webSocket, Response response)	当web socket被远程对等方接受并可以开始传输消息时调用

Methods inherited from class java.lang.Object

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

Constructor Details

WebSocketListener

public WebSocketListener()

Method Details

onOpen

public void onOpen(WebSocket webSocket,
 Response response)

当web socket被远程对等方接受并可以开始传输消息时调用

Parameters:

webSocket - 当前web socket

response - 当前响应体

onMessage

public void onMessage(WebSocket webSocket,
 String text)

当收到文本(类型为0x1)消息时调用

Parameters:

webSocket - 当前web socket

text - 文本内容

onMessage

public void onMessage(WebSocket webSocket,
 org.miaixz.bus.core.io.ByteString bytes)

当接收到二进制(类型为0x2)消息时调用

Parameters:

webSocket - 当前web socket

bytes - 二进制内容

onClosing

public void onClosing(WebSocket webSocket,
 int code,
 String reason)

当远程对等点指示不再传输传入消息时调用

Parameters:

webSocket - 当前web socket

code - 状态码

reason - 关闭终止原因

onClosed

public void onClosed(WebSocket webSocket,
 int code,
 String reason)

当两个对等点都指示不再传输任何消息且连接已成功释放时调用。不再调用此侦听器

Parameters:

webSocket - 当前web socket

code - 状态码

reason - 关闭终止原因

onFailure

public void onFailure(WebSocket webSocket,
 Throwable throwable,
 Response response)

当web套接字由于从网络读取或写入错误而关闭时调用。发出和传入的消息可能都丢失了。不再调用此侦听器

Parameters:

webSocket - 当前web socket

throwable - 线程信息

response - 当前响应体