@ohos.net.socket (Socket连接)

本模块提供利用Socket进行数据传输的能力，支持TCPSocket、UDPSocket、WebSocket和TLSSocket。

说明：

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import socket from '@ohos.net.socket';

socket.constructUDPSocketInstance⁷⁺

constructUDPSocketInstance(): UDPSocket

创建一个UDPSocket对象。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
UDPSocket	返回一个UDPSocket对象。

示例：

import socket from '@ohos.net.socket';
let udp: socket.UDPSocket = socket.constructUDPSocketInstance();

UDPSocket⁷⁺

UDPSocket连接。在调用UDPSocket的方法前，需要先通过socket.constructUDPSocketInstance创建UDPSocket对象。

bind⁷⁺

bind(address: NetAddress, callback: AsyncCallback<void>): void

绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
address	NetAddress	是	目标地址信息，参考[NetAddress]。
callback	AsyncCallback<void>	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from '@ohos.net.socket';
import { BusinessError } from '@ohos.base';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 1234
}
udp.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

bind⁷⁺

bind(address: NetAddress): Promise<void>

绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
address	NetAddress	是	目标地址信息，参考[NetAddress]。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

返回值：

类型	说明
Promise<void>	以Promise形式异步返回UDPSocket绑定的结果。

示例：

import socket from '@ohos.net.socket';
import { BusinessError } from '@ohos.base';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
udp.bind(bindAddr).then(() => {
  console.log('bind success');
}).catch((err: BusinessError) => {
  console.log('bind fail');
});

send⁷⁺

send(options: UDPSendOptions, callback: AsyncCallback<void>): void

通过UDPSocket连接发送数据。使用callback方式作为异步方法。

发送数据前，需要先调用UDPSocket.bind()绑定IP地址和端口。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	UDPSendOptions	是	UDPSocket发送参数，参考UDPSendOptions。
callback	AsyncCallback<void>	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from '@ohos.net.socket';
import { BusinessError } from '@ohos.base';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();

let sendOptions: socket.UDPSendOptions = {
  data: 'Hello, server!',
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  }
}
udp.send(sendOptions, (err: BusinessError) => {
  if (err) {
    console.log('send fail');
    return;
  }
  console.log('send success');
});

send⁷⁺

send(options: UDPSendOptions): Promise<void>

通过UDPSocket连接发送数据。使用Promise方式作为异步方法。

发送数据前，需要先调用UDPSocket.bind()绑定IP地址和端口。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	UDPSendOptions	是	UDPSocket发送参数，参考UDPSendOptions。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

返回值：

类型	说明
Promise<void>	以Promise形式返回UDPSocket连接发送数据的结果。

示例：

import socket from '@ohos.net.socket';
import { BusinessError } from '@ohos.base';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();

let sendOptions: socket.UDPSendOptions = {
  data: 'Hello, server!',
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  }
}
udp.send(sendOptions).then(() => {
  console.log('send success');
}).catch((err: BusinessError) => {
  console.log('send fail');
});

close⁷⁺

close(callback: AsyncCallback<void>): void

关闭UDPSocket连接。使用callback方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。

示例：

import socket from '@ohos.net.socket';
import { BusinessError } from '@ohos.base';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
udp.close((err: BusinessError) => {
  if (err) {
    console.log('close fail');
    return;
  }
  console.log('close success');
})

close⁷⁺

close(): Promise<void>

关闭UDPSocket连接。使用Promise方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<void>	以Promise形式返回关闭UDPSocket连接的结果。

示例：

import socket from '@ohos.net.socket';
import { BusinessError } from '@ohos.base';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
udp.close().then(() => {
  console.log('close success');
}).catch((err: BusinessError) => {
  console.log('close fail');
});

getState⁷⁺

getState(callback: AsyncCallback<SocketStateBase>): void

获取UDPSocket状态。使用callback方式作为异步方法。

说明： bind方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<SocketStateBase>	是	回调函数。

错误码：

错误码ID	错误信息
201	Permission denied.

示例：

import socket from '@ohos.net.socket';
import { BusinessError } from '@ohos.base';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
udp.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  udp.getState((err: BusinessError, data: socket.SocketStateBase) => {
    if (err) {
      console.log('getState fail');
      return;
    }
    console.log('getState success:' + JSON.stringify(data));
  })
})

getState⁷⁺

getState(): Promise<SocketStateBase>

获取UDPSocket状态。使用Promise方式作为异步方法。

说明： bind方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<SocketStateBase>	以Promise形式返回获取UDPSocket状态的结果。

示例：

import socket from '@ohos.net.socket';
import { BusinessError } from '@ohos.base';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
udp.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  udp.getState().then((data: socket.SocketStateBase) => {
    console.log('getState success:' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.log('getState fail' + JSON.stringify(err));
  });
});

getSocketFd²⁴⁺

getSocketFd(): Promise<number>

获取UDPSocket的文件描述符。使用Promise异步回调。

说明：

• bind方法调用成功后，才可调用此方法。
• bind异常、Socket已关闭（如调用close后）等异常情况下调用本接口会返回-1。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
201	Permission denied.

返回值：

类型	说明
Promise<number>	Promise对象，返回Socket的文件描述符。

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
let bindAddr: socket.NetAddress = {
    address: '192.168.xx.xxx',
    port: 8080
}
udp.bind(bindAddr)
  .then(() => {
    udp.getSocketFd()
      .then((fd: number) => {
        console.info(`Socket FD：${fd}`);
      }).catch((err: BusinessError) => {
      console.error(`getSocketFd fail: ${err.message}, errorCode: ${err.code}`);
    });
  }).catch((err: BusinessError) => {
  console.error('bind fail');
});

setExtraOptions⁷⁺

setExtraOptions(options: UDPExtraOptions, callback: AsyncCallback<void>): void

设置UDPSocket连接的其他属性。使用callback方式作为异步方法。

说明： bind方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	UDPExtraOptions	是	UDPSocket连接的其他属性，参考UDPExtraOptions。
callback	AsyncCallback<void>	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from '@ohos.net.socket';
import { BusinessError } from '@ohos.base';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();

let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
udp.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  let udpextraoptions: socket.UDPExtraOptions = {
    receiveBufferSize: 1000,
    sendBufferSize: 1000,
    reuseAddress: false,
    socketTimeout: 6000,
    broadcast: true
  }
  udp.setExtraOptions(udpextraoptions, (err: BusinessError) => {
    if (err) {
      console.log('setExtraOptions fail');
      return;
    }
    console.log('setExtraOptions success');
  })
})

setExtraOptions⁷⁺

setExtraOptions(options: UDPExtraOptions): Promise<void>

设置UDPSocket连接的其他属性。使用Promise方式作为异步方法。

说明： bind方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	UDPExtraOptions	是	UDPSocket连接的其他属性，参考UDPExtraOptions。

返回值：

类型	说明
Promise<void>	以Promise形式返回设置UDPSocket连接的其他属性的结果。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from '@ohos.net.socket';
import { BusinessError } from '@ohos.base';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();

let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
udp.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  let udpextraoptions: socket.UDPExtraOptions = {
    receiveBufferSize: 1000,
    sendBufferSize: 1000,
    reuseAddress: false,
    socketTimeout: 6000,
    broadcast: true
  }
  udp.setExtraOptions(udpextraoptions).then(() => {
    console.log('setExtraOptions success');
  }).catch((err: BusinessError) => {
    console.log('setExtraOptions fail');
  });
})

getLocalAddress²⁴⁺

getLocalAddress(): Promise<NetAddress>

获取UDP连接的本地Socket地址。使用Promise异步回调。

说明： bind方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取本地socket地址的结果。

错误码：

以下错误码的详细介绍请参见Socket错误码。

错误码ID	错误信息
2300002	System internal error.
2301009	Bad file descriptor.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let udp: socket.UDPSocket = socket.constructUDPSocketInstance();

let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
udp.bind(bindAddr).then(() => {
  console.info('bind success');
  udp.getLocalAddress().then((localAddress: socket.NetAddress) => {
        console.info("UDP_Socket get SUCCESS! Address：" + JSON.stringify(localAddress));
      }).catch((err: BusinessError) => {
        console.error("UDP_Socket get FAILED! Error: " + JSON.stringify(err));
      })
}).catch((err: BusinessError) => {
  console.error('bind fail');
});

on('message')⁷⁺

on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void

订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'message'：接收消息事件。
callback	Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>	是	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let udp: socket.UDPSocket = socket.constructUDPSocketInstance();

