M3D / M3D / Utility / SocketMessageHandler

Class: SocketMessageHandler

M3D.Utility.SocketMessageHandler

File

Brief

Websocket消息协议类：负责具体的websocket消息，外部直接调用

Author

YW

Date

2022-7-27

Version

1.0

Hierarchy

• DataParser

  ↳ SocketMessageHandler

Table of contents

Constructors

• constructor

Properties

• commandKey

Methods

• addCloseCallBack
• addErrorCallBack
• addMessageCB
• addOpenCallBack
• clearCloseCallBack
• clearErrorCallBack
• clearMessageCallBack
• clearOpenCallBack
• createSocket
• deleteview
• destorySocket
• getSendData
• getconfig
• getdata
• getelement
• getelementlist
• getsingle
• getstrategy
• onClose
• onDestory
• onError
• onMessage
• onOpen
• openmodel
• parseData
• removeCloseCallBack
• removeErrorCallBack
• removeMessageCallBack
• removeOpenCallBack
• saveconfig
• saveview
• send
• updateview
• socketMessageHandler

Constructors

constructor

• new SocketMessageHandler(): SocketMessageHandler

Returns

SocketMessageHandler

Inherited from

DataParser.constructor

Properties

commandKey

• commandKey: string

Methods

addCloseCallBack

▸ addCloseCallBack(url, callBack): void

Parameters

Name	Type	Description
url	string	websocket对应的连接地址
callBack	Function	回调函数

Returns

void

Description

添加连接关闭回调

---

addErrorCallBack

▸ addErrorCallBack(url, callBack): void

Parameters

Name	Type	Description
url	string	websocket对应的地址
callBack	Function	回调函数

Returns

void

Description

添加异常回调

---

addMessageCB

▸ addMessageCB(url, callBack): void

Parameters

Name	Type	Description
url	string	网络连接地址
callBack	Function	回调函数

Returns

void

Description

添加消息头对应的回调

---

addOpenCallBack

▸ addOpenCallBack(callBack): void

Parameters

Name	Type	Description
callBack	Function	连接成功的回调方法

Returns

void

Description

添加websocket连接成功回调方法

---

clearCloseCallBack

▸ clearCloseCallBack(url?): boolean

Parameters

Name	Type	Description
url?	string	可选参数，websocket对应的地址，若无则清空所有关闭回调

Returns

boolean

Description

清空关闭回调

---

clearErrorCallBack

▸ clearErrorCallBack(url?): boolean

Parameters

Name	Type	Description
url?	string	可选参数 websocket对应的地址

Returns

boolean

Description

清空异常回调

---

clearMessageCallBack

▸ clearMessageCallBack(url?): boolean

Parameters

Name	Type	Description
url?	string	可选参数，消息对应的网络地址

Returns

boolean

Description

清空消息回调

---

clearOpenCallBack

▸ clearOpenCallBack(url?): boolean

Parameters

Name	Type	Description
url?	string	可选参数，websocket地址

Returns

boolean

Description

清空websocket连接回调

---

createSocket

▸ createSocket(socketConnect): void

Parameters

Name	Type
socketConnect	any

Returns

void

Description

创建连接

---

deleteview

▸ deleteview(url, viewid, fileid, uniqueid): void

Parameters

Name	Type	Description
url	any	-
viewid	string	//需要删除的viewid(数据库中的id),与fileid不能同时为空
fileid	string	//源文件id,根据此id实现批量删除,与viewid不能同时为空
uniqueid	string	//模型唯一id

Returns

void

Description

删除视图

---

destorySocket

▸ destorySocket(socketConnect): void

Parameters

Name	Type
socketConnect	any

Returns

void

Description

销毁连接

---

getSendData

▸ getSendData(header, paraMap?): string

Parameters

Name	Type	Description
header	string	消息头
paraMap?	Map<string, any>	消息内容

Returns

string

Description

获取发送数据，将Map消息体转换为SView特定格式消息

---

getconfig

▸ getconfig(url, uniqueid, filelid, type): void

Parameters

Name	Type	Description
url	any	-
uniqueid	string	// 唯一号(可传用户id)
filelid	any	//模型id（文档配置时必传）
type	any	// 配置类型：1：系统配置 2：文档配置

Returns

void

Description

获取文档配置

---

getdata

▸ getdata(url, cameradata?, viewportaspect?, viewportheight?, viewportwidth?): void

Parameters

Name	Type	Description
url	any	-
cameradata?	any	当前相机信息
viewportaspect?	any	视口角度信息
viewportheight?	any	视口高度
viewportwidth?	any	视口宽度

Returns

void

Description

初始加载-获取bom、lod、材质、mesh数据

---

getelement

▸ getelement(url, type, typeids, geoid, range): void

Parameters

Name	Type	Description
url	any	-
type	string	内容类型
typeids	any	根据type类型，传递不同类型的id，多个用英文,隔开
geoid	any	几何要素id
range	any	元素获取范围

