M3D / M3D / Utility / SocketConnect

Class: SocketConnect

M3D.Utility.SocketConnect

File

Brief

负责单个Socket通信的接口实现，包括websocket发送、接收消息

Author

YW

Date

2022-7-27

Version

1.0

Table of contents

Constructors

• constructor

Methods

• create
• destory
• getCloseCallBack
• getErrorCallBack
• getMessageCallBack
• getOpenCallBack
• getSocket
• onClose
• onError
• onMessage
• onOpen
• reconnect
• resetHeart
• send
• setCloseCallBack
• setErrorCallBack
• setMessageCallBack
• setOpenCallBack
• startHeart

Constructors

constructor

• new SocketConnect(url): SocketConnect

初始化

Parameters

Name	Type
url	string

Returns

SocketConnect

Methods

create

▸ create(ops?): boolean

建立连接

Parameters

Name	Type
ops?	Ioptions

Returns

boolean

---

destory

▸ destory(isClose, code?, reason?): void

销毁

Parameters

Name	Type
isClose	boolean
code?	number
reason?	string

Returns

void

---

getCloseCallBack

▸ getCloseCallBack(): any

Returns

any

Description

获取关闭回调

---

getErrorCallBack

▸ getErrorCallBack(): any

Returns

any

Description

获取错误回调

---

getMessageCallBack

▸ getMessageCallBack(): any

Returns

any

Description

获取消息回调

---

getOpenCallBack

▸ getOpenCallBack(): any

Returns

any

Description

获取打开回调

---

getSocket

▸ getSocket(): WebSocket

Returns

WebSocket

Description

获取当前socket

---

onClose

▸ onClose(callback): void

Parameters

Name	Type
callback	Function

Returns

void

Description

接收连接关闭的消息

---

onError

▸ onError(callback): void

Parameters

Name	Type
callback	Function

Returns

void

Description

接收到异常时

---

onMessage

▸ onMessage(callback): void

Parameters

Name	Type
callback	Function

Returns

void

Description

接收到消息时

---

onOpen

▸ onOpen(callback): void

Parameters

Name	Type
callback	Function

Returns

void

Description

接收连接成功的消息

---

reconnect

▸ reconnect(): void

重新连接事件

Returns

void

---

resetHeart

▸ resetHeart(): void

Returns

void

Description

重置

---

send

▸ send(data): void

Parameters

Name	Type	Description
data	string | ArrayBuffer | Blob | ArrayBufferView	用于传输至服务器的数据。必须是以下类型之一

Returns

void

Description

发送消息

---

setCloseCallBack

▸ setCloseCallBack(closeCallBack): void

Parameters

Name	Type
closeCallBack	any

Returns

void

Description

设置错误回调

---

setErrorCallBack

▸ setErrorCallBack(errorCallBack): void

Parameters

Name	Type
errorCallBack	any

Returns

void

Description

设置错误回调

---

setMessageCallBack

▸ setMessageCallBack(messageCallBack): void

Parameters

Name	Type
messageCallBack	any

Returns

void

Description

设置消息回调

---

setOpenCallBack

▸ setOpenCallBack(openCallBack): void

Parameters

Name	Type
openCallBack	any

Returns

void

Description

设置打开回调

---

startHeart

▸ startHeart(event): void

Parameters

Name	Type	Description
event	any	回调函数

Returns

void

Description

启动心跳