com.ejlchina.okhttps.internal

类 WebSocketTask

java.lang.Object

com.ejlchina.okhttps.HttpTask<WebSocketTask>

com.ejlchina.okhttps.internal.WebSocketTask

所有已实现的接口:

Cancelable

public class WebSocketTask
extends HttpTask<WebSocketTask>

字段概要

从类继承的字段 com.ejlchina.okhttps.HttpTask

httpClient, nextOnIO, nothrow, skipPreproc, skipSerialPreproc

构造器概要

构造器

构造器和说明
WebSocketTask(HttpClient httpClient, java.lang.String url)

方法概要

限定符和类型	方法和说明
WebSocketTask	heatbeat(int pingSeconds, int pongSeconds) 设置心跳间隔 覆盖 OkHttp 原有的心跳模式，主要区别如下： 1、客户端发送的任何消息都具有一次心跳作用 2、服务器发送的任何消息都具有一次心跳作用 3、若服务器超过 3 * pongSeconds 秒没有回复心跳，才判断心跳超时
boolean	isWebsocket()
WebSocket	listen() 启动 WebSocket 监听
int	pingSeconds()
WebSocketTask	pingSupplier(java.util.function.Supplier<okio.ByteString> pingSupplier)
int	pongSeconds()
WebSocketTask	setOnClosed(WebSocket.Listener<WebSocket.Close> onClosed) 已关闭监听（当连接被取消或发生异常时，也会走该回调）
WebSocketTask	setOnClosing(WebSocket.Listener<WebSocket.Close> onClosing) 正在关闭监听
WebSocketTask	setOnException(WebSocket.Listener<java.lang.Throwable> onException) 连接异常监听
WebSocketTask	setOnMessage(WebSocket.Listener<WebSocket.Message> onMessage) 消息监听
WebSocketTask	setOnOpen(WebSocket.Listener<HttpResult> onOpen) 连接打开监听

从类继承的方法 com.ejlchina.okhttps.HttpTask

addBodyPara, addBodyPara, addFilePara, addFilePara, addFilePara, addFilePara, addHeader, addHeader, addPathPara, addPathPara, addUrlPara, addUrlPara, assertNotConflict, bind, bodyType, cancel, charset, charset, execute, getBodyType, getBound, getHeaders, getTag, getUrl, isAsyncHttp, isSyncHttp, isTagged, nextOnIO, nothrow, prepareCall, prepareRequest, registeTagTask, removeTagTask, setBodyPara, setOnProcess, setRange, setRange, skipPreproc, skipSerialPreproc, stepBytes, stepRate, tag, timeoutAwait, timeoutResult, toState

从类继承的方法 java.lang.Object

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

构造器详细资料

WebSocketTask

public WebSocketTask(HttpClient httpClient,
                     java.lang.String url)

方法详细资料

isWebsocket

public boolean isWebsocket()

覆盖:

isWebsocket 在类中 HttpTask<WebSocketTask>

返回:

是否是 Websocket 通讯

heatbeat

public WebSocketTask heatbeat(int pingSeconds,
                              int pongSeconds)

设置心跳间隔 覆盖 OkHttp 原有的心跳模式，主要区别如下： 1、客户端发送的任何消息都具有一次心跳作用 2、服务器发送的任何消息都具有一次心跳作用 3、若服务器超过 3 * pongSeconds 秒没有回复心跳，才判断心跳超时

参数:

pingSeconds - 客户端心跳间隔秒数（0 表示不需要心跳）

pongSeconds - 服务器心跳间隔秒数（0 表示不需要心跳）

返回:

WebSocketTask

pingSupplier

public WebSocketTask pingSupplier(java.util.function.Supplier<okio.ByteString> pingSupplier)

参数:

pingSupplier - 心跳数据提供者

返回:

WebSocketTask

listen

public WebSocket listen()

启动 WebSocket 监听

返回:

WebSocket

setOnOpen

public WebSocketTask setOnOpen(WebSocket.Listener<HttpResult> onOpen)

连接打开监听

参数:

onOpen - 监听器

返回:

WebSocketTask

setOnException

public WebSocketTask setOnException(WebSocket.Listener<java.lang.Throwable> onException)

连接异常监听

参数:

onException - 监听器

返回:

WebSocketTask

setOnMessage

public WebSocketTask setOnMessage(WebSocket.Listener<WebSocket.Message> onMessage)

消息监听

参数:

onMessage - 监听器

返回:

WebSocketTask

setOnClosing

public WebSocketTask setOnClosing(WebSocket.Listener<WebSocket.Close> onClosing)

正在关闭监听

参数:

onClosing - 监听器

返回:

WebSocketTask

setOnClosed

public WebSocketTask setOnClosed(WebSocket.Listener<WebSocket.Close> onClosed)

已关闭监听（当连接被取消或发生异常时，也会走该回调）

参数:

onClosed - 监听器

返回:

WebSocketTask

pingSeconds

public int pingSeconds()

pongSeconds

public int pongSeconds()