class SocketInfo {
  message: ArrayBuffer = new ArrayBuffer(1);
  remoteInfo: socket.SocketRemoteInfo = {} as socket.SocketRemoteInfo;
}
let messageView = '';
udp.on('message', (value: SocketInfo) => {
  for (let i: number = 0; i < value.message.byteLength; i++) {
    let messages: number = value.message[i]
    let message = String.fromCharCode(messages);
    messageView += message;
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
});

off('message')⁷⁺

off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void

取消订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'message'：接收消息事件。
callback	Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>	否	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
class SocketInfo {
  message: ArrayBuffer = new ArrayBuffer(1);
  remoteInfo: socket.SocketRemoteInfo = {} as socket.SocketRemoteInfo;
}
let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
let messageView = '';
let callback = (value: SocketInfo) => {
  for (let i: number = 0; i < value.message.byteLength; i++) {
    let messages: number = value.message[i]
    let message = String.fromCharCode(messages);
    messageView += message;
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
}
udp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('message', callback);
udp.off('message');

on('listening' | 'close')⁷⁺

on(type: 'listening' | 'close', callback: Callback<void>): void

订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。 - 'listening'：数据包消息事件。 - 'close'：关闭事件。
callback	Callback<void>	是	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
udp.on('listening', () => {
  console.log("on listening success");
});
udp.on('close', () => {
  console.log("on close success");
});

off('listening' | 'close')⁷⁺

off(type: 'listening' | 'close', callback?: Callback<void>): void

取消订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅事件类型。 - 'listening'：数据包消息事件。 - 'close'：关闭事件。
callback	Callback<void>	否	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
let callback1 = () => {
  console.log("on listening, success");
}
udp.on('listening', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('listening', callback1);
udp.off('listening');
let callback2 = () => {
  console.log("on close, success");
}
udp.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('close', callback2);
udp.off('close');

on('error')⁷⁺

on(type: 'error', callback: ErrorCallback): void

订阅UDPSocket连接的error事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	是	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
udp.on('error', (err: BusinessError) => {
  console.log("on error, err:" + JSON.stringify(err))
});

off('error')⁷⁺

off(type: 'error', callback?: ErrorCallback): void

取消订阅UDPSocket连接的error事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	否	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
let callback = (err: BusinessError) => {
  console.log("on error, err:" + JSON.stringify(err));
}
udp.on('error', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('error', callback);
udp.off('error');

NetAddress²⁴⁺

目标地址信息。

系统能力：SystemCapability.Communication.NetStack

名称	类型	必填	说明	Android 平台	iOS 平台
address	string	是	本地绑定的ip地址。	支持	支持
port	number	否	端口号 ，范围0~65535。如果不指定系统随机分配端口。	支持	支持
family	number	否	网络协议类型，可选类型： - 1：IPv4 - 2：IPv6 默认为1。	支持	支持

UDPSendOptions⁷⁺

UDPSocket发送参数。

系统能力：SystemCapability.Communication.NetStack

名称	类型	必填	说明	Android 平台	iOS 平台
data	string | ArrayBuffer7+	是	发送的数据。	支持	支持
address	NetAddress	是	目标地址信息。	支持	支持

UDPExtraOptions⁷⁺

UDPSocket连接的其他属性。

系统能力：SystemCapability.Communication.NetStack

名称	类型	必填	说明	Android 平台	iOS 平台
broadcast	boolean	否	是否可以发送广播。默认为false。	支持	支持
receiveBufferSize	number	否	接收缓冲区大小（单位：Byte），默认为0。	支持	支持
sendBufferSize	number	否	发送缓冲区大小（单位：Byte），默认为0。	支持	支持
reuseAddress	boolean	否	是否重用地址。默认为false。	支持	支持
socketTimeout	number	否	套接字超时时间，单位毫秒（ms），默认为0。	支持	支持

SocketStateBase⁷⁺

Socket的状态信息。

系统能力：SystemCapability.Communication.NetStack

名称	类型	必填	说明	Android 平台	iOS 平台
isBound	boolean	是	是否绑定。	支持	支持
isClose	boolean	是	是否关闭。	支持	支持
isConnected	boolean	是	是否连接。	支持	支持

SocketRemoteInfo⁷⁺

Socket的连接信息。

系统能力：SystemCapability.Communication.NetStack

名称	类型	必填	说明	Android 平台	iOS 平台
address	string	是	本地绑定的ip地址。	支持	支持
family	string	是	网络协议类型，可选类型： - IPv4 - IPv6 默认为IPv4。	支持	支持
port	number	是	端口号，范围0~65535。	支持	支持
size	number	是	服务器响应信息的字节长度。	支持	支持

UDP 错误码说明

UDP 其余错误码映射形式为：2301000 + Linux内核错误码。

错误码的详细介绍参见Socket错误码

MulticastSocket11+

MulticastSocket连接。在调用MulticastSocket的方法前，需要先通过socket.constructMulticastSocketInstance创建MulticastSocket对象。

getSocketFd²⁴⁺

getSocketFd(): Promise<number>

MulticastSocket的文件描述符。使用Promise异步回调。

说明：

• bind方法调用成功后，才可调用此方法。
• bind异常、Socket已关闭（如调用close后）等异常情况下调用本接口会返回-1。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
201	Permission denied.

返回值：

类型	说明
Promise<number>	Promise对象，返回Socket的文件描述符。

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let multicast: socket.MulticastSocket = socket.constructMulticastSocketInstance();
let bindAddr: socket.NetAddress = {
    address: '192.168.xx.xxx',
    port: 8080
}
multicast.bind(bindAddr)
  .then(() => {
    console.info('bind success');
    multicast.getSocketFd().then((fd: number) => {
      console.info(`Socket FD：${fd}`);
    }).catch((err: BusinessError) => {
      console.error(`getSocketFd fail: ${err.message}, errorCode: ${err.code}`);
    });
  }).catch((err: BusinessError) => {
  console.error('bind fail');
});

socket.constructTCPSocketInstance⁷⁺

constructTCPSocketInstance(): TCPSocket

创建一个TCPSocket对象。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
TCPSocket	返回一个TCPSocket对象。

示例：

import socket from "@ohos.net.socket";
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

TCPSocket⁷⁺

TCPSocket连接。在调用TCPSocket的方法前，需要先通过socket.constructTCPSocketInstance创建TCPSocket对象。

bind⁷⁺

bind(address: NetAddress, callback: AsyncCallback<void>): void

绑定IP地址和端口，端口可以指定为0由系统随机分配或指定为其它非0端口。使用callback方法作为异步方法。

说明： bind方法如果因为端口冲突而执行失败，则会由系统随机分配端口号。 TCP客户端可先调用该接口(tcp.bind)显式绑定IP地址和端口号，再调用tcp.connect完成与服务端的连接；也可直接调用tcp.connect由系统自动绑定IP地址和端口号，完成与服务端的连接。 bind的IP为'localhost'或'127.0.0.1'时，只允许本地回环接口的连接，即服务端和客户端运行在同一台机器上。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
address	NetAddress	是	目标地址信息，参考NetAddress。
callback	AsyncCallback<void>	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
tcp.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
})

bind⁷⁺

bind(address: NetAddress): Promise<void>

绑定IP地址和端口，端口可以指定为0由系统随机分配或指定为其它非0端口。使用Promise方法作为异步方法。

说明： bind方法如果因为端口冲突而执行失败，则会由系统随机分配端口号。 TCP客户端可先调用该接口(tcp.bind)显式绑定IP地址和端口号，再调用tcp.connect完成与服务端的连接；也可直接调用tcp.connect由系统自动绑定IP地址和端口号，完成与服务端的连接。 bind的IP为'localhost'或'127.0.0.1'时，只允许本地回环接口的连接，即服务端和客户端运行在同一台机器上。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
address	NetAddress	是	目标地址信息，参考NetAddress。

返回值：

类型	说明
Promise<void>	以Promise形式返回TCPSocket绑定本机的IP地址和端口的结果。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
tcp.bind(bindAddr).then(() => {
  console.log('bind success');
}).catch((err: BusinessError) => {
  console.log('bind fail');
});

connect⁷⁺

connect(options: TCPConnectOptions, callback: AsyncCallback<void>): void

连接到指定的IP地址和端口。使用callback方法作为异步方法。

说明： 在没有执行tcp.bind的情况下，也可以直接调用该接口完成与TCP服务端的连接

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPConnectOptions	是	TCPSocket连接的参数，参考TCPConnectOptions。
callback	AsyncCallback<void>	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

let tcpconnectoptions: socket.TCPConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  timeout: 6000
}
tcp.connect(tcpconnectoptions, (err: BusinessError) => {
  if (err) {
    console.log('connect fail');
    return;
  }
  console.log('connect success');
})

connect⁷⁺

connect(options: TCPConnectOptions): Promise<void>

连接到指定的IP地址和端口。使用promise方法作为异步方法。

说明： 在没有执行tcp.bind的情况下，也可以直接调用该接口完成与TCP服务端的连接。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPConnectOptions	是	TCPSocket连接的参数，参考TCPConnectOptions。

返回值：

类型	说明
Promise<void>	以Promise形式返回TCPSocket连接到指定的IP地址和端口的结果。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

let tcpconnectoptions: socket.TCPConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  timeout: 6000
}
tcp.connect(tcpconnectoptions).then(() => {
  console.log('connect success')
}).catch((err: BusinessError) => {
  console.log('connect fail');
});

send⁷⁺

send(options: TCPSendOptions, callback: AsyncCallback<void>): void

通过TCPSocket连接发送数据。使用callback方式作为异步方法。

说明： connect方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPSendOptions	是	TCPSocket发送请求的参数，参考TCPSendOptions。
callback	AsyncCallback<void>	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

let tcpconnectoptions: socket.TCPConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  timeout: 6000
}
tcp.connect(tcpconnectoptions, () => {
  console.log('connect success');
  let tcpSendOptions: socket.TCPSendOptions = {
    data: 'Hello, server!'
  }
  tcp.send(tcpSendOptions, (err: BusinessError) => {
    if (err) {
      console.log('send fail');
      return;
    }
    console.log('send success');
  })
})

send⁷⁺

send(options: TCPSendOptions): Promise<void>

通过TCPSocket连接发送数据。使用Promise方式作为异步方法。

说明： connect方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPSendOptions	是	TCPSocket发送请求的参数，参考TCPSendOptions。

返回值：

类型	说明
Promise<void>	以Promise形式返回通过TCPSocket连接发送数据的结果。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

let tcpconnectoptions: socket.TCPConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  timeout: 6000
}
tcp.connect(tcpconnectoptions, () => {
  console.log('connect success');
  let tcpSendOptions: socket.TCPSendOptions = {
    data: 'Hello, server!'
  }
  tcp.send(tcpSendOptions).then(() => {
    console.log('send success');
  }).catch((err: BusinessError) => {
    console.log('send fail');
  });
})

close⁷⁺

close(callback: AsyncCallback<void>): void

关闭TCPSocket连接。使用callback方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。

错误码：

错误码ID	错误信息
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

tcp.close((err: BusinessError) => {
  if (err) {
    console.log('close fail');
    return;
  }
  console.log('close success');
})

close⁷⁺

close(): Promise<void>

关闭TCPSocket连接。使用Promise方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<void>	以Promise形式返回关闭TCPSocket连接的结果。

错误码：

错误码ID	错误信息
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

tcp.close().then(() => {
  console.log('close success');
}).catch((err: BusinessError) => {
  console.log('close fail');
});

getRemoteAddress⁷⁺

getRemoteAddress(callback: AsyncCallback<NetAddress>): void

获取对端Socket地址。使用callback方式作为异步方法。

说明： connect方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<NetAddress>	是	回调函数。

错误码：

错误码ID	错误信息
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

let tcpconnectoptions: socket.TCPConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  timeout: 6000
}
tcp.connect(tcpconnectoptions, () => {
  console.log('connect success');
  tcp.getRemoteAddress((err: BusinessError, data: socket.NetAddress) => {
    if (err) {
      console.log('getRemoteAddressfail');
      return;
    }
    console.log('getRemoteAddresssuccess:' + JSON.stringify(data));
  })
});

getRemoteAddress⁷⁺

getRemoteAddress(): Promise<NetAddress>

获取对端Socket地址。使用Promise方式作为异步方法。

说明： connect方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取对端socket地址的结果。

错误码：

错误码ID	错误信息
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

let tcpconnectoptions: socket.TCPConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  timeout: 6000
}
tcp.connect(tcpconnectoptions).then(() => {
  console.log('connect success');
  tcp.getRemoteAddress().then(() => {
    console.log('getRemoteAddress success');
  }).catch((err: BusinessError) => {
    console.log('getRemoteAddressfail');
  });
}).catch((err: BusinessError) => {
  console.log('connect fail');
});

getState⁷⁺

getState(callback: AsyncCallback<SocketStateBase>): void

获取TCPSocket状态。使用callback方式作为异步方法。

说明： bind或connect方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<SocketStateBase>	是	回调函数。

错误码：

错误码ID	错误信息
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

let tcpconnectoptions: socket.TCPConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  timeout: 6000
}
tcp.connect(tcpconnectoptions, () => {
  console.log('connect success');
  tcp.getState((err: BusinessError, data: socket.SocketStateBase) => {
    if (err) {
      console.log('getState fail');
      return;
    }
    console.log('getState success:' + JSON.stringify(data));
  });
});

getState⁷⁺

getState(): Promise<SocketStateBase>

获取TCPSocket状态。使用Promise方式作为异步方法。

说明： bind或connect方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<SocketStateBase>	以Promise形式返回获取TCPSocket状态的结果。

错误码：

错误码ID	错误信息
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();

let tcpconnectoptions: socket.TCPConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  timeout: 6000
}
tcp.connect(tcpconnectoptions).then(() => {
  console.log('connect success');
  tcp.getState().then(() => {
    console.log('getState success');
  }).catch((err: BusinessError) => {
    console.log('getState fail');
  });
}).catch((err: BusinessError) => {
  console.log('connect fail');
});

getSocketFd²⁴⁺

getSocketFd(callback: AsyncCallback<number>): void

获取TCPSocket的文件描述符。使用callback方式作为异步方法。

说明：

• bind或connect方法调用成功后，才可调用此方法。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调函数，当成功时，返回socket的文件描述符，失败时，返回undefined。

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  // 绑定指定网络接口
}
tcp.bind(bindAddr)
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tcpconnectoptions: socket.TCPConnectOptions = {
  address: netAddress,
  timeout: 6000
}
tcp.connect(tcpconnectoptions)
tcp.getSocketFd((err: BusinessError, data: number) => {
  console.error("getSocketFd failed: " + err);
  console.info("socketFd: " + data);
})

getSocketFd²⁴⁺

getSocketFd(): Promise<number>

获取TCPSocket的文件描述符。使用Promise方式作为异步方法。

说明：

• bind或connect方法调用成功后，才可调用此方法。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<number>	以Promise形式返回socket的文件描述符。

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let bindAddr: socket.NetAddress = {
    address: '192.168.xx.xxx',
  // 绑定指定网络接口
}
tcp.bind(bindAddr)
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tcpconnectoptions: socket.TCPConnectOptions = {
  address: netAddress,
  timeout: 6000
}
tcp.connect(tcpconnectoptions)
tcp.getSocketFd().then((data: number) => {
  console.info("socketFd: " + data);
})

setExtraOptions⁷⁺

setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback<void>): void

设置TCPSocket连接的其他属性。使用callback方式作为异步方法。

说明： bind或connect方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPExtraOptions	是	TCPSocket连接的其他属性，参考TCPExtraOptions。
callback	AsyncCallback<void>	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let tcpconnectoptions: socket.TCPConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  timeout: 6000
}
tcp.connect(tcpconnectoptions, () => {
  console.log('connect success');
  let tcpExtraOptions: socket.TCPExtraOptions = {
    keepAlive: true,
    OOBInline: true,
    TCPNoDelay: true,
    socketLinger: { on: true, linger: 10 },
    receiveBufferSize: 1000,
    sendBufferSize: 1000,
    reuseAddress: true,
    socketTimeout: 3000
  }
  tcp.setExtraOptions(tcpExtraOptions, (err: BusinessError) => {
    if (err) {
      console.log('setExtraOptions fail');
      return;
    }
    console.log('setExtraOptions success');
  });
});

setExtraOptions⁷⁺

setExtraOptions(options: TCPExtraOptions): Promise<void>

设置TCPSocket连接的其他属性，使用Promise方式作为异步方法。

说明： bind或connect方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPExtraOptions	是	TCPSocket连接的其他属性，参考TCPExtraOptions。

返回值：

