Skip to content

InsightClient (JavaScript)

InsightClient

Scripting Name:Insight.InsightClient

建立一个对服务器的网络连接。

javascript
constructor(address: string, port: number, using_ssl: boolean);

Parameters

  • address : string IP 地址
  • port : number 端口号
  • using_ssl : boolean 是否建立 SSL 的安全链接,目前该参数不生效
  • _在 Web _SDK__中无效

*洞见__SDK_ v2.0 及以上_

Properties


status

type :number

(只读)当前连接状态。0:连接正常;1:已断开


Methods


disconnect

javascript
disconnect(): void;

断开当前链接。

send

javascript
send(msg: string, size: number): number;

发送一个二进制数据包到 IP 地址对应的服务器。返回值为 0 表示发送成功,否则返回错误号。

Parameters

  • msg : string 数据包内容
  • size : number 数据包大小

tryRecv

javascript
tryRecv(): number;

检查接收队列。如果有消息,则更新 RecvData()函数得到的内容。

返回值:如果有消息,返回队列中最前端消息的长度;否则返回 0。

recvData

javascript
recvData(): string;

返回上一次有消息时,TryRecv()的内容。


sendInitUserContextRequest

javascript
sendInitUserContextRequest(gameServerId: string, secret: string, divisionId: string, divisionIdSpace: string, roomNumber: number,position: number, keepUserSecondsOnNetworkError: number): number;

发送一个 InitUserContextRequest 数据包。返回 0 表示发送成功,否则返回错误号。

Parameters

  • gameServerId : string 主服务器返回的游戏服务器 ID
  • secret : string 密钥字符串(已弃用,可填任意值)
  • divisionId : string 赛区 ID
  • divisionIdSpace : string 赛区 ID 的空间,比如商家 ID 空间(每个商家是一个赛区)和三方应用 ID 空间(每个三方应用是一个赛区)。赛区 ID 空间由多人 AR 服务端定义
  • roomNumber : number 房间号,一个房间号可同时进行多个游戏,对应多个 roomId。正常的房间号应至少大于等于 1
  • position : number 房间内的位置序号
  • keepUserSecondsOnNetworkError : number 在网络错误时,保留用户状态 N 秒后再移除用户。在此期间内用户可尝试重连并恢复状态。允许的范围是 0~60

sendRestoreUserContextRequest

javascript
sendRestoreUserContextRequest(gameServerId: string, token: string): number;

发送一个 RestoreUserContextRequest 数据包。返回 0 表示发送成功,否则返回错误号。

Parameters

  • gameServerId : string 主服务器返回的游戏服务器 ID
  • token : string 用户本次会话的令牌(从 InitUserContextResponse 获得)

sendClientHeartbeatRequest

javascript
sendClientHeartbeatRequest(random: string): number;

发送一个 ClientHeartbeatRequest 心跳数据包。返回 0 表示发送成功,否则返回错误号。

Parameters

  • random : string 随机数