WebSocket

has.connectSocket

has.connectSocket(Object object): SocketTask

创建新的WebSocket连接。

• 开发者服务器接口地址，必须是wss协议，并在HarmonyOS 开发者中心完成服务器域名配置。

• 如果没有全局实例的话，会生成一个对应的全局实例。可以通过has.sendSocketMessage进行消息发送。

• 一个元服务内，最多同时存在5个全局实例。

起始版本： 1.0.0

参数：

参数为Object对象，包括以下字段。

返回值：

返回SocketTask对象，可以通过socketTask实例来操作socket。

错误码信息：

示例：

has.connectSocket({
  url: 'ws://www.example.com', // 此处仅为样例，请开发者更换为可用接口地址
  header: {
    'content-type': 'application/json'
  },
  protocols: ['protocol1']
});

has.sendSocketMessage

has.sendSocketMessage(Object object)

通过已连接成功的WebSocket连接发送数据。

需要先调用has.connectSocket，并在has.onSocketOpen接收到回调之后才能发送，否则会发送失败。

起始版本： 1.0.0

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

has.sendSocketMessage({
  data: 'Hello'
});

has.onSocketOpen

has.onSocketOpen(function callback)

订阅WebSocket连接打开事件回调。

起始版本： 1.0.0

参数：

callback返回值：

错误码信息：

示例：

has.onSocketOpen((res) => {
  console.info('onSocketOpen success', res);
});

has.onSocketMessage

has.onSocketMessage(function callback)

订阅WebSocket接收到服务器的消息事件回调。

起始版本： 1.0.0

参数：

callback返回值：

错误码信息：

示例：

has.onSocketMessage(res => {
  console.info('socket message', res);
});

has.onSocketError

has.onSocketError(function callback)

订阅WebSocket错误事件回调。

起始版本： 1.0.0

参数：

错误码信息：

示例：

has.onSocketError(err => {
  console.error('socket error', err);
});

has.onSocketClose

has.onSocketClose(function callback)

订阅WebSocket连接关闭事件回调。

起始版本： 1.0.0

参数：

错误码信息：

示例：

has.onSocketClose(() => {
  console.info('onSocketClose success');
});

has.closeSocket

has.closeSocket(Object object)

关闭WebSocket连接。

起始版本： 1.0.0

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

has.connectSocket({
  url: 'ws://www.example.com', // 此处仅为样例，请开发者更换为可用接口地址
});
has.onSocketOpen(() => {
  has.closeSocket();
});
has.onSocketClose((res) => {
  console.info('onSocketClose success');
});

SocketTask

[h2]SocketTask.send

SocketTask.send(Object object)

通过WebSocket连接发送数据。

起始版本： 1.0.0

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

let socketTask = has.connectSocket({
  url: 'ws://www.example.com', // 此处仅为样例，请开发者更换为可用接口地址
  header: {
    'content-type': 'application/json'
  },
  protocols: ['protocol1'],
  method: 'GET',
  success: () => {
    console.info('on socketTask connect success callback receive');
  }
});
socketTask.send({
  data: 'this is a send message',
  success: (res) => {
    console.info('socket send message success', res);
  },
  fail: (err) => {
    console.error('socket send message error', err);
  },
  complete: (res) => {
    console.info('socket send message complete', res);
  }
});

[h2]SocketTask.close

SocketTask.close(Object object)

关闭WebSocket连接。

起始版本： 1.0.0

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

let socketTask = has.connectSocket({
  url: 'ws://www.example.com', // 此处仅为样例，请开发者更换为可用接口地址
  header: {
    'content-type': 'application/json'
  },
  protocols: ['protocol1'],
  method: 'GET',
  success: () => {
    console.info('on socketTask connect success callback receive');
  }
});
socketTask.close();

[h2]SocketTask.onOpen

SocketTask.onOpen(function callback)

监听WebSocket连接打开事件。

起始版本： 1.0.0

参数：

callback返回值：

错误码信息：

示例：

let socketTask = has.connectSocket({
  url: 'ws://www.example.com', // 此处仅为样例，请开发者更换为可用接口地址
  header: {
    'content-type': 'application/json'
  },
  protocols: ['protocol1'],
  method: 'GET',
  success: () => {
    console.info('on socketTask connect success callback receive');
  }
});
socketTask.onOpen((res) => {
  console.info('on socketTask open receive', res);
});

[h2]SocketTask.onClose

SocketTask.onClose(function callback)

监听WebSocket连接关闭事件。

起始版本： 1.0.0

参数：

callback返回值：

错误码信息：

示例：

let socketTask = has.connectSocket({
  url: 'ws://www.example.com', // 此处仅为样例，请开发者更换为可用接口地址
  header: {
    'content-type': 'application/json'
  },
  protocols: ['protocol1'],
  method: 'GET',
  success: () => {
    console.info('on socketTask connect success callback receive');
  }
});
socketTask.onClose((res) => {
  console.info('on socketTask close receive', res);
});

[h2]SocketTask.onError

SocketTask.onError(function callback)

监听WebSocket错误事件。

起始版本： 1.0.0

参数：

callback返回值：

错误码信息：

示例：

let socketTask = has.connectSocket({
  url: 'ws://www.example.com', // 此处仅为样例，请开发者更换为可用接口地址
  header: {
    'content-type': 'application/json'
  },
  protocols: ['protocol1'],
  method: 'GET',
  success: () => {
    console.info('on socketTask connect success callback receive');
  }
});
socketTask.onError((res) => {
  console.error('on socketTask error receive', res);
});

[h2]SocketTask.onMessage

SocketTask.onMessage(function callback)

监听WebSocket接收到服务器的消息事件。

起始版本： 1.0.0

参数：

callback返回值：

错误码信息：

示例：

let socketTask = has.connectSocket({
  url: 'ws://www.example.com', // 此处仅为样例，请开发者更换为可用接口地址
  header: {
    'content-type': 'application/json'
  },
  protocols: ['protocol1'],
  method: 'GET',
  success: () => {
    console.info('on socketTask connect success callback receive');
  }
});
socketTask.onMessage((res) => {
  console.debug('on socketTask message receive', res);
});