类型	说明
Promise<void>	以Promise形式返回设置TCPSocket连接的其他属性的结果。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let tcpconnectoptions: socket.TCPConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  timeout: 6000
}
tcp.connect(tcpconnectoptions, () => {
  console.log('connect success');
  let tcpExtraOptions: socket.TCPExtraOptions = {
    keepAlive: true,
    OOBInline: true,
    TCPNoDelay: true,
    socketLinger: { on: true, linger: 10 },
    receiveBufferSize: 1000,
    sendBufferSize: 1000,
    reuseAddress: true,
    socketTimeout: 3000
  }
  tcp.setExtraOptions(tcpExtraOptions).then(() => {
    console.log('setExtraOptions success');
  }).catch((err: BusinessError) => {
    console.log('setExtraOptions fail');
  });
});

getLocalAddress²⁴⁺

getLocalAddress(): Promise<NetAddress>

获取TCPSocket的本地Socket地址。使用Promise异步回调。

说明： bind方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取本地socket地址的结果。

错误码：

以下错误码的详细介绍请参见Socket错误码。

错误码ID	错误信息
2300002	System internal error.
2301009	Bad file descriptor.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  family: 1,
  port: 8080
}
tcp.bind(bindAddr).then(() => {
  tcp.getLocalAddress().then((localAddress: socket.NetAddress) => {
    console.info("SUCCESS! Address:" + JSON.stringify(localAddress));
  }).catch((err: BusinessError) => {
    console.error("FAILED! Error:" + JSON.stringify(err));
  })
}).catch((err: BusinessError) => {
  console.error('bind fail');
});

on('message')⁷⁺

on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void

订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'message'：接收消息事件。
callback	Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>	是	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
class SocketInfo {
  message: ArrayBuffer = new ArrayBuffer(1);
  remoteInfo: socket.SocketRemoteInfo = {} as socket.SocketRemoteInfo;
}
let messageView = '';
tcp.on('message', (value: SocketInfo) => {
  for (let i: number = 0; i < value.message.byteLength; i++) {
    let messages: number = value.message[i]
    let message = String.fromCharCode(messages);
    messageView += message;
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
});

off('message')⁷⁺

off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void

取消订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'message'：接收消息事件。
callback	Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>	否	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
class SocketInfo {
  message: ArrayBuffer = new ArrayBuffer(1);
  remoteInfo: socket.SocketRemoteInfo = {} as socket.SocketRemoteInfo;
}
let messageView = '';
let callback = (value: SocketInfo) => {
  for (let i: number = 0; i < value.message.byteLength; i++) {
    let messages: number = value.message[i]
    let message = String.fromCharCode(messages);
    messageView += message;
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
}
tcp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('message', callback);
tcp.off('message');

on('connect' | 'close')⁷⁺

on(type: 'connect' | 'close', callback: Callback<void>): void

订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。 - 'connect'：连接事件。 - 'close'：关闭事件。
callback	Callback<void>	是	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
tcp.on('connect', () => {
  console.log("on connect success")
});
tcp.on('close', () => {
  console.log("on close success")
});

off('connect' | 'close')⁷⁺

off(type: 'connect' | 'close', callback?: Callback<void>): void

取消订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。 - 'connect'：连接事件。 - 'close'：关闭事件。
callback	Callback<void>	否	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let callback1 = () => {
  console.log("on connect success");
}
tcp.on('connect', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('connect', callback1);
tcp.off('connect');
let callback2 = () => {
  console.log("on close success");
}
tcp.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('close', callback2);
tcp.off('close');

on('error')⁷⁺

on(type: 'error', callback: ErrorCallback): void

订阅TCPSocket连接的error事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	是	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
tcp.on('error', (err: BusinessError) => {
  console.log("on error, err:" + JSON.stringify(err))
});

off('error')⁷⁺

off(type: 'error', callback?: ErrorCallback): void

取消订阅TCPSocket连接的error事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	否	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let callback = (err: BusinessError) => {
  console.log("on error, err:" + JSON.stringify(err));
}
tcp.on('error', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('error', callback);
tcp.off('error');

TCPConnectOptions⁷⁺

TCPSocket连接的参数。

系统能力：SystemCapability.Communication.NetStack

名称	类型	必填	说明	Android 平台	iOS 平台
address	NetAddress	是	绑定的地址以及端口。	支持	支持
timeout	number	否	超时时间，单位毫秒（ms）。	支持	支持

TCPSendOptions⁷⁺

TCPSocket发送请求的参数。

系统能力：SystemCapability.Communication.NetStack

名称	类型	必填	说明	Android 平台	iOS 平台
data	string| ArrayBuffer7+	是	发送的数据。	支持	支持
encoding	string	否	字符编码(UTF-8，UTF-16BE，UTF-16LE，UTF-16，US-AECII，ISO-8859-1)，默认为UTF-8。	支持	支持

TCPExtraOptions⁷⁺

TCPSocket连接的其他属性。

系统能力：SystemCapability.Communication.NetStack

名称	类型	必填	说明	Android 平台	iOS 平台
keepAlive	boolean	否	是否保持连接。默认为false。	支持	支持
OOBInline	boolean	否	是否为OOB内联。默认为false。	支持	支持
TCPNoDelay	boolean	否	TCPSocket连接是否无时延。默认为false。	支持	支持
socketLinger	Object	是	socket是否继续逗留。 - on：是否逗留（true：逗留；false：不逗留）。 - linger：逗留时长，单位毫秒（ms），取值范围为0~65535。 当入参on设置为true时，才需要设置。	支持	支持
receiveBufferSize	number	否	接收缓冲区大小（单位：Byte），默认为0。	支持	支持
sendBufferSize	number	否	发送缓冲区大小（单位：Byte），默认为0。	支持	支持
reuseAddress	boolean	否	是否重用地址。默认为false。	支持	支持
socketTimeout	number	否	套接字超时时间，单位毫秒（ms），默认为0。	支持	支持

socket.constructTCPSocketServerInstance²⁴⁺

constructTCPSocketServerInstance(): TCPSocketServer

创建一个TCPSocketServer对象。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
TCPSocketServer	返回一个TCPSocketServer对象。

示例：

import socket from "@ohos.net.socket";
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();

TCPSocketServer²⁴⁺

TCPSocketServer连接。在调用TCPSocketServer的方法前，需要先通过socket.constructTCPSocketServerInstance创建TCPSocketServer对象。

listen²⁴⁺

listen(address: NetAddress, callback: AsyncCallback<void>): void

绑定IP地址和端口，端口可以指定或由系统随机分配。监听并接受与此套接字建立的TCPSocket连接。该接口使用多线程并发处理客户端的数据。使用callback异步回调。

说明： 服务端使用该方法完成bind，listen，accept操作，bind方法失败会由系统随机分配端口号。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
address	NetAddress	是	目标地址信息。
callback	AsyncCallback<void>	是	回调函数。回调函数。失败时返回错误码、错误信息。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.
2303109	Bad file number.
2303111	Resource temporarily unavailable try again.
2303198	Address already in use.
2303199	Cannot assign requested address.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address:  '192.168.xx.xxx',
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr, (err: BusinessError) => {
  if (err) {
    console.error("listen fail");
    return;
  }
  console.info("listen success");
})

listen²⁴⁺

listen(address: NetAddress): Promise<void>

绑定IP地址和端口，端口可以指定或由系统随机分配。监听并接受与此套接字建立的TCPSocket连接。该接口使用多线程并发处理客户端的数据。使用Promise异步回调。

说明： 服务端使用该方法完成bind，listen，accept操作，bind方法失败会由系统随机分配端口号。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
address	NetAddress	是	目标地址信息。

返回值：

类型	说明
Promise<void>	以Promise形式返回, 成功返回空，失败返回错误码错误信息。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.
2303109	Bad file number.
2303111	Resource temporarily unavailable try again.
2303198	Address already in use.
2303199	Cannot assign requested address.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address:  '192.168.xx.xxx',
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr).then(() => {
  console.info('listen success');
}).catch((err: BusinessError) => {
  console.error('listen fail');
});

getState²⁴⁺

getState(callback: AsyncCallback<SocketStateBase>): void

获取TCPSocketServer状态。使用callback异步回调。

说明： listen方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<SocketStateBase>	是	回调函数。失败时返回错误码、错误信息。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address:  '192.168.xx.xxx',
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr, (err: BusinessError) => {
  if (err) {
    console.error("listen fail");
    return;
  }
  console.info("listen success");
})
tcpServer.getState((err: BusinessError, data: socket.SocketStateBase) => {
  if (err) {
    console.error('getState fail');
    return;
  }
  console.info('getState success:' + JSON.stringify(data));
})

getState²⁴⁺

getState(): Promise<SocketStateBase>

获取TCPSocketServer状态。使用Promise异步回调。

说明： listen方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<SocketStateBase>	以Promise形式返回获取TCPSocket状态的结果。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
201	Permission denied.
2300002	System internal error.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address:  '192.168.xx.xxx',
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr, (err: BusinessError) => {
  if (err) {
    console.error("listen fail");
    return;
  }
  console.info("listen success");
})
tcpServer.getState().then((data: socket.SocketStateBase) => {
  console.info('getState success' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('getState fail');
});

getSocketFd²⁴⁺

getSocketFd(): Promise<number>

获取TCPSocketServer监听端口绑定的文件描述符。使用Promise异步回调。

说明：

• listen方法调用成功后，才可调用此方法。多次调用listen时，会获取最新监听端口绑定的文件描述符。
• 监听异常、Socket已关闭（如调用close后）等异常情况下调用本接口会返回-1。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
201	Permission denied.

返回值：

类型	说明
Promise<number>	Promise对象，返回Socket的文件描述符。

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address:  '192.168.xx.xxx',
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr).then(() => {
  console.info('listen success');
  tcpServer.getSocketFd().then((fd: number) => {
    console.info(`Socket FD：${fd}`);
  }).catch((err: BusinessError) => {
    console.error(`getSocketFd fail: ${err.message}, errorCode: ${err.code}`);
  });
}).catch((err: BusinessError) => {
  console.error('listen fail');
});

setExtraOptions²⁴⁺

setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback<void>): void

设置TCPSocketServer连接的其他属性。使用callback异步回调。

说明： listen方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPExtraOptions	是	TCPSocketServer连接的其他属性。
callback	AsyncCallback<void>	是	回调函数。失败时返回错误码、错误信息。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address:  '192.168.xx.xxx',
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr, (err: BusinessError) => {
  if (err) {
    console.error("listen fail");
    return;
  }
  console.info("listen success");
})

interface SocketLinger {
  on: boolean;
  linger: number;
}

let tcpExtraOptions: socket.TCPExtraOptions = {
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on: true, linger: 10 } as SocketLinger,
  receiveBufferSize: 8192,
  sendBufferSize: 8192,
  reuseAddress: true,
  socketTimeout: 3000
}
tcpServer.setExtraOptions(tcpExtraOptions, (err: BusinessError) => {
  if (err) {
    console.error('setExtraOptions fail');
    return;
  }
  console.info('setExtraOptions success');
});

setExtraOptions²⁴⁺

setExtraOptions(options: TCPExtraOptions): Promise<void>

设置TCPSocketServer连接的其他属性。使用Promise异步回调。

说明： listen方法调用成功后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPExtraOptions	是	TCPSocketServer连接的其他属性。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address:  '192.168.xx.xxx',
  port: 8080,
  family: 1
}

interface SocketLinger {
  on: boolean;
  linger: number;
}

tcpServer.listen(listenAddr, (err: BusinessError) => {
  if (err) {
    console.error("listen fail");
    return;
  }
  console.info("listen success");
})

let tcpExtraOptions: socket.TCPExtraOptions = {
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on: true, linger: 10 } as SocketLinger,
  receiveBufferSize: 8192,
  sendBufferSize: 8192,
  reuseAddress: true,
  socketTimeout: 3000
}
tcpServer.setExtraOptions(tcpExtraOptions).then(() => {
  console.info('setExtraOptions success');
}).catch((err: BusinessError) => {
  console.error('setExtraOptions fail');
});

getLocalAddress²⁴⁺

getLocalAddress(): Promise<NetAddress>

获取TCPSocketServer的本地Socket地址。使用Promise异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取本地socket地址的结果。

错误码：

以下错误码的详细介绍请参见Socket错误码。

错误码ID	错误信息
2300002	System internal error.
2301009	Bad file descriptor.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr).then(() => {
  tcpServer.getLocalAddress().then((localAddress: socket.NetAddress) => {
    console.info("SUCCESS! Address:" + JSON.stringify(localAddress));
  }).catch((err: BusinessError) => {
    console.error("FerrorAILED! Error:" + JSON.stringify(err));
  })
}).catch((err: BusinessError) => {
  console.error('listen fail');
});

on('connect')²⁴⁺

on(type: 'connect', callback: Callback<TCPSocketConnection>): void