Returns

void

Description

获取元素内容

---

getelementlist

▸ getelementlist(url, type, range, uniqueid, modelid?): void

Parameters

Name	Type	Description
url	any	-
type	string	内容类型
range	any	元素获取范围
uniqueid	any	-
modelid?	any	文件内部模型ID

Returns

void

Description

获取元素列表

---

getsingle

▸ getsingle(url, content, relativepath?): void

Parameters

Name	Type	Description
url	any	-
content	string	单个文件后缀 ：info、bom等
relativepath?	any	其他资源 在svl里面的相对路径

Returns

void

Description

获取单个文件

---

getstrategy

▸ getstrategy(url, strategy, partStreamFlag, partStreamRate, viewconfig?, envconfig?): void

Parameters

Name	Type
url	any
strategy	string
partStreamFlag	boolean
partStreamRate	number
viewconfig?	any
envconfig?	any

Returns

void

Description

获取加载方式

---

onClose

▸ onClose(event, url?): void

Parameters

Name	Type
event	any
url?	string

Returns

void

Description

接收连接关闭的消息

---

onDestory

▸ onDestory(event, url?): void

Parameters

Name	Type
event	any
url?	string

Returns

void

Description

接收到销毁时

---

onError

▸ onError(event, url?): void

Parameters

Name	Type
event	any
url?	string

Returns

void

Description

接收到异常时

---

onMessage

▸ onMessage(url, event): void

Parameters

Name	Type
url	string
event	any

Returns

void

Description

接收到消息时

---

onOpen

▸ onOpen(event, url?): void

Parameters

Name	Type
event	any
url?	string

Returns

void

Description

接收连接成功的消息

---

openmodel

▸ openmodel(url, uniqueid, userid, usernickname, splitconfig?): void

Parameters

Name	Type
url	any
uniqueid	string
userid	any
usernickname	any
splitconfig?	any

Returns

void

Description

打开模型

---

parseData

▸ parseData(data): Map<string, any>

Parameters

Name	Type	Description
data	any	需要解析的数据

Returns

Map<string, any>

解析后数据，包括头、结果数据（json、string、arraybuffer等格式）

Description

解析数据

Overrides

DataParser.parseData

---

removeCloseCallBack

▸ removeCloseCallBack(url, callBack): boolean

Parameters

Name	Type	Description
url	string	websocket对应的地址
callBack	Function	回调函数

Returns

boolean

Description

删除连接关闭回调

---

removeErrorCallBack

▸ removeErrorCallBack(url, callBack): boolean

Parameters

Name	Type	Description
url	string	websocket对应的地址
callBack	Function	回调函数

Returns

boolean

Description

删除异常回调

---

removeMessageCallBack

▸ removeMessageCallBack(url, callBack): boolean

Parameters

Name	Type	Description
url	string	回调函数对应的网络地址，可为空，为空则查找所有回调进行删除
callBack	Function	回调函数

Returns

boolean

Description

删除回调函数

---

removeOpenCallBack

▸ removeOpenCallBack(url, callBack): boolean

Parameters

Name	Type	Description
url	string	websocket地址，可为空，为空则清空所有对应的回调
callBack	Function	回调

Returns

boolean

Description

删除websocket连接成功回调

---

saveconfig

▸ saveconfig(url, uniqueid, content, modelid, type): void

Parameters

Name	Type	Description
url	any	-
uniqueid	string	//唯一模型id
content	any	//配置内容json串
modelid	any	//模型id（文档配置时必传）
type	any	//配置类型：1：系统配置 2：文档配置

Returns

void

Description

保存文档配置

---

saveview

▸ saveview(url, content, contentfile, image1, image2, uniqueid, creator, name, modelid, modelviewid, isactivated, ishasboard): void

Parameters

Name	Type	Description
url	any	-
content	string	自定义视图的json格式字符串
contentfile	any	视图关联内容的文件
image1	any	视图缩略图1
image2	any	视图缩略图2
uniqueid	any	客户端唯一标识
creator	any	创建者名称
name	any	视图名称
modelid	any	模型文件中的模型id,用来标记给哪个模型添加的视图
modelviewid	any	该视图在本地视图中的id,用来与本地视图比较
isactivated	any	是否设置为 默认视图:0否;1是
ishasboard	any	是否存在看板图片:0否;1是

Returns

void

Description

保存视图

---

send

▸ send(url, data): void

Parameters

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

Returns

void

Description

发送消息公共方法

---

updateview

▸ updateview(url, viewid, uniqueid, name, isactivated): void

Parameters

Name	Type	Description
url	any	-
viewid	string	视图id
uniqueid	any	模型唯一id
name	any	视图名称
isactivated	any	是否是默认视图

Returns

void

Description

更新视图（修改默认视图）

---

socketMessageHandler

▸ socketMessageHandler(): SocketMessageHandler

Returns

SocketMessageHandler

Description

单例模型接口