订阅TCPSocketServer的连接事件。使用callback异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'connect'：连接事件。
callback	Callback<TCPSocketConnection>	是	回调函数。失败时返回错误码、错误信息。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
401	Parameter error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();

let listenAddr: socket.NetAddress = {
  address:  '192.168.xx.xxx',
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr, (err: BusinessError) => {
  if (err) {
    console.error("listen fail");
    return;
  }
  console.info("listen success");
  tcpServer.on('connect', (data: socket.TCPSocketConnection) => {
    console.info(JSON.stringify(data))
  });
})

off('connect')²⁴⁺

off(type: 'connect', callback?: Callback<TCPSocketConnection>): void

取消订阅TCPSocketServer的连接事件。使用callback异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'connect'：连接事件。
callback	Callback<TCPSocketConnection>	否	回调函数。可以指定传入on中的callback取消对应的订阅，也可以不指定callback清空所有订阅。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
401	Parameter error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();

let listenAddr: socket.NetAddress = {
  address:  '192.168.xx.xxx',
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr, (err: BusinessError) => {
  if (err) {
    console.error("listen fail");
    return;
  }
  console.info("listen success");
  let callback = (data: socket.TCPSocketConnection) => {
    console.info('on connect message: ' + JSON.stringify(data));
  }
  tcpServer.on('connect', callback);
  // 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
  tcpServer.off('connect', callback);
  tcpServer.off('connect');
})

on('error')¹⁰⁺

on(type: 'error', callback: ErrorCallback): void

订阅TCPSocketServer连接的error事件。使用callback方式作为异步方法。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('error', (err: BusinessError) => {
  console.log("on error, err:" + JSON.stringify(err))
});

off('error')¹⁰⁺

off(type: 'error', callback?: ErrorCallback): void

取消订阅TCPSocketServer连接的error事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	否	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let callback = (err: BusinessError) => {
  console.log("on error, err:" + JSON.stringify(err));
}
tcpServer.on('error', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcpServer.off('error', callback);
tcpServer.off('error');

close²⁴⁺

close(): Promise<void>

TCPSocketServer停止监听并释放通过listen方法绑定的端口。若多次调用listen方法，再调用此方法时会释放TCPSocketServer的所有监听端口。使用Promise异步回调。

说明： 该方法不会关闭已有连接。如需关闭，请调用TCPSocketConnection的close方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
201	Permission denied.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080,
  family: 1
}
tcpServer.on('connect', (connection: socket.TCPSocketConnection) => {
  console.info("connection clientId: " + connection.clientId);
  // 逻辑处理
  tcpServer.close(); // 停止监听
  connection.close(); // 关闭当前连接
});
tcpServer.listen(listenAddr).then(() => {
  console.info('listen success');
}).catch((err: BusinessError) => {
  console.error('listen fail: ' + err.code);
});

TCPSocketConnection²⁴⁺

TCPSocketConnection连接，即TCPSocket客户端与服务端的连接。在调用TCPSocketConnection的方法前，需要先获取TCPSocketConnection对象。

说明： 客户端与服务端成功建立连接后，才能通过返回的TCPSocketConnection对象调用相应的接口。

系统能力：SystemCapability.Communication.NetStack

属性

名称	类型	必填	说明	Android 平台	iOS 平台
clientId24+	number	是	客户端与TCPSocketServer建立连接的id。	支持	支持

send²⁴⁺

send(options: TCPSendOptions, callback: AsyncCallback<void>): void

通过TCPSocketConnection连接发送数据。使用callback方式作为异步方法。

说明： 与客户端建立连接后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPSendOptions	是	TCPSocketConnection发送请求的参数。
callback	AsyncCallback<void>	是	回调函数。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();

tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  let tcpSendOption: socket.TCPSendOptions = {
    data: 'Hello, client!'
  }
  client.send(tcpSendOption, () => {
    console.info('send success');
  });
});

send²⁴⁺

send(options: TCPSendOptions): Promise<void>

通过TCPSocketConnection连接发送数据。使用Promise方式作为异步方法。

说明： 与客户端建立连接后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPSendOptions	是	TCPSocketConnection发送请求的参数。

返回值：

类型	说明
Promise<void>	以Promise形式返回，成功返回空，失败返回错误码错误信息。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();

tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  let tcpSendOption: socket.TCPSendOptions = {
    data: 'Hello, client!'
  }
  client.send(tcpSendOption).then(() => {
    console.info('send success');
  }).catch((err: BusinessError) => {
    console.error('send fail');
  });
});

close²⁴⁺

close(callback: AsyncCallback<void>): void

关闭一个与TCPSocket建立的连接。使用callback异步回调。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();

tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  client.close((err: BusinessError) => {
    if (err) {
      console.error('close fail');
      return;
    }
    console.info('close success');
  });
});

close²⁴⁺

close(): Promise<void>

关闭一个与TCPSocket建立的连接。使用Promise异步回调。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<void>	以Promise形式返回，成功返回空，失败返回错误码错误信息。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
201	Permission denied.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  client.close().then(() => {
    console.info('close success');
  }).catch((err: BusinessError) => {
    console.error('close fail');
  });
});

getRemoteAddress²⁴⁺

getRemoteAddress(callback: AsyncCallback<NetAddress>): void

获取对端Socket地址。使用callback异步回调。

说明： 与客户端建立连接后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<NetAddress>	是	回调函数。失败时返回错误码、错误信息。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  client.getRemoteAddress((err: BusinessError, data: socket.NetAddress) => {
    if (err) {
      console.error('getRemoteAddress fail');
      return;
    }
    console.info('getRemoteAddress success:' + JSON.stringify(data));
  });
});

getRemoteAddress²⁴⁺

getRemoteAddress(): Promise<NetAddress>

获取对端Socket地址。使用Promise异步回调。

说明： 与客户端建立连接后，才可调用此方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取对端socket地址的结果。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
201	Permission denied.
2300002	System internal error.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  client.getRemoteAddress().then(() => {
    console.info('getRemoteAddress success');
  }).catch((err: BusinessError) => {
    console.error('getRemoteAddress fail');
  });
});

getLocalAddress²⁴⁺

getLocalAddress(): Promise<NetAddress>

获取TCPSocketConnection连接的本地Socket地址。使用Promise异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取本地socket地址的结果。

错误码：

以下错误码的详细介绍请参见Socket错误码。

错误码ID	错误信息
2300002	System internal error.
2301009	Bad file descriptor.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address: "192.168.xx.xx",
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr, (err: BusinessError) => {
  let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
  let netAddress: socket.NetAddress = {
    address: "192.168.xx.xx",
    port: 8080
  }
  let options: socket.TCPConnectOptions = {
    address: netAddress,
    timeout: 6000
  }
  tcp.connect(options, (err: BusinessError) => {
    if (err) {
      console.error('connect fail');
      return;
    }
    console.info('connect success!');
  })
  tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
    client.getLocalAddress().then((localAddress: socket.NetAddress) => {
      console.info("Family IP Port: " + JSON.stringify(localAddress));
    }).catch((err: BusinessError) => {
      console.error('Error:' + JSON.stringify(err));
    });
  })
})

getSocketFd²⁴⁺

getSocketFd(): Promise<number>

获取TCPSocketConnection连接的文件描述符。使用Promise异步回调。

说明：

• 与客户端建立连接后，才可调用此方法。
• 连接断开、Socket已关闭（如调用close后）等异常情况下调用本接口会返回-1。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
201	Permission denied.

返回值：

类型	说明
Promise<number>	Promise对象，返回Socket的文件描述符。

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
  address: "192.168.xx.xx",
  port: 8080,
  family: 1
}
tcpServer.listen(listenAddr, (err: BusinessError) => {
  tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
    client.getSocketFd().then((fd: number) => {
      console.info(`Socket FD：${fd}`);
    }).catch((err: BusinessError) => {
      console.error(`getSocketFd fail: ${err.message}, errorCode: ${err.code}`);
    });
  })
}).catch((err: BusinessError) => {
  console.error('listen fail');
});

on('message')¹⁰⁺

on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void

订阅TCPSocketConnection连接的接收消息事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'message'：接收消息事件。
callback	Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>	是	回调函数。message：接收到的消息；remoteInfo：socket连接信息。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();

class SocketInfo {
  message: ArrayBuffer = new ArrayBuffer(1);
  remoteInfo: socket.SocketRemoteInfo = {} as socket.SocketRemoteInfo;
}
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  client.on('message', (value: SocketInfo) => {
    let messageView = '';
    for (let i: number = 0; i < value.message.byteLength; i++) {
      let messages: number = value.message[i]
      let message = String.fromCharCode(messages);
      messageView += message;
    }
    console.log('on message message: ' + JSON.stringify(messageView));
    console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
  });
});

off('message')¹⁰⁺

off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void

取消订阅TCPSocketConnection连接的接收消息事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'message'：接收消息事件。
callback	Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>	否	回调函数。message：接收到的消息；remoteInfo：socket连接信息。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
class SocketInfo {
  message: ArrayBuffer = new ArrayBuffer(1);
  remoteInfo: socket.SocketRemoteInfo = {} as socket.SocketRemoteInfo;
}
let callback = (value: SocketInfo) => {
  let messageView = '';
  for (let i: number = 0; i < value.message.byteLength; i++) {
    let messages: number = value.message[i]
    let message = String.fromCharCode(messages);
    messageView += message;
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
}
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  client.on('message', callback);
  // 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
  client.off('message', callback);
  client.off('message');
});

on('close')²⁴⁺

on(type: 'close', callback: Callback<void>): void

订阅TCPSocketConnection的关闭事件。使用callback异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'close'：关闭事件。
callback	Callback<void>	是	回调函数。失败时返回错误码、错误信息。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
401	Parameter error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  client.on('close', () => {
    console.info("on close success")
  });
});

off('close')²⁴⁺

off(type: 'close', callback?: Callback<void>): void

取消订阅TCPSocketConnection的关闭事件。使用callback异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'close'：关闭事件。
callback	Callback<void>	否	回调函数。可以指定传入on中的callback取消对应的订阅，也可以不指定callback清空所有订阅。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
401	Parameter error.

示例：

import { socket } from '@kit.NetworkKit';

let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let callback = () => {
  console.info("on close success");
}
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  client.on('close', callback);
  // 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
  client.off('close', callback);
  client.off('close');
});

on('error')¹⁰⁺

on(type: 'error', callback: ErrorCallback): void

订阅TCPSocketConnection连接的error事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  client.on('error', (err: BusinessError) => {
    console.log("on error, err:" + JSON.stringify(err))
  });
});

off('error')¹⁰⁺

off(type: 'error', callback?: ErrorCallback): void

取消订阅TCPSocketConnection连接的error事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	否	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let callback = (err: BusinessError) => {
  console.log("on error, err:" + JSON.stringify(err));
}
let tcpServer: socket = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
  client.on('error', callback);
  // 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
  client.off('error', callback);
  client.off('error');
});

LocalSocket

LocalSocket连接。在调用LocalSocket的方法前，需要先通过socket.constructLocalSocketInstance创建LocalSocket对象。

getLocalAddress²⁴⁺

getLocalAddress(): Promise<string>

获取LocalSocket的本地Socket地址。使用Promise异步回调。

说明： bind方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<string>	以Promise形式返回获取本地socket地址的结果。

错误码：

以下错误码的详细介绍请参见Socket错误码。

错误码ID	错误信息
2300002	System internal error.
2301009	Bad file descriptor.
2303188	Socket operation on non-socket.

示例：

说明：

在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。

import { common } from '@kit.AbilityKit';
import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let client: socket.LocalSocket = socket.constructLocalSocketInstance();
let context: common.UIAbilityContext = this.getUIContext().getHostContext() as common.UIAbilityContext;
let sandboxPath: string = context.filesDir + '/testSocket';
let address : socket.LocalAddress = {
  address: sandboxPath
}
client.bind(address).then(() => {
  console.error('bind success');
  client.getLocalAddress().then((localPath: string) => {
    console.info("SUCCESS " + JSON.stringify(localPath));
  }).catch((err: BusinessError) => {
    console.error("FAIL " + JSON.stringify(err));
  })
}).catch((err: Object) => {
  console.error('failed to bind: ' + JSON.stringify(err));
})

socket.constructLocalSocketServerInstance¹¹⁺

constructLocalSocketServerInstance(): LocalSocketServer

创建一个LocalSocketServer对象。

系统能力：SystemCapability.Communication.NetStack

返回值：

类型	说明
LocalSocketServer	返回一个LocalSocketServer对象。

示例：

import { socket } from '@kit.NetworkKit';
let server: socket.LocalSocketServer = socket.constructLocalSocketServerInstance();

LocalSocketServer¹¹⁺

LocalSocketServer类。在调用LocalSocketServer的方法前，需要先通过socket.constructLocalSocketServerInstance创建LocalSocketServer对象。

getLocalAddress²⁴⁺

getLocalAddress(): Promise<string>

获取LocalSocketServer中本地Socket地址。使用Promise异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<string>	以Promise形式返回获取本地socket地址的结果。

错误码：

以下错误码的详细介绍请参见Socket错误码。

错误码ID	错误信息
2300002	System internal error.
2301009	Bad file descriptor.
2303188	Socket operation on non-socket.

示例：

说明：

在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。

import { common } from '@kit.AbilityKit';
import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let server: socket.LocalSocketServer = socket.constructLocalSocketServerInstance();
let context: common.UIAbilityContext = this.getUIContext().getHostContext() as common.UIAbilityContext;
let sandboxPath: string = context.filesDir + '/testSocket';
let listenAddr: socket.LocalAddress = {
  address: sandboxPath
}
server.listen(listenAddr).then(() => {
  console.info("listen success");
  server.getLocalAddress().then((localPath: string) => {
    console.info("SUCCESS " + JSON.stringify(localPath));
  }).catch((err: BusinessError) => {
    console.error("FAIL " + JSON.stringify(err));
  })
}).catch((err: Object) => {
  console.error("listen fail: " + JSON.stringify(err));
})

getSocketFd²⁴⁺

getSocketFd(): Promise<number>

获取LocalSocketServer监听端口绑定的文件描述符。使用Promise异步回调。

说明：

• listen方法调用成功后，才可调用此方法。
• 监听异常、Socket已关闭（如调用close后）等异常情况下调用本接口会返回-1。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<number>	Promise对象，返回Socket的文件描述符。

示例：

说明：

在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需在页面中使用UIAbilityContext提供的能力，请参见获取UIAbility的上下文信息。

import { socket } from '@kit.NetworkKit';
import { common } from '@kit.AbilityKit';

let server: socket.LocalSocketServer = socket.constructLocalSocketServerInstance();
let context: common.UIAbilityContext = this.getUIContext().getHostContext() as common.UIAbilityContext;
let sandboxPath: string = context.filesDir + '/testSocket';
let listenAddr : socket.LocalAddress = {
  address: sandboxPath
}

server.listen(listenAddr).then(() => {
  console.info("listen success");
  server.getSocketFd().then((fd: number) => {
    console.info(`Socket FD：${fd}`);
  }).catch((err: Object) => {
    console.error(`getSocketFd fail: ${JSON.stringify(err)}`);
  });
}).catch((err: Object) => {
  console.error("listen fail: " + JSON.stringify(err));
})

close²⁴⁺

close(): Promise<void>

LocalSocketServer停止监听并释放通过listen方法绑定的监听端口。使用Promise异步回调。

说明： 该方法不会关闭已有连接。如需关闭，请调用LocalSocketConnection的close方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见Socket错误码。

错误码ID	错误信息
2300002	System internal error.

示例：

说明：

在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。

import { socket } from '@kit.NetworkKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let localserver: socket.LocalSocketServer = socket.constructLocalSocketServerInstance();
let context: common.UIAbilityContext = this.getUIContext().getHostContext() as common.UIAbilityContext;
let sandboxPath: string = context.filesDir + '/testSocket';
let addr: socket.LocalAddress = {
  address: sandboxPath
}
localserver.on('connect', (connection: socket.LocalSocketConnection) => {
  console.info("connection clientId: " + connection.clientId);
  // 逻辑处理
  localserver.close(); // 停止监听
  connection.close(); // 关闭当前连接
});
localserver.listen(addr).then(() => {
  console.info('listen success');
}).catch((err: BusinessError) => {
  console.error('listen fail: ' + err.code);
});

LocalSocketConnection¹¹⁺

LocalSocketConnection连接，即LocalSocket客户端与服务端的会话连接。在调用LocalSocketConnection的方法前，需要先获取LocalSocketConnection对象。

说明： 客户端与服务端成功建立连接后，才能通过返回的LocalSocketConnection对象调用相应的接口。

系统能力：SystemCapability.Communication.NetStack

getLocalAddress²⁴⁺

getLocalAddress(): Promise<string>

获取LocalSocketConnection连接中的本地Socket地址。使用Promise异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<string>	以Promise形式返回获取本地socket地址的结果。

错误码：

以下错误码的详细介绍请参见Socket错误码。

错误码ID	错误信息
2300002	System internal error.
2301009	Bad file descriptor.
2303188	Socket operation on non-socket.

示例：

说明：

在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。

import { common } from '@kit.AbilityKit';
import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let server: socket.LocalSocketServer = socket.constructLocalSocketServerInstance();
let context: common.UIAbilityContext = this.getUIContext().getHostContext() as common.UIAbilityContext;
let sandboxPath: string = context.filesDir + '/testSocket';
let localAddr: socket.LocalAddress = {
  address: sandboxPath
}
server.listen(localAddr).then(() => {
  console.info('listen success');
  let client: socket.LocalSocket = socket.constructLocalSocketInstance();
  let connectOpt: socket.LocalConnectOptions = {
    address: localAddr,
    timeout: 6000
  }
  client.connect(connectOpt).then(() => {
    server.getLocalAddress().then((localPath: string) => {
      console.info("success, localPath is" + JSON.stringify(localPath));
    }).catch((err: BusinessError) => {
      console.error("FAIL " + JSON.stringify(err));
    })
  }).catch((err: Object) => {
    console.error('connect fail: ' + JSON.stringify(err));
  });
});

getSocketFd²⁴⁺

getSocketFd(): Promise<number>

获取LocalSocketConnection连接的文件描述符。使用Promise异步回调。

说明：

• 成功建立连接后，才可调用此方法。
• 连接断开、Socket已关闭（如调用close后）等异常情况下调用本接口会返回-1。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<number>	Promise对象，返回Socket的文件描述符。

示例：

说明：

在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。

import { socket } from '@kit.NetworkKit';
import { common } from '@kit.AbilityKit';

let server: socket.LocalSocketServer = socket.constructLocalSocketServerInstance();
let context: common.UIAbilityContext = this.getUIContext().getHostContext() as common.UIAbilityContext;
let sandboxPath: string = context.filesDir + '/testSocket';
let listenAddr : socket.LocalAddress = {
  address: sandboxPath
}
server.on('connect', (connection: socket.LocalSocketConnection) => {
  connection.getSocketFd().then((fd: number) => {
    console.info(`Socket FD：${fd}`);
  }).catch((err: Object) => {
    console.error(`getSocketFd fail: ${JSON.stringify(err)}`);
  });
});
server.listen(listenAddr).then(() => {
  console.info("listen success");
}).catch((err: Object) => {
  console.error(`listen fail: ${JSON.stringify(err)}`);
})

TCP 错误码说明

TCP 其余错误码映射形式为：2301000 + Linux内核错误码。

错误码的详细介绍参见Socket错误码

socket.constructTLSSocketInstance²⁴⁺

constructTLSSocketInstance(): TLSSocket

创建并返回一个TLSSocket对象。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值:

类型	说明
TLSSocket	返回一个TLSSocket对象。

示例：

import socket from "@ohos.net.socket";
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();

TLSSocket⁹⁺

TLSSocket连接。在调用TLSSocket的方法前，需要先通过socket.constructTLSSocketInstance创建TLSSocket对象。

bind⁹⁺

bind(address: NetAddress, callback: AsyncCallback<void>): void

绑定IP地址和端口。使用callback方法作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
address	NetAddress	是	目标地址信息，参考NetAddress。
callback	AsyncCallback<void>	是	回调函数。成功返回TLSSocket绑定本机的IP地址和端口的结果。 失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2303198	Address already in use.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
tls.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

bind⁹⁺

bind(address: NetAddress): Promise<void>

绑定IP地址和端口。使用Promise方法作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
address	NetAddress	是	目标地址信息，参考NetAddress。

返回值：

类型	说明
Promise<void>	以Promise形式返回TLSSocket绑定本机的IP地址和端口的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2303198	Address already in use.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
tls.bind(bindAddr).then(() => {
  console.log('bind success');
}).catch((err: BusinessError) => {
  console.log('bind fail');
});

getState⁹⁺

getState(callback: AsyncCallback<SocketStateBase>): void

在TLSSocket的bind成功之后，获取TLSSocket状态。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<SocketStateBase>	是	回调函数。成功返回TLSSocket状态，失败返回错误码,错误信息。

错误码：

错误码ID	错误信息
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
tls.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
tls.getState((err: BusinessError, data: socket.SocketStateBase) => {
  if (err) {
    console.log('getState fail');
    return;
  }
  console.log('getState success:' + JSON.stringify(data));
});

getState⁹⁺

getState(): Promise<SocketStateBase>

在TLSSocket的bind成功之后，获取TLSSocket状态。使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<SocketStateBase>	以Promise形式返回获取TLSSocket状态的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
tls.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
tls.getState().then(() => {
  console.log('getState success');
}).catch((err: BusinessError) => {
  console.log('getState fail');
});

setExtraOptions⁹⁺

setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback<void>): void

在TLSSocket的bind成功之后，设置TCPSocket连接的其他属性。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPExtraOptions	是	TCPSocket连接的其他属性，参考TCPExtraOptions。
callback	AsyncCallback<void>	是	回调函数。成功返回设置TCPSocket连接的其他属性的结果，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
tls.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

let tcpExtraOptions: socket.TCPExtraOptions = {
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on: true, linger: 10 },
  receiveBufferSize: 1000,
  sendBufferSize: 1000,
  reuseAddress: true,
  socketTimeout: 3000
}
tls.setExtraOptions(tcpExtraOptions, (err: BusinessError) => {
  if (err) {
    console.log('setExtraOptions fail');
    return;
  }
  console.log('setExtraOptions success');
});

setExtraOptions⁹⁺

setExtraOptions(options: TCPExtraOptions): Promise<void>

在TLSSocket的bind成功之后，设置TCPSocket连接的其他属性，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPExtraOptions	是	TCPSocket连接的其他属性，参考TCPExtraOptions。

返回值：

类型	说明
Promise<void>	以Promise形式返回设置TCPSocket连接的其他属性的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
tls.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

let tcpExtraOptions: socket.TCPExtraOptions = {
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on: true, linger: 10 },
  receiveBufferSize: 1000,
  sendBufferSize: 1000,
  reuseAddress: true,
  socketTimeout: 3000
}
tls.setExtraOptions(tcpExtraOptions).then(() => {
  console.log('setExtraOptions success');
}).catch((err: BusinessError) => {
  console.log('setExtraOptions fail');
});

on('message')⁹⁺

on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void;

订阅TLSSocket连接的接收消息事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'message'：接收消息事件。
callback	Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>	是	回调函数。message：接收到的消息；remoteInfo：socket连接信息。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
class SocketInfo {
  message: ArrayBuffer = new ArrayBuffer(1);
  remoteInfo: socket.SocketRemoteInfo = {} as socket.SocketRemoteInfo;
}
let messageView = '';
tls.on('message', (value: SocketInfo) => {
  for (let i: number = 0; i < value.message.byteLength; i++) {
    let messages: number = value.message[i]
    let message = String.fromCharCode(messages);
    messageView += message;
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
});

off('message')⁹⁺

off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void

取消订阅TLSSocket连接的接收消息事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'message'：接收消息事件。
callback	Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>	否	回调函数。message：接收到的消息；remoteInfo：socket连接信息。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
class SocketInfo {
  message: ArrayBuffer = new ArrayBuffer(1);
  remoteInfo: socket.SocketRemoteInfo = {} as socket.SocketRemoteInfo;
}
let messageView = '';
let callback = (value: SocketInfo) => {
  for (let i: number = 0; i < value.message.byteLength; i++) {
    let messages: number = value.message[i]
    let message = String.fromCharCode(messages);
    messageView += message;
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
}
tls.on('message', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tls.off('message', callback);

on('connect' | 'close')⁹⁺

on(type: 'connect' | 'close', callback: Callback<void>): void

订阅TLSSocket的连接事件或关闭事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。 - 'connect'：连接事件。 - 'close'：关闭事件。
callback	Callback<void>	是	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.on('connect', () => {
  console.log("on connect success")
});
tls.on('close', () => {
  console.log("on close success")
});

off('connect' | 'close')⁹⁺

off(type: 'connect' | 'close', callback?: Callback<void>): void

取消订阅TLSSocket的连接事件或关闭事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。 - 'connect'：连接事件。 - 'close'：关闭事件。
callback	Callback<void>	否	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
let callback1 = () => {
  console.log("on connect success");
}
tls.on('connect', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tls.off('connect', callback1);
tls.off('connect');
let callback2 = () => {
  console.log("on close success");
}
tls.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tls.off('close', callback2);

on('error')⁹⁺

on(type: 'error', callback: ErrorCallback): void

订阅TLSSocket连接的error事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	是	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.on('error', (err: BusinessError) => {
  console.log("on error, err:" + JSON.stringify(err))
});

off('error')⁹⁺

off(type: 'error', callback?: ErrorCallback): void

取消订阅TLSSocket连接的error事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	否	回调函数。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
let callback = (err: BusinessError) => {
  console.log("on error, err:" + JSON.stringify(err));
}
tls.on('error', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tls.off('error', callback);

connect⁹⁺

connect(options: TLSConnectOptions, callback: AsyncCallback<void>): void

在TLSSocket上bind成功之后，进行通信连接，并创建和初始化TLS会话，实现建立连接过程，启动与服务器的TLS/SSL握手，实现数据传输功能，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TLSConnectOptions	是	TLSSocket连接所需要的参数。
callback	AsyncCallback<void>	是	回调函数，成功无返回，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303104	Interrupted system call.
2303109	Bad file number.
2303111	Resource temporarily unavailable try again.
2303188	Socket operation on non-socket.
2303191	Protocol wrong type for socket.
2303198	Address already in use.
2303199	Cannot assign requested address.
2303210	Connection timed out.
2303501	SSL is null.
2303502	Error in tls reading.
2303503	Error in tls writing
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tlsTwoWay: socket.TLSSocket = socket.constructTLSSocketInstance();  // Two way authentication
let bindAddr: socket.NetAddress = {
  address: '0.0.0.0',
}
tlsTwoWay.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

let tlsConnectOptions: socket.TLSConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    exclusionListpassword: "xxxx",
    protocols: socket.Protocol.TLSv12,
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256"
  },
  ALPNProtocols: ["spdy/1", "http/1.1"]
}

tlsTwoWay.connect(tlsConnectOptions, (err: BusinessError) => {
  console.error("connect callback error" + err);
});

let tlsOneWay: socket.TLSSocket = socket.constructTLSSocketInstance(); // One way authentication
tlsOneWay.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

let tlsOneWayConnectOptions: socket.TLSConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  secureOptions: {
    ca: ["xxxx", "xxxx"],
    cipherSuite: "AES256-SHA256"
  }
}
tlsOneWay.connect(tlsOneWayConnectOptions, (err: BusinessError) => {
  console.error("connect callback error" + err);
});

connect⁹⁺

connect(options: TLSConnectOptions): Promise<void>

在TLSSocket上bind成功之后，进行通信连接，并创建和初始化TLS会话，实现建立连接过程，启动与服务器的TLS/SSL握手，实现数据传输功能，该连接包括两种认证方式，单向认证与双向认证，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TLSConnectOptions	是	连接所需要的参数。

返回值：

类型	说明
Promise<void>	以Promise形式返回，成功无返回，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303104	Interrupted system call.
2303109	Bad file number.
2303111	Resource temporarily unavailable try again.
2303188	Socket operation on non-socket.
2303191	Protocol wrong type for socket.
2303198	Address already in use.
2303199	Cannot assign requested address.
2303210	Connection timed out.
2303501	SSL is null.
2303502	Error in tls reading.
2303503	Error in tls writing
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tlsTwoWay: socket.TLSSocket = socket.constructTLSSocketInstance();  // Two way authentication
let bindAddr: socket.NetAddress = {
  address: '0.0.0.0',
}
tlsTwoWay.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

let tlsConnectOptions: socket.TLSConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: socket.Protocol.TLSv12,
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256"
  },
  ALPNProtocols: ["spdy/1", "http/1.1"]
}

tlsTwoWay.connect(tlsConnectOptions).then(() => {
  console.log("connect successfully");
}).catch((err: BusinessError) => {
  console.log("connect failed " + JSON.stringify(err));
});

let tlsOneWay: socket.TLSSocket = socket.constructTLSSocketInstance(); // One way authentication
tlsOneWay.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

let tlsOneWayConnectOptions: socket.TLSConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  secureOptions: {
    ca: ["xxxx", "xxxx"],
    cipherSuite: "AES256-SHA256"
  }
}
tlsOneWay.connect(tlsOneWayConnectOptions).then(() => {
  console.log("connect successfully");
}).catch((err: BusinessError) => {
  console.log("connect failed " + JSON.stringify(err));
});

getRemoteAddress⁹⁺

getRemoteAddress(callback: AsyncCallback<NetAddress>): void

在TLSSocket通信连接成功之后，获取对端Socket地址。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<NetAddress>	是	回调函数。成功返回对端的socket地址，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getRemoteAddress((err: BusinessError, data: socket.NetAddress) => {
  if (err) {
    console.log('getRemoteAddress fail');
    return;
  }
  console.log('getRemoteAddress success:' + JSON.stringify(data));
});

getRemoteAddress⁹⁺

getRemoteAddress(): Promise<NetAddress>

在TLSSocket通信连接成功之后，获取对端Socket地址。使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取对端socket地址的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getRemoteAddress().then(() => {
  console.log('getRemoteAddress success');
}).catch((err: BusinessError) => {
  console.log('getRemoteAddress fail');
});

getCertificate⁹⁺

getCertificate(callback: AsyncCallback<X509CertRawData>): void

在TLSSocket通信连接成功之后，获取本地的数字证书，该接口只适用于双向认证时，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

*支持平台*： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<X509CertRawData>	是	回调函数，成功返回本地的证书，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2303504	Error looking up x509.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getCertificate((err: BusinessError, data: socket.X509CertRawData) => {
  if (err) {
    console.log("getCertificate callback error = " + err);
  } else {
    console.log("getCertificate callback = " + data);
  }
});

getCertificate⁹⁺

getCertificate():Promise<X509CertRawData>

在TLSSocket通信连接之后，获取本地的数字证书，该接口只适用于双向认证时，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<X509CertRawData>	以Promise形式返回本地的数字证书的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2303504	Error looking up x509.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getCertificate().then((data: socket.X509CertRawData) => {
  console.log(data);
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

getRemoteCertificate⁹⁺

getRemoteCertificate(callback: AsyncCallback<X509CertRawData>): void

在TLSSocket通信连接成功之后，获取服务端的数字证书，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<X509CertRawData>	是	回调函数，返回服务端的证书。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getRemoteCertificate((err: BusinessError, data: socket.X509CertRawData) => {
  if (err) {
    console.log("getRemoteCertificate callback error = " + err);
  } else {
    console.log("getRemoteCertificate callback = " + data);
  }
});

getRemoteCertificate⁹⁺

getRemoteCertificate():Promise<X509CertRawData>

在TLSSocket通信连接成功之后，获取服务端的数字证书，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<X509CertRawData>	以Promise形式返回服务端的数字证书的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getRemoteCertificate().then((data: socket.X509CertRawData) => {
  console.log(data);
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

getProtocol⁹⁺

getProtocol(callback: AsyncCallback<string>): void

在TLSSocket通信连接成功之后，获取通信的协议版本，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<string>	是	回调函数，返回通信的协议。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2303505	Error occurred in the tls system call.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getProtocol((err: BusinessError, data: string) => {
  if (err) {
    console.log("getProtocol callback error = " + err);
  } else {
    console.log("getProtocol callback = " + data);
  }
});

getProtocol⁹⁺

getProtocol():Promise<string>

在TLSSocket通信连接成功之后，获取通信的协议版本，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<string>	以Promise形式返回通信的协议。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2303505	Error occurred in the tls system call.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getProtocol().then((data: string) => {
  console.log(data);
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

getCipherSuite⁹⁺

getCipherSuite(callback: AsyncCallback<Array<string>>): void

在TLSSocket通信连接成功之后，获取通信双方协商后的加密套件，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<string>>	是	回调函数，返回通信双方支持的加密套件。 失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2303502	Error in tls reading.
2303505	Error occurred in the tls system call.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getCipherSuite((err: BusinessError, data: Array<string>) => {
  if (err) {
    console.log("getCipherSuite callback error = " + err);
  } else {
    console.log("getCipherSuite callback = " + data);
  }
});

getCipherSuite⁹⁺

getCipherSuite(): Promise<Array<string>>

在TLSSocket通信连接成功之后，获取通信双方协商后的加密套件，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<Array<string>>	以Promise形式返回通信双方支持的加密套件。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2303502	Error in tls reading.
2303505	Error occurred in the tls system call.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getCipherSuite().then((data: Array<string>) => {
  console.log('getCipherSuite success:' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

getSignatureAlgorithms⁹⁺

getSignatureAlgorithms(callback: AsyncCallback<Array<string>>): void

在TLSSocket通信连接成功之后，获取通信双方协商后签名算法，该接口只适配双向认证模式下，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<string>>	是	回调函数，返回双方支持的签名算法。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getSignatureAlgorithms((err: BusinessError, data: Array<string>) => {
  if (err) {
    console.log("getSignatureAlgorithms callback error = " + err);
  } else {
    console.log("getSignatureAlgorithms callback = " + data);
  }
});

getSignatureAlgorithms⁹⁺

getSignatureAlgorithms(): Promise<Array<string>>

在TLSSocket通信连接成功之后，获取通信双方协商后的签名算法，该接口只适配双向认证模式下，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<Array<string>>	以Promise形式返回获取到的双方支持的签名算法。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getSignatureAlgorithms().then((data: Array<string>) => {
  console.log("getSignatureAlgorithms success" + data);
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

getLocalAddress²⁴⁺

getLocalAddress(): Promise<NetAddress>

获取TLSSocket的本地Socket地址。使用Promise异步回调。

说明： 在TLSSocketServer通信连接成功之后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取本地socket地址的结果。

错误码：

错误码ID	错误信息
2300002	System internal error.
2301009	Bad file descriptor.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.getLocalAddress().then((localAddress: socket.NetAddress) => {
  console.info("Get success: " + JSON.stringify(localAddress));
}).catch((err: BusinessError) => {
  console.error("Get failed, error: " + JSON.stringify(err));
})

getSocketFd²⁴⁺

getSocketFd(): Promise<number>

获取TLSSocket的文件描述符。使用Promise异步回调。

说明：

• bind方法调用成功后，才可调用此方法。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<number>	以Promise形式返回socket的文件描述符。

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
let bindAddr: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
tls.bind(bindAddr, (err: BusinessError) => {
  if (err) {
    console.error('bind fail');
    return;
  }
  console.info('bind success');
});
tls.getSocketFd().then((data: number) => {
  console.info("tls socket fd: " + data);
})

send⁹⁺

send(data: string, callback: AsyncCallback<void>): void

在TLSSocket通信连接成功之后，向服务端发送消息，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
data	string	是	发送的数据内容。
callback	AsyncCallback<void>	是	回调函数,返回TLSSocket发送数据的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2303503	Error in tls writing.
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.send("xxxx", (err: BusinessError) => {
  if (err) {
    console.log("send callback error = " + err);
  } else {
    console.log("send success");
  }
});

send⁹⁺

send(data: string): Promise<void>

在TLSSocket通信连接成功之后，向服务端发送消息，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
data	string	是	发送的数据内容。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2303503	Error in tls writing.
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.
2300002	System internal error.

返回值：

类型	说明
Promise<void>	以Promise形式返回,返回TLSSocket发送数据的结果。失败返回错误码，错误信息。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.send("xxxx").then(() => {
  console.log("send success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

close⁹⁺

close(callback: AsyncCallback<void>): void

在TLSSocket通信连接成功之后，断开连接，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数,成功返回TLSSocket关闭连接的结果。 失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.close((err: BusinessError) => {
  if (err) {
    console.log("close callback error = " + err);
  } else {
    console.log("close success");
  }
});

close⁹⁺

close(): Promise<void>

在TLSSocket通信连接成功之后，断开连接，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<void>	以Promise形式返回,返回TLSSocket关闭连接的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.
2300002	System internal error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
tls.close().then(() => {
  console.log("close success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

TLSConnectOptions⁹⁺

TLS连接的操作。

系统能力：SystemCapability.Communication.NetStack

名称	类型	只读	可选	说明	Android 平台	iOS 平台
address	NetAddress	否	否	网关地址。	支持	支持
secureOptions	TLSSecureOptions	否	否	TLS安全相关操作。	支持	支持
ALPNProtocols	Array<string>	否	是	ALPN协议，支持["spdy/1", "http/1.1"]，默认为[]。	支持	支持
skipRemoteValidation24+	boolean	否	是	是否跳过对服务端进行证书认证，默认为false。true：跳过对服务端进行证书认证；false：不跳过对服务端进行证书认证。	支持	支持
proxy18+	ProxyOptions	否	是	使用的代理信息，默认不使用代理。	支持	支持
timeout22+	number	否	是	连接超时时间，单位：ms，默认为0。传入值需为0-4294967295范围内的整数。TLSSocket连接在超时后会失败。	支持	支持

TLSSecureOptions⁹⁺

TLS安全相关操作。当本地证书cert和私钥key不为空时，开启双向验证模式。cert和key其中一项为空时，开启单向验证模式。

系统能力：SystemCapability.Communication.NetStack

名称	类型	只读	可选	说明	Android 平台	iOS 平台
ca	string | Array<string>	否	是	服务端的ca证书，用于认证校验服务端的数字证书。默认为系统预置CA证书12+。最多支持设置1000本证书。	支持	支持
cert	string | Array<string>	否	是	本地客户端的数字证书。从API Version 23开始支持传入数组，最多支持设置1000本证书。	支持	支持
key	string	否	是	本地数字证书的私钥。	支持	支持
password	string	否	是	读取私钥的密码。	支持	支持
protocols	Protocol |Array<Protocol>	否	是	TLS的协议版本，默认为"TLSv1.2"。	支持	支持
useRemoteCipherPrefer	boolean	否	是	优先使用对等方的密码套件。true：优先使用对等方的密码套件；false：不优先使用对等方的密码套件。	支持	支持
signatureAlgorithms	string	否	是	通信过程中的签名算法，默认为"" 。	支持	支持
cipherSuite	string	否	是	通信过程中的加密套件，默认为"" 。	支持	支持
isBidirectionalAuthentication24+	boolean	否	是	用于设置双向认证，默认为false。true：设置双向认证；false：不设置双向认证。	支持	支持

Protocol⁹⁺

TLS通信的协议版本。

系统能力：SystemCapability.Communication.NetStack

名称	值	说明	Android 平台	iOS 平台
TLSv12	"TLSv1.2"	使用TLSv1.2协议通信。	支持	支持
TLSv13	"TLSv1.3"	使用TLSv1.3协议通信。	支持	支持

X509CertRawData⁹⁺

存储证书的数据。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

socket.constructTLSSocketServerInstance²⁴⁺

constructTLSSocketServerInstance(): TLSSocketServer

创建并返回一个TLSSocketServer对象。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值:

类型	说明
TLSSocketServer	返回一个TLSSocketServer对象。

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();

TLSSocketServer²⁴⁺

TLSSocketServer连接。在调用TLSSocketServer的方法前，需要先通过socket.constructTLSSocketServerInstance创建TLSSocketServer对象。

listen²⁴⁺

listen(options: TLSConnectOptions, callback: AsyncCallback<void>): void

绑定IP地址和端口，在TLSSocketServer上bind成功之后，监听客户端的连接，创建和初始化TLS会话，实现建立连接过程，加载证书秘钥并验证，使用callback异步回调。

注意：

IP地址设置为0.0.0.0时，可以监听本机所有地址。

address为“”时会被解析成了255.255.255.255（广播地址）, Android监听正常，iOS 不允许绑定广播地址，会监听失败上报地址族不支持的错误。

错误码：2303147

错误信息：Address family not supported by protocol family

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TLSConnectOptions	是	TLSSocketServer连接所需要的参数。
callback	AsyncCallback<void>	是	回调函数，成功返回空，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.
2303109	Bad file number.
2303111	Resource temporarily unavailable try again.
2303198	Address already in use.
2303199	Cannot assign requested address.
2303501	SSL is null.
2303502	Error in tls reading.
2303503	Error in tls writing
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"],
  skipRemoteValidation: false
}
tlsServer.listen(tlsConnectOptions, (err: BusinessError) => {
  console.error("listen callback error" + err);
});

listen²⁴⁺

listen(options: TLSConnectOptions): Promise<void>

绑定IP地址和端口，在TLSSocketServer上bind成功之后，监听客户端的连接，并创建和初始化TLS会话，实现建立连接过程，加载证书秘钥并验证，使用Promise异步回调。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TLSConnectOptions	是	连接所需要的参数。

返回值：

类型	说明
Promise<void>	以Promise形式返回，成功返回空，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
201	Permission denied.
2300002	System internal error.
2303109	Bad file number.
2303111	Resource temporarily unavailable try again.
2303198	Address already in use.
2303199	Cannot assign requested address.
2303501	SSL is null.
2303502	Error in tls reading.
2303503	Error in tls writing
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"],
  skipRemoteValidation: false
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});

getState²⁴⁺

getState(callback: AsyncCallback<SocketStateBase>): void

在TLSSocketServer的listen成功之后，获取TLSSocketServer状态。使用callback异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<SocketStateBase>	是	回调函数。成功返回TLSSocketServer状态，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});
tlsServer.getState((err: BusinessError, data: socket.SocketStateBase) => {
  if (err) {
    console.error('getState fail');
    return;
  }
  console.info('getState success:' + JSON.stringify(data));
});

getState²⁴⁺

getState(): Promise<SocketStateBase>

在TLSSocketServer的listen成功之后，获取TLSSocketServer状态。使用Promise异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<SocketStateBase>	以Promise形式返回获取TLSSocketServer状态的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});
tlsServer.getState().then(() => {
  console.info('getState success');
}).catch((err: BusinessError) => {
  console.error('getState fail');
});

getSocketFd²⁴⁺

getSocketFd(): Promise<number>

获取TLSSocketServer监听端口绑定的文件描述符。使用Promise异步回调。

说明：

• listen方法调用成功后，才可调用此方法。多次调用listen时，会获取最新监听端口绑定的文件描述符。
• 监听异常、Socket已关闭（如调用close后）等异常情况下调用本接口会返回-1。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
201	Permission denied.

返回值：

类型	说明
Promise<number>	Promise对象，返回Socket的文件描述符。

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: "xxxx",
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen success");
  tlsServer.getSocketFd().then((fd: number) => {
    console.info(`Socket FD：${fd}`);
  }).catch((err: BusinessError) => {
    console.error(`getSocketFd fail: ${err.message}, errorCode: ${err.code}`);
  });
}).catch((err: BusinessError) => {
  console.error(`listen failed: ${JSON.stringify(err)}`);
});

setExtraOptions²⁴⁺

setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback<void>): void

在TLSSocketServer的listen成功之后，设置TLSSocketServer连接的其他属性。使用callback异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPExtraOptions	是	TLSSocketServer连接的其他属性。
callback	AsyncCallback<void>	是	回调函数。成功返回空，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});

interface SocketLinger {
  on: boolean;
  linger: number;
}

let tcpExtraOptions: socket.TCPExtraOptions = {
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on: true, linger: 10 } as SocketLinger,
  receiveBufferSize: 8192,
  sendBufferSize: 8192,
  reuseAddress: true,
  socketTimeout: 3000
}
tlsServer.setExtraOptions(tcpExtraOptions, (err: BusinessError) => {
  if (err) {
    console.error('setExtraOptions fail');
    return;
  }
  console.info('setExtraOptions success');
});

setExtraOptions²⁴⁺

setExtraOptions(options: TCPExtraOptions): Promise<void>

在TLSSocketServer的listen成功之后，设置TLSSocketServer连接的其他属性，使用Promise异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
options	TCPExtraOptions	是	TLSSocketServer连接的其他属性。

返回值：

类型	说明
Promise<void>	以Promise形式返回，成功返回空，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});

interface SocketLinger {
  on: boolean;
  linger: number;
}

let tcpExtraOptions: socket.TCPExtraOptions = {
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on: true, linger: 10 } as SocketLinger,
  receiveBufferSize: 8192,
  sendBufferSize: 8192,
  reuseAddress: true,
  socketTimeout: 3000
}
tlsServer.setExtraOptions(tcpExtraOptions).then(() => {
  console.info('setExtraOptions success');
}).catch((err: BusinessError) => {
  console.error('setExtraOptions fail');
});

getCertificate²⁴⁺

getCertificate(callback: AsyncCallback<X509CertRawData>): void

在TLSSocketServer通信连接成功之后，获取本地的数字证书，使用callback异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<X509CertRawData>	是	回调函数，成功返回本地的证书，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2303504	Error looking up x509.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { util } from '@kit.ArkTS';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});
tlsServer.getCertificate((err: BusinessError, data: socket.X509CertRawData) => {
  if (err) {
    console.error("getCertificate callback error = " + err);
  } else {
    const decoder = util.TextDecoder.create();
    const str = decoder.decodeToString(data.data);
    console.info("getCertificate callback: " + str);
  }
});

getCertificate²⁴⁺

getCertificate():Promise<X509CertRawData>

在TLSSocketServer通信连接之后，获取本地的数字证书，使用Promise异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<X509CertRawData>	以Promise形式返回本地的数字证书的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2303504	Error looking up x509.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { util } from '@kit.ArkTS';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});
tlsServer.getCertificate().then((data: socket.X509CertRawData) => {
  const decoder = util.TextDecoder.create();
  const str = decoder.decodeToString(data.data);
  console.info("getCertificate: " + str);
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

getProtocol²⁴⁺

getProtocol(callback: AsyncCallback<string>): void

在TLSSocketServer通信连接成功之后，获取通信的协议版本，使用callback异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<string>	是	回调函数，返回通信的协议。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2303505	Error occurred in the tls system call.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});
tlsServer.getProtocol((err: BusinessError, data: string) => {
  if (err) {
    console.error("getProtocol callback error = " + err);
  } else {
    console.info("getProtocol callback = " + data);
  }
});

getProtocol²⁴⁺

getProtocol():Promise<string>

在TLSSocketServer通信连接成功之后，获取通信的协议版本，使用Promise异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<string>	以Promise形式返回通信的协议。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2303505	Error occurred in the tls system call.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});
tlsServer.getProtocol().then((data: string) => {
  console.info(data);
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

getLocalAddress²⁴⁺

getLocalAddress(): Promise<NetAddress>

获取TLSSocketServer的本地Socket地址。使用Promise异步回调。

说明： 在TLSSocketServer通信连接成功之后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取本地socket地址的结果。

错误码：

错误码ID	错误信息
2300002	System internal error.
2301009	Bad file descriptor.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
tlsServer.getLocalAddress().then((localAddress: socket.NetAddress) => {
  console.info("Get success: " + JSON.stringify(localAddress));
}).catch((err: BusinessError) => {
  console.error("Get failed, error: " + JSON.stringify(err));
})

on('connect')²⁴⁺

on(type: 'connect', callback: Callback<TLSSocketConnection>): void

订阅TLSSocketServer的连接事件。使用callback异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'connect'：连接事件。
callback	Callback<TLSSocketConnection>	是	回调函数。失败时返回错误码、错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
  tlsServer.on('connect', (data: socket.TLSSocketConnection) => {
    console.info(JSON.stringify(data));
  });
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});

off('connect')²⁴⁺

off(type: 'connect', callback?: Callback<TLSSocketConnection>): void

取消订阅TLSSocketServer的连接事件。使用callback异步回调。

说明： listen方法调用成功后，才可调用此方法。 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'connect'：连接事件。
callback	Callback<TLSSocketConnection>	否	回调函数。失败时返回错误码、错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});

let callback = (data: socket.TLSSocketConnection) => {
  console.info('on connect message: ' + JSON.stringify(data));
}
tlsServer.on('connect', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tlsServer.off('connect', callback);
tlsServer.off('connect');

on('error')²⁴⁺

on(type: 'error', callback: ErrorCallback): void

订阅TLSSocketServer连接的error事件。使用callback异步回调。

说明： listen方法调用成功后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	是	回调函数。失败时返回错误码、错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});
tlsServer.on('error', (err: BusinessError) => {
  console.error("on error, err:" + JSON.stringify(err))
});

off('error')²⁴⁺

off(type: 'error', callback?: ErrorCallback): void

取消订阅TLSSocketServer连接的error事件。使用callback异步回调。。

说明： listen方法调用成功后，才可调用此方法。 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	否	回调函数。失败时返回错误码、错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed: " + JSON.stringify(err));
});

let callback = (err: BusinessError) => {
  console.error("on error, err:" + JSON.stringify(err));
}
tlsServer.on('error', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tlsServer.off('error', callback);
tlsServer.off('error');

close²⁴⁺

close(): Promise<void>

TLSSocketServer停止监听并释放通过listen方法绑定的端口。使用Promise异步回调。

说明： 该方法不会关闭已有连接。如需关闭，请调用TLSSocketConnection的close方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见Socket错误码和通用错误码。

错误码ID	错误信息
201	Permission denied.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.on('connect', (connection: socket.TLSSocketConnection) => {
  console.info("connection clientId: " + connection.clientId);
  // 逻辑处理
  tlsServer.close(); // 停止监听
  connection.close(); // 关闭当前连接
});
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("listen failed: " + err.code);
});

TLSSocketConnection²⁴⁺

TLSSocketConnection连接，即TLSSocket客户端与服务端的连接。在调用TLSSocketConnection的方法前，需要先获取TLSSocketConnection对象。

说明： 客户端与服务端成功建立连接后，才能通过返回的TLSSocketConnection对象调用相应的接口。

系统能力：SystemCapability.Communication.NetStack

属性

名称	类型	必填	说明	Android平台	iOS平台
clientId	number	是	客户端与TLSSocketServer建立连接的id。	支持	支持

send²⁴⁺

send(data: string, callback: AsyncCallback<void>): void

在TLSSocketServer通信连接成功之后，向客户端发送消息，使用callback异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
data	string	是	TLSSocketServer发送数据所需要的参数。
callback	AsyncCallback<void>	是	回调函数，成功返回空，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2303503	Error in tls writing.
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.send('Hello, client!', (err: BusinessError) => {
    if (err) {
      console.error('send fail');
      return;
    }
    console.info('send success');
  });
});

send²⁴⁺

send(data: string): Promise<void>

在TLSSocketServer通信连接成功之后，向服务端发送消息，使用Promise异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
data	string	是	TLSSocketServer发送数据所需要的参数。

返回值：

类型	说明
Promise<void>	以Promise形式返回，成功返回空，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2303503	Error in tls writing.
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.send('Hello, client!').then(() => {
    console.info('send success');
  }).catch((err: BusinessError) => {
    console.error('send fail');
  });
});

close²⁴⁺

close(callback: AsyncCallback<void>): void

在与TLSSocketServer通信连接成功之后，断开连接，使用callback异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数，成功返回空，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.close((err: BusinessError) => {
    if (err) {
      console.error('close fail');
      return;
    }
    console.info('close success');
  });
});

close²⁴⁺

close(): Promise<void>

在与TLSSocketServer通信连接成功之后，断开连接，使用Promise异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<void>	以Promise形式返回，成功返回空。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2303505	Error occurred in the tls system call.
2303506	Error clearing tls connection.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.close().then(() => {
    console.info('close success');
  }).catch((err: BusinessError) => {
    console.error('close fail');
  });
});

getRemoteAddress²⁴⁺

getRemoteAddress(callback: AsyncCallback<NetAddress>): void

在TLSSocketServer通信连接成功之后，获取对端Socket地址。使用callback异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<NetAddress>	是	回调函数。成功返回对端的socket地址，失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.getRemoteAddress((err: BusinessError, data: socket.NetAddress) => {
    if (err) {
      console.error('getRemoteAddress fail');
      return;
    }
    console.info('getRemoteAddress success:' + JSON.stringify(data));
  });
});

getRemoteAddress²⁴⁺

getRemoteAddress(): Promise<NetAddress>

在TLSSocketServer通信连接成功之后，获取对端Socket地址。使用Promise异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取对端socket地址的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303188	Socket operation on non-socket.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.getRemoteAddress().then((data: socket.NetAddress) => {
    console.info('getRemoteAddress success:' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error("failed" + err);
  });
});

getRemoteCertificate²⁴⁺

getRemoteCertificate(callback: AsyncCallback<X509CertRawData>): void

在TLSSocketServer通信连接成功之后，获取对端的数字证书，该接口只适用于客户端向服务端发送证书时，使用callback异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<X509CertRawData>	是	回调函数，返回对端的证书。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { util } from '@kit.ArkTS';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.getRemoteCertificate((err: BusinessError, data: socket.X509CertRawData) => {
    if (err) {
      console.error("getRemoteCertificate callback error: " + err);
    } else {
      const decoder = util.TextDecoder.create();
      const str = decoder.decodeToString(data.data);
      console.info("getRemoteCertificate callback: " + str);
    }
  });
});

getRemoteCertificate²⁴⁺

getRemoteCertificate():Promise<X509CertRawData>

在TLSSocketServer通信连接成功之后，获取对端的数字证书，该接口只适用于客户端向服务端发送证书时，使用Promise异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<X509CertRawData>	以Promise形式返回对端的数字证书的结果。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { util } from '@kit.ArkTS';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.getRemoteCertificate().then((data: socket.X509CertRawData) => {
    const decoder = util.TextDecoder.create();
    const str = decoder.decodeToString(data.data);
    console.info("getRemoteCertificate success: " + str);
  }).catch((err: BusinessError) => {
    console.error("failed" + err);
  });
});

getCipherSuite²⁴⁺

getCipherSuite(callback: AsyncCallback<Array<string>>): void

在TLSSocketServer通信连接成功之后，获取通信双方协商后的加密套件，使用callback异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<string>>	是	回调函数，返回通信双方支持的加密套件。 失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2303502	Error in tls reading.
2303505	Error occurred in the tls system call.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.getCipherSuite((err: BusinessError, data: Array<string>) => {
    if (err) {
      console.error("getCipherSuite callback error = " + err);
    } else {
      console.info("getCipherSuite callback = " + data);
    }
  });
});

getCipherSuite²⁴⁺

getCipherSuite(): Promise<Array<string>>

在TLSSocketServer通信连接成功之后，获取通信双方协商后的加密套件，使用Promise异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<Array<string>>	以Promise形式返回通信双方支持的加密套件。失败返回错误码，错误信息。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2303502	Error in tls reading.
2303505	Error occurred in the tls system call.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.getCipherSuite().then((data: Array<string>) => {
    console.info('getCipherSuite success:' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error("failed" + err);
  });
});

getSignatureAlgorithms²⁴⁺

getSignatureAlgorithms(callback: AsyncCallback<Array<string>>): void

在TLSSocketServer通信连接成功之后，获取通信双方协商后签名算法，使用callback异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<string>>	是	回调函数，返回双方支持的签名算法。

错误码：

错误码ID	错误信息
401	Parameter error.
2303501	SSL is null.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.getSignatureAlgorithms((err: BusinessError, data: Array<string>) => {
    if (err) {
      console.error("getSignatureAlgorithms callback error = " + err);
    } else {
      console.info("getSignatureAlgorithms callback = " + data);
    }
  });
});

getSignatureAlgorithms²⁴⁺

getSignatureAlgorithms(): Promise<Array<string>>

在TLSSocketServer通信连接成功之后，获取通信双方协商后的签名算法，使用Promise异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<Array<string>>	以Promise形式返回获取到的双方支持的签名算法。

错误码：

错误码ID	错误信息
2303501	SSL is null.
2300002	System internal error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.getSignatureAlgorithms().then((data: Array<string>) => {
    console.info("getSignatureAlgorithms success" + data);
  }).catch((err: BusinessError) => {
    console.error("failed" + err);
  });
});

getLocalAddress²⁴⁺

getLocalAddress(): Promise<NetAddress>

获取TLSSocketConnection连接的本地Socket地址。使用Promise异步回调。

说明： 在TLSSocketServer通信连接成功之后，才可调用此方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

返回值：

类型	说明
Promise<NetAddress>	以Promise形式返回获取本地socket地址的结果。

错误码：

错误码ID	错误信息
2300002	System internal error.
2301009	Bad file descriptor.
2303188	Socket operation on non-socket.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.getLocalAddress().then((localAddress: socket.NetAddress) => {
    console.info("Family IP Port: " + JSON.stringify(localAddress));
  }).catch((err: BusinessError) => {
    console.error("TLS Client Get Family IP Port failed, error: " + JSON.stringify(err));
  })
});

getSocketFd²⁴⁺

getSocketFd(): Promise<number>

获取TLSSocketConnection连接的文件描述符。使用Promise异步回调。

说明：

• 在TLSSocketServer通信连接成功之后，才可调用此方法。
• 连接断开、Socket已关闭（如调用close后）等异常情况下调用本接口会返回-1。
• 文件描述符的生命周期由系统管理，应用可以通过close方法关闭Socket连接，避免直接操作文件描述符进行关闭。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
201	Permission denied.

返回值：

类型	说明
Promise<number>	Promise对象，返回Socket的文件描述符。

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: "xxxx",
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen success");
  tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
    client.getSocketFd().then((fd: number) => {
      console.info(`Socket FD：${fd}`);
    }).catch((err: BusinessError) => {
      console.error(`getSocketFd fail: ${err.message}, errorCode: ${err.code}`);
    })
  });
}).catch((err: BusinessError) => {
  console.error(`listen failed: ${JSON.stringify(err)}`);
});

on('message')¹⁰⁺

on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void

订阅TLSSocketConnection连接的接收消息事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'message'：接收消息事件。
callback	Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: socket.Protocol.TLSv12,
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256"
  },
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.log("listen callback success");
}).catch((err: BusinessError) => {
  console.log("failed" + err);
});

class SocketInfo {
  message: ArrayBuffer = new ArrayBuffer(1);
  remoteInfo: socket.SocketRemoteInfo = {} as socket.SocketRemoteInfo;
}
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.on('message', (value: SocketInfo) => {
    let messageView = '';
    for (let i: number = 0; i < value.message.byteLength; i++) {
      let messages: number = value.message[i]
      let message = String.fromCharCode(messages);
      messageView += message;
    }
    console.log('on message message: ' + JSON.stringify(messageView));
    console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
  });
});

off('message')¹⁰⁺

off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void

取消订阅TLSSocketConnection连接的接收消息事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'message'：接收消息事件。
callback	Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>	否	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: socket.Protocol.TLSv12,
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256"
  },
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.log("listen callback success");
}).catch((err: BusinessError) => {
  console.log("failed" + err);
});

class SocketInfo {
  message: ArrayBuffer = new ArrayBuffer(1);
  remoteInfo: socket.SocketRemoteInfo = {} as socket.SocketRemoteInfo;
}
let callback = (value: SocketInfo) => {
  let messageView = '';
  for (let i: number = 0; i < value.message.byteLength; i++) {
    let messages: number = value.message[i]
    let message = String.fromCharCode(messages);
    messageView += message;
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
}
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.on('message', callback);
  // 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
  client.off('message', callback);
  client.off('message');
});

on('close')²⁴⁺

on(type: 'close', callback: Callback<void>): void

订阅TLSSocketConnection的关闭事件。使用callback异步回调。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'close'：关闭事件。
callback	Callback<void>	是	回调函数。成功时返回空，失败时返回错误码、错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.on('close', () => {
    console.info("on close success")
  });
});

off('close')²⁴⁺

off(type: 'close', callback?: Callback<void>): void

取消订阅TLSSocketConnection的关闭事件。使用callback异步回调。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

支持平台： Android 、iOS

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'close'：关闭事件。
callback	Callback<void>	否	回调函数。成功时返回空，失败时返回错误码、错误信息。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import { socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let netAddress: socket.NetAddress = {
  address: '192.168.xx.xxx',
  port: 8080
}
let tlsSecureOptions: socket.TLSSecureOptions = {
  key: "xxxx",
  cert: ["xxxx"],
  ca: ["xxxx"],
  password: "xxxx",
  protocols: socket.Protocol.TLSv12,
  useRemoteCipherPrefer: true,
  signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
  cipherSuite: "AES256-SHA256"
}
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: netAddress,
  secureOptions: tlsSecureOptions,
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.info("listen callback success");
}).catch((err: BusinessError) => {
  console.error("failed" + err);
});

let callback = () => {
  console.info("on close success");
}
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.on('close', callback);
  // 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
  client.off('close', callback);
  client.off('close');
});

on('error')¹⁰⁺

on(type: 'error', callback: ErrorCallback): void

订阅TLSSocketConnection连接的error事件。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	是	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: socket.Protocol.TLSv12,
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256"
  },
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.log("listen callback success");
}).catch((err: BusinessError) => {
  console.log("failed" + err);
});

tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.on('error', (err: BusinessError) => {
    console.log("on error, err:" + JSON.stringify(err))
  });
});

off('error')¹⁰⁺

off(type: 'error', callback?: ErrorCallback): void

取消订阅TLSSocketConnection连接的error事件。使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。'error'：error事件。
callback	ErrorCallback	否	回调函数。

错误码：

错误码ID	错误信息
401	Parameter error.

示例：

import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
let tlsConnectOptions: socket.TLSConnectOptions = {
  address: {
    address: '192.168.xx.xxx',
    port: 8080
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: socket.Protocol.TLSv12,
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256"
  },
  ALPNProtocols: ["spdy/1", "http/1.1"]
}
tlsServer.listen(tlsConnectOptions).then(() => {
  console.log("listen callback success");
}).catch((err: BusinessError) => {
  console.log("failed" + err);
});

let callback = (err: BusinessError) => {
  console.log("on error, err:" + JSON.stringify(err));
}
tlsServer.on('connect', (client: socket.TLSSocketConnection) => {
  client.on('error', callback);
  // 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
  client.off('error', callback);
  client.off('error');
});