harmony 鸿蒙@ohos.net.socket (Socket连接)
@ohos.net.socket (Socket连接)
本模块提供利用Socket进行数据传输的能力,支持TCPSocket、UDPSocket、WebSocket和TLSSocket。
说明:
本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import socket from '@ohos.net.socket';
socket.constructUDPSocketInstance7+
constructUDPSocketInstance(): UDPSocket
创建一个UDPSocket对象。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
UDPSocket | 返回一个UDPSocket对象。 |
示例:
import socket from '@ohos.net.socket';
let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
UDPSocket7+
UDPSocket连接。在调用UDPSocket的方法前,需要先通过socket.constructUDPSocketInstance创建UDPSocket对象。
bind7+
bind(address: NetAddress, callback: AsyncCallback<void>): void
绑定IP地址和端口,端口可以指定或由系统随机分配。使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
bind7+
bind(address: NetAddress): Promise<void>
绑定IP地址和端口,端口可以指定或由系统随机分配。使用Promise方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
send7+
send(options: UDPSendOptions, callback: AsyncCallback<void>): void
通过UDPSocket连接发送数据。使用callback方式作为异步方法。
发送数据前,需要先调用UDPSocket.bind()绑定IP地址和端口。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
send7+
send(options: UDPSendOptions): Promise<void>
通过UDPSocket连接发送数据。使用Promise方式作为异步方法。
发送数据前,需要先调用UDPSocket.bind()绑定IP地址和端口。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
close7+
close(callback: AsyncCallback<void>): void
关闭UDPSocket连接。使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
})
close7+
close(): Promise<void>
关闭UDPSocket连接。使用Promise方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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');
});
getState7+
getState(callback: AsyncCallback<SocketStateBase>): void
获取UDPSocket状态。使用callback方式作为异步方法。
说明: bind方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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));
})
})
getState7+
getState(): Promise<SocketStateBase>
获取UDPSocket状态。使用Promise方式作为异步方法。
说明: bind方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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));
});
});
setExtraOptions7+
setExtraOptions(options: UDPExtraOptions, callback: AsyncCallback<void>): void
设置UDPSocket连接的其他属性。使用callback方式作为异步方法。
说明: bind方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
})
})
setExtraOptions7+
setExtraOptions(options: UDPExtraOptions): Promise<void>
设置UDPSocket连接的其他属性。使用Promise方式作为异步方法。
说明: bind方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
})
on(‘message’)7+
on(type: ‘message’, callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void
订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)7+
off(type: ‘message’, callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void
取消订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)7+
on(type: ‘listening’|‘close’, callback: Callback<void>): void
订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)7+
off(type: ‘listening’|‘close’, callback?: Callback<void>): void
取消订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)7+
on(type: ‘error’, callback: ErrorCallback): void
订阅UDPSocket连接的error事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)7+
off(type: ‘error’, callback?: ErrorCallback): void
取消订阅UDPSocket连接的error事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
NetAddress7+
目标地址信息。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
address | string | 是 | 本地绑定的ip地址。 |
port | number | 否 | 端口号 ,范围0~65535。如果不指定系统随机分配端口。 |
family | number | 否 | 网络协议类型,可选类型: - 1:IPv4 - 2:IPv6 默认为1。 |
UDPSendOptions7+
UDPSocket发送参数。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
data | string |ArrayBuffer7+ | 是 | 发送的数据。 |
address | NetAddress | 是 | 目标地址信息。 |
UDPExtraOptions7+
UDPSocket连接的其他属性。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
broadcast | boolean | 否 | 是否可以发送广播。默认为false。 |
receiveBufferSize | number | 否 | 接收缓冲区大小(单位:Byte),默认为0。 |
sendBufferSize | number | 否 | 发送缓冲区大小(单位:Byte),默认为0。 |
reuseAddress | boolean | 否 | 是否重用地址。默认为false。 |
socketTimeout | number | 否 | 套接字超时时间,单位毫秒(ms),默认为0。 |
SocketStateBase7+
Socket的状态信息。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
isBound | boolean | 是 | 是否绑定。 |
isClose | boolean | 是 | 是否关闭。 |
isConnected | boolean | 是 | 是否连接。 |
SocketRemoteInfo7+
Socket的连接信息。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
address | string | 是 | 本地绑定的ip地址。 |
family | string | 是 | 网络协议类型,可选类型: - IPv4 - IPv6 默认为IPv4。 |
port | number | 是 | 端口号,范围0~65535。 |
size | number | 是 | 服务器响应信息的字节长度。 |
UDP 错误码说明
UDP 其余错误码映射形式为:2301000 + Linux内核错误码。
错误码的详细介绍参见Socket错误码
socket.constructTCPSocketInstance7+
constructTCPSocketInstance(): TCPSocket
创建一个TCPSocket对象。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
TCPSocket | 返回一个TCPSocket对象。 |
示例:
import socket from "@ohos.net.socket";
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
TCPSocket7+
TCPSocket连接。在调用TCPSocket的方法前,需要先通过socket.constructTCPSocketInstance创建TCPSocket对象。
bind7+
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
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
})
bind7+
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
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
connect7+
connect(options: TCPConnectOptions, callback: AsyncCallback<void>): void
连接到指定的IP地址和端口。使用callback方法作为异步方法。
说明: 在没有执行tcp.bind的情况下,也可以直接调用该接口完成与TCP服务端的连接
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
})
connect7+
connect(options: TCPConnectOptions): Promise<void>
连接到指定的IP地址和端口。使用promise方法作为异步方法。
说明: 在没有执行tcp.bind的情况下,也可以直接调用该接口完成与TCP服务端的连接。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
send7+
send(options: TCPSendOptions, callback: AsyncCallback<void>): void
通过TCPSocket连接发送数据。使用callback方式作为异步方法。
说明: connect方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
})
})
send7+
send(options: TCPSendOptions): Promise<void>
通过TCPSocket连接发送数据。使用Promise方式作为异步方法。
说明: connect方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
})
close7+
close(callback: AsyncCallback<void>): void
关闭TCPSocket连接。使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
})
close7+
close(): Promise<void>
关闭TCPSocket连接。使用Promise方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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');
});
getRemoteAddress7+
getRemoteAddress(callback: AsyncCallback<NetAddress>): void
获取对端Socket地址。使用callback方式作为异步方法。
说明: connect方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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));
})
});
getRemoteAddress7+
getRemoteAddress(): Promise<NetAddress>
获取对端Socket地址。使用Promise方式作为异步方法。
说明: connect方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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');
});
getState7+
getState(callback: AsyncCallback<SocketStateBase>): void
获取TCPSocket状态。使用callback方式作为异步方法。
说明: bind或connect方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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));
});
});
getState7+
getState(): Promise<SocketStateBase>
获取TCPSocket状态。使用Promise方式作为异步方法。
说明: bind或connect方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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');
});
getSocketFd10+
getSocketFd(callback: AsyncCallback<number>): void
获取TCPSocket的文件描述符。使用callback方式作为异步方法。
说明: bind或connect方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<number> | 是 | 回调函数,当成功时,返回socket的文件描述符,失败时,返回undefined。 |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let bindAddr: socket.NetAddress = {
address: '0.0.0.0'
}
tcp.bind(bindAddr)
let tcpconnectoptions: socket.TCPConnectOptions = {
address: {
address: '192.168.xx.xxx',
port: 8080
},
timeout: 6000
}
tcp.connect(tcpconnectoptions)
tcp.getSocketFd((err: BusinessError, data: number) => {
console.info("getSocketFd failed: " + err);
console.info("tunenlfd: " + data);
})
getSocketFd10+
getSocketFd(): Promise<number>
获取TCPSocket的文件描述符。使用Promise方式作为异步方法。
说明: bind或connect方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
Promise<number> | 以Promise形式返回socket的文件描述符。 |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
let bindAddr: socket.NetAddress = {
address: '0.0.0.0'
}
tcp.bind(bindAddr)
let tcpconnectoptions: socket.TCPConnectOptions = {
address: {
address: '192.168.xx.xxx',
port: 8080
},
timeout: 6000
}
tcp.connect(tcpconnectoptions)
tcp.getSocketFd().then((data: number) => {
console.info("tunenlfd: " + data);
})
setExtraOptions7+
setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback<void>): void
设置TCPSocket连接的其他属性。使用callback方式作为异步方法。
说明: bind或connect方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
});
setExtraOptions7+
setExtraOptions(options: TCPExtraOptions): Promise<void>
设置TCPSocket连接的其他属性,使用Promise方式作为异步方法。
说明: bind或connect方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
});
on(‘message’)7+
on(type: ‘message’, callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void
订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)7+
off(type: ‘message’, callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void
取消订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)7+
on(type: ‘connect’|‘close’, callback: Callback<void>): void
订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)7+
off(type: ‘connect’|‘close’, callback?: Callback<void>): void
取消订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)7+
on(type: ‘error’, callback: ErrorCallback): void
订阅TCPSocket连接的error事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)7+
off(type: ‘error’, callback?: ErrorCallback): void
取消订阅TCPSocket连接的error事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
TCPConnectOptions7+
TCPSocket连接的参数。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
address | NetAddress | 是 | 绑定的地址以及端口。 |
timeout | number | 否 | 超时时间,单位毫秒(ms)。 |
TCPSendOptions7+
TCPSocket发送请求的参数。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
data | string|ArrayBuffer7+ | 是 | 发送的数据。 |
encoding | string | 否 | 字符编码(UTF-8,UTF-16BE,UTF-16LE,UTF-16,US-AECII,ISO-8859-1),默认为UTF-8。 |
TCPExtraOptions7+
TCPSocket连接的其他属性。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
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.constructTCPSocketServerInstance10+
constructTCPSocketServerInstance(): TCPSocketServer
创建一个TCPSocketServer对象。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
TCPSocketServer | 返回一个TCPSocketServer对象。 |
示例:
import socket from "@ohos.net.socket";
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
TCPSocketServer10+
TCPSocketServer连接。在调用TCPSocketServer的方法前,需要先通过socket.constructTCPSocketServerInstance创建TCPSocketServer对象。
listen10+
listen(address: NetAddress, callback: AsyncCallback<void>): void
绑定IP地址和端口,端口可以指定或由系统随机分配。监听并接受与此套接字建立的TCPSocket连接。该接口使用多线程并发处理客户端的数据。使用callback方法作为异步方法。
说明: 服务端使用该方法完成bind,listen,accept操作,bind方法失败会由系统随机分配端口号。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
address | NetAddress | 是 | 目标地址信息。 |
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. |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
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.log("listen fail");
return;
}
console.log("listen success");
})
listen10+
listen(address: NetAddress): Promise<void>
绑定IP地址和端口,端口可以指定或由系统随机分配。监听并接受与此套接字建立的TCPSocket连接。该接口使用多线程并发处理客户端的数据。使用Promise方法作为异步方法。
说明: 服务端使用该方法完成bind,listen,accept操作,bind方法失败会由系统随机分配端口号。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
address | NetAddress | 是 | 目标地址信息。 |
返回值:
类型 | 说明 |
---|---|
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. |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let listenAddr: socket.NetAddress = {
address: '192.168.xx.xxx',
port: 8080,
family: 1
}
tcpServer.listen(listenAddr).then(() => {
console.log('listen success');
}).catch((err: BusinessError) => {
console.log('listen fail');
});
getState10+
getState(callback: AsyncCallback<SocketStateBase>): void
获取TCPSocketServer状态。使用callback方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<SocketStateBase> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
2300002 | System internal error. |
2303188 | Socket operation on non-socket. |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
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.log("listen fail");
return;
}
console.log("listen success");
})
tcpServer.getState((err: BusinessError, data: socket.SocketStateBase) => {
if (err) {
console.log('getState fail');
return;
}
console.log('getState success:' + JSON.stringify(data));
})
getState10+
getState(): Promise<SocketStateBase>
获取TCPSocketServer状态。使用Promise方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
Promise<SocketStateBase> | 以Promise形式返回获取TCPSocket状态的结果。 |
错误码:
错误码ID | 错误信息 |
---|---|
201 | Permission denied. |
2300002 | System internal error. |
2303188 | Socket operation on non-socket. |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
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.log("listen fail");
return;
}
console.log("listen success");
})
tcpServer.getState().then((data: socket.SocketStateBase) => {
console.log('getState success' + JSON.stringify(data));
}).catch((err: BusinessError) => {
console.log('getState fail');
});
setExtraOptions10+
setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback<void>): void
设置TCPSocketServer连接的其他属性。使用callback方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
options | TCPExtraOptions | 是 | TCPSocketServer连接的其他属性。 |
callback | AsyncCallback<void> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
2300002 | System internal error. |
2303188 | Socket operation on non-socket. |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
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.log("listen fail");
return;
}
console.log("listen success");
})
let tcpExtraOptions: socket.TCPExtraOptions = {
keepAlive: true,
OOBInline: true,
TCPNoDelay: true,
socketLinger: { on: true, linger: 10 },
receiveBufferSize: 1000,
sendBufferSize: 1000,
reuseAddress: true,
socketTimeout: 3000
}
tcpServer.setExtraOptions(tcpExtraOptions, (err: BusinessError) => {
if (err) {
console.log('setExtraOptions fail');
return;
}
console.log('setExtraOptions success');
});
setExtraOptions10+
setExtraOptions(options: TCPExtraOptions): Promise<void>
设置TCPSocketServer连接的其他属性,使用Promise方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
options | TCPExtraOptions | 是 | TCPSocketServer连接的其他属性。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
2300002 | System internal error. |
2303188 | Socket operation on non-socket. |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
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.log("listen fail");
return;
}
console.log("listen success");
})
let tcpExtraOptions: socket.TCPExtraOptions = {
keepAlive: true,
OOBInline: true,
TCPNoDelay: true,
socketLinger: { on: true, linger: 10 },
receiveBufferSize: 1000,
sendBufferSize: 1000,
reuseAddress: true,
socketTimeout: 3000
}
tcpServer.setExtraOptions(tcpExtraOptions).then(() => {
console.log('setExtraOptions success');
}).catch((err: BusinessError) => {
console.log('setExtraOptions fail');
});
on(‘connect’)10+
on(type: ‘connect’, callback: Callback<TCPSocketConnection>): void
订阅TCPSocketServer的连接事件。使用callback方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 订阅的事件类型。’connect’:连接事件。 |
callback | Callback<TCPSocketConnection> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
示例:
import socket from "@ohos.net.socket";
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (data: socket.TCPSocketConnection) => {
console.log(JSON.stringify(data))
});
off(‘connect’)10+
off(type: ‘connect’, callback?: Callback<TCPSocketConnection>): void
取消订阅TCPSocketServer的连接事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 订阅的事件类型。’connect’:连接事件。 |
callback | Callback<TCPSocketConnection> | 否 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
示例:
import socket from "@ohos.net.socket";
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let callback = (data: socket.TCPSocketConnection) => {
console.log('on connect message: ' + JSON.stringify(data));
}
tcpServer.on('connect', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcpServer.off('connect', callback);
tcpServer.off('connect');
on(‘error’)10+
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’)10+
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');
TCPSocketConnection10+
TCPSocketConnection连接,即TCPSocket客户端与服务端的连接。在调用TCPSocketConnection的方法前,需要先获取TCPSocketConnection对象。
说明: 客户端与服务端成功建立连接后,才能通过返回的TCPSocketConnection对象调用相应的接口。
系统能力:SystemCapability.Communication.NetStack
属性
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
clientId | number | 是 | 客户端与TCPSocketServer建立连接的id。 |
send10+
send(options: TCPSendOptions, callback: AsyncCallback<void>): void
通过TCPSocketConnection连接发送数据。使用callback方式作为异步方法。
说明: 与客户端建立连接后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
options | TCPSendOptions | 是 | TCPSocketConnection发送请求的参数。 |
callback | AsyncCallback<void> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
2300002 | System internal error. |
示例:
import socket from "@ohos.net.socket";
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
let tcpSendOption: socket.TCPSendOptions = {
data: 'Hello, client!'
}
client.send(tcpSendOption, () => {
console.log('send success');
});
});
send10+
send(options: TCPSendOptions): Promise<void>
通过TCPSocketConnection连接发送数据。使用Promise方式作为异步方法。
说明: 与客户端建立连接后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
options | TCPSendOptions | 是 | TCPSocketConnection发送请求的参数。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
2300002 | System internal error. |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
let tcpSendOption: socket.TCPSendOptions = {
data: 'Hello, client!'
}
client.send(tcpSendOption).then(() => {
console.log('send success');
}).catch((err: BusinessError) => {
console.log('send fail');
});
});
close10+
close(callback: AsyncCallback<void>): void
关闭一个与TCPSocket建立的连接。使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
2300002 | System internal 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.close((err: BusinessError) => {
if (err) {
console.log('close fail');
return;
}
console.log('close success');
});
});
close10+
close(): Promise<void>
关闭一个与TCPSocket建立的连接。使用Promise方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
Promise<void> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 |
错误码:
错误码ID | 错误信息 |
---|---|
201 | Permission denied. |
2300002 | System internal error. |
示例:
import socket from "@ohos.net.socket";
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
client.close().then(() => {
console.log('close success');
}).catch((err: BusinessError) => {
console.log('close fail');
});
});
getRemoteAddress10+
getRemoteAddress(callback: AsyncCallback<NetAddress>): void
获取对端Socket地址。使用callback方式作为异步方法。
说明: 与客户端建立连接后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<NetAddress> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
2300002 | System internal error. |
2303188 | Socket operation on non-socket. |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
client.getRemoteAddress((err: BusinessError, data: socket.NetAddress) => {
if (err) {
console.log('getRemoteAddress fail');
return;
}
console.log('getRemoteAddress success:' + JSON.stringify(data));
});
});
getRemoteAddress10+
getRemoteAddress(): Promise<NetAddress>
获取对端Socket地址。使用Promise方式作为异步方法。
说明: 与客户端建立连接后,才可调用此方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
Promise<NetAddress> | 以Promise形式返回获取对端socket地址的结果。 |
错误码:
错误码ID | 错误信息 |
---|---|
201 | Permission denied. |
2300002 | System internal error. |
2303188 | Socket operation on non-socket. |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', (client: socket.TCPSocketConnection) => {
client.getRemoteAddress().then(() => {
console.log('getRemoteAddress success');
}).catch((err: BusinessError) => {
console.log('getRemoteAddress fail');
});
});
on(‘message’)10+
on(type: ‘message’, callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void
订阅TCPSocketConnection连接的接收消息事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)10+
off(type: ‘message’, callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void
取消订阅TCPSocketConnection连接的接收消息事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)10+
on(type: ‘close’, callback: Callback<void>): void
订阅TCPSocketConnection的关闭事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 订阅的事件类型。’close’:关闭事件。 |
callback | Callback<void> | 是 | 回调函数。 |
错误码:
错误码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('close', () => {
console.log("on close success")
});
});
off(‘close’)10+
off(type: ‘close’, callback?: Callback<void>): void
取消订阅TCPSocketConnection的关闭事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 订阅的事件类型。’close’:关闭事件。 |
callback | Callback<void> | 否 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
示例:
import socket from "@ohos.net.socket";
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
let callback = () => {
console.log("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’)10+
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’)10+
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');
});
TCP 错误码说明
TCP 其余错误码映射形式为:2301000 + Linux内核错误码。
错误码的详细介绍参见Socket错误码
socket.constructTLSSocketInstance9+
constructTLSSocketInstance(): TLSSocket
创建并返回一个TLSSocket对象。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
TLSSocket | 返回一个TLSSocket对象。 |
示例:
import socket from "@ohos.net.socket";
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
TLSSocket9+
TLSSocket连接。在调用TLSSocket的方法前,需要先通过socket.constructTLSSocketInstance创建TLSSocket对象。
bind9+
bind(address: NetAddress, callback: AsyncCallback<void>): void
绑定IP地址和端口。使用callback方法作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
bind9+
bind(address: NetAddress): Promise<void>
绑定IP地址和端口。使用Promise方法作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
getState9+
getState(callback: AsyncCallback<SocketStateBase>): void
在TLSSocket的bind成功之后,获取TLSSocket状态。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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));
});
getState9+
getState(): Promise<SocketStateBase>
在TLSSocket的bind成功之后,获取TLSSocket状态。使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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');
});
setExtraOptions9+
setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback<void>): void
在TLSSocket的bind成功之后,设置TCPSocket连接的其他属性。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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');
});
setExtraOptions9+
setExtraOptions(options: TCPExtraOptions): Promise<void>
在TLSSocket的bind成功之后,设置TCPSocket连接的其他属性,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)9+
on(type: ‘message’, callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void;
订阅TLSSocket连接的接收消息事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)9+
off(type: ‘message’, callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void
取消订阅TLSSocket连接的接收消息事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)9+
on(type: ‘connect’|‘close’, callback: Callback<void>): void
订阅TLSSocket的连接事件或关闭事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)9+
off(type: ‘connect’|‘close’, callback?: Callback<void>): void
取消订阅TLSSocket的连接事件或关闭事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)9+
on(type: ‘error’, callback: ErrorCallback): void
订阅TLSSocket连接的error事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)9+
off(type: ‘error’, callback?: ErrorCallback): void
取消订阅TLSSocket连接的error事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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);
connect9+
connect(options: TLSConnectOptions, callback: AsyncCallback<void>): void
在TLSSocket上bind成功之后,进行通信连接,并创建和初始化TLS会话,实现建立连接过程,启动与服务器的TLS/SSL握手,实现数据传输功能,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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"],
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, (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);
});
connect9+
connect(options: TLSConnectOptions): Promise<void>
在TLSSocket上bind成功之后,进行通信连接,并创建和初始化TLS会话,实现建立连接过程,启动与服务器的TLS/SSL握手,实现数据传输功能,该连接包括两种认证方式,单向认证与双向认证,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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));
});
getRemoteAddress9+
getRemoteAddress(callback: AsyncCallback<NetAddress>): void
在TLSSocket通信连接成功之后,获取对端Socket地址。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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));
});
getRemoteAddress9+
getRemoteAddress(): Promise<NetAddress>
在TLSSocket通信连接成功之后,获取对端Socket地址。使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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');
});
getCertificate9+
getCertificate(callback: AsyncCallback<X509CertRawData>): void
在TLSSocket通信连接成功之后,获取本地的数字证书,该接口只适用于双向认证时,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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);
}
});
getCertificate9+
getCertificate():Promise<X509CertRawData>
在TLSSocket通信连接之后,获取本地的数字证书,该接口只适用于双向认证时,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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);
});
getRemoteCertificate9+
getRemoteCertificate(callback: AsyncCallback<X509CertRawData>): void
在TLSSocket通信连接成功之后,获取服务端的数字证书,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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);
}
});
getRemoteCertificate9+
getRemoteCertificate():Promise<X509CertRawData>
在TLSSocket通信连接成功之后,获取服务端的数字证书,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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);
});
getProtocol9+
getProtocol(callback: AsyncCallback<string>): void
在TLSSocket通信连接成功之后,获取通信的协议版本,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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);
}
});
getProtocol9+
getProtocol():Promise<string>
在TLSSocket通信连接成功之后,获取通信的协议版本,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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);
});
getCipherSuite9+
getCipherSuite(callback: AsyncCallback<Array<string>>): void
在TLSSocket通信连接成功之后,获取通信双方协商后的加密套件,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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);
}
});
getCipherSuite9+
getCipherSuite(): Promise<Array<string>>
在TLSSocket通信连接成功之后,获取通信双方协商后的加密套件,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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);
});
getSignatureAlgorithms9+
getSignatureAlgorithms(callback: AsyncCallback<Array<string>>): void
在TLSSocket通信连接成功之后,获取通信双方协商后签名算法,该接口只适配双向认证模式下,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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);
}
});
getSignatureAlgorithms9+
getSignatureAlgorithms(): Promise<Array<string>>
在TLSSocket通信连接成功之后,获取通信双方协商后的签名算法,该接口只适配双向认证模式下,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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);
});
send9+
send(data: string, callback: AsyncCallback<void>): void
在TLSSocket通信连接成功之后,向服务端发送消息,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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");
}
});
send9+
send(data: string): Promise<void>
在TLSSocket通信连接成功之后,向服务端发送消息,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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);
});
close9+
close(callback: AsyncCallback<void>): void
在TLSSocket通信连接成功之后,断开连接,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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");
}
});
close9+
close(): Promise<void>
在TLSSocket通信连接成功之后,断开连接,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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);
});
TLSConnectOptions9+
TLS连接的操作。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
address | NetAddress | 是 | 网关地址。 |
secureOptions | TLSSecureOptions | 是 | TLS安全相关操作。 |
ALPNProtocols | Array<string> | 否 | ALPN协议,支持[“spdy/1”, “http/1.1”],默认为[]。 |
TLSSecureOptions9+
TLS安全相关操作,其中ca证书为必选参数,其他参数为可选参数。当本地证书cert和私钥key不为空时,开启双向验证模式。cert和key其中一项为空时,开启单向验证模式。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
ca | string |Array<string> | 是 | 服务端的ca证书,用于认证校验服务端的数字证书。 |
cert | string | 否 | 本地客户端的数字证书。 |
key | string | 否 | 本地数字证书的私钥。 |
password | string | 否 | 读取私钥的密码。 |
protocols | Protocol |Array<Protocol> | 否 | TLS的协议版本,默认为”TLSv1.2”。 |
useRemoteCipherPrefer | boolean | 否 | 优先使用对等方的密码套件。 |
signatureAlgorithms | string | 否 | 通信过程中的签名算法,默认为”” 。 |
cipherSuite | string | 否 | 通信过程中的加密套件,默认为”” 。 |
Protocol9+
TLS通信的协议版本。
系统能力:SystemCapability.Communication.NetStack
名称 | 值 | 说明 |
---|---|---|
TLSv12 | “TLSv1.2” | 使用TLSv1.2协议通信。 |
TLSv13 | “TLSv1.3” | 使用TLSv1.3协议通信。 |
X509CertRawData9+
存储证书的数据。
系统能力:SystemCapability.Communication.NetStack
socket.constructTLSSocketServerInstance10+
constructTLSSocketServerInstance(): TLSSocketServer
创建并返回一个TLSSocketServer对象。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
TLSSocketServer | 返回一个TLSSocketServer对象。 |
示例:
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
TLSSocketServer10+
TLSSocketServer连接。在调用TLSSocketServer的方法前,需要先通过socket.constructTLSSocketServerInstance创建TLSSocketServer对象。
listen10+
listen(options: TLSConnectOptions, callback: AsyncCallback<void>): void
绑定IP地址和端口,在TLSSocketServer上bind成功之后,监听客户端的连接,创建和初始化TLS会话,实现建立连接过程,加载证书秘钥并验证,使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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 "@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, (err: BusinessError) => {
console.log("listen callback error" + err);
});
listen10+
listen(options: TLSConnectOptions): Promise<void>
绑定IP地址和端口,在TLSSocketServer上bind成功之后,监听客户端的连接,并创建和初始化TLS会话,实现建立连接过程,加载证书秘钥并验证,使用Promise方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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 "@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: " + JSON.stringify(err));
});
getState10+
getState(callback: AsyncCallback<SocketStateBase>): void
在TLSSocketServer的listen成功之后,获取TLSSocketServer状态。使用callback方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<SocketStateBase> | 是 | 回调函数。成功返回TLSSocketServer状态,失败返回错误码,错误信息。 |
错误码:
错误码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 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: " + JSON.stringify(err));
});
tlsServer.getState((err: BusinessError, data: socket.SocketStateBase) => {
if (err) {
console.log('getState fail');
return;
}
console.log('getState success:' + JSON.stringify(data));
});
getState10+
getState(): Promise<SocketStateBase>
在TLSSocketServer的listen成功之后,获取TLSSocketServer状态。使用Promise方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
Promise<SocketStateBase> | 以Promise形式返回获取TLSSocketServer状态的结果。失败返回错误码,错误信息。 |
错误码:
错误码ID | 错误信息 |
---|---|
2303188 | Socket operation on non-socket. |
2300002 | System internal 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: " + JSON.stringify(err));
});
tlsServer.getState().then(() => {
console.log('getState success');
}).catch((err: BusinessError) => {
console.log('getState fail');
});
setExtraOptions10+
setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback<void>): void
在TLSSocketServer的listen成功之后,设置TLSSocketServer连接的其他属性。使用callback方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
options | TCPExtraOptions | 是 | TLSSocketServer连接的其他属性。 |
callback | AsyncCallback<void> | 是 | 回调函数。成功返回空,失败返回错误码,错误信息。 |
错误码:
错误码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 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: " + JSON.stringify(err));
});
let tcpExtraOptions: socket.TCPExtraOptions = {
keepAlive: true,
OOBInline: true,
TCPNoDelay: true,
socketLinger: { on: true, linger: 10 },
receiveBufferSize: 1000,
sendBufferSize: 1000,
reuseAddress: true,
socketTimeout: 3000
}
tlsServer.setExtraOptions(tcpExtraOptions, (err: BusinessError) => {
if (err) {
console.log('setExtraOptions fail');
return;
}
console.log('setExtraOptions success');
});
setExtraOptions10+
setExtraOptions(options: TCPExtraOptions): Promise<void>
在TLSSocketServer的listen成功之后,设置TLSSocketServer连接的其他属性,使用Promise方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
options | TCPExtraOptions | 是 | TLSSocketServer连接的其他属性。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 以Promise形式返回,成功返回空,失败返回错误码,错误信息。 |
错误码:
错误码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 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: " + JSON.stringify(err));
});
let tcpExtraOptions: socket.TCPExtraOptions = {
keepAlive: true,
OOBInline: true,
TCPNoDelay: true,
socketLinger: { on: true, linger: 10 },
receiveBufferSize: 1000,
sendBufferSize: 1000,
reuseAddress: true,
socketTimeout: 3000
}
tlsServer.setExtraOptions(tcpExtraOptions).then(() => {
console.log('setExtraOptions success');
}).catch((err: BusinessError) => {
console.log('setExtraOptions fail');
});
getCertificate10+
getCertificate(callback: AsyncCallback<X509CertRawData>): void
在TLSSocketServer通信连接成功之后,获取本地的数字证书,使用callback方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<X509CertRawData> | 是 | 回调函数,成功返回本地的证书,失败返回错误码,错误信息。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
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 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: " + JSON.stringify(err));
});
tlsServer.getCertificate((err: BusinessError, data: socket.X509CertRawData) => {
if (err) {
console.log("getCertificate callback error = " + err);
} else {
console.log("getCertificate callback = " + data);
}
});
getCertificate10+
getCertificate():Promise<X509CertRawData>
在TLSSocketServer通信连接之后,获取本地的数字证书,使用Promise方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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 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: " + JSON.stringify(err));
});
tlsServer.getCertificate().then((data: socket.x509certrawdata9) => {
console.log(data);
}).catch((err: BusinessError) => {
console.error("failed" + err);
});
getProtocol10+
getProtocol(callback: AsyncCallback<string>): void
在TLSSocketServer通信连接成功之后,获取通信的协议版本,使用callback方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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 "@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: " + JSON.stringify(err));
});
tlsServer.getProtocol((err: BusinessError, data: string) => {
if (err) {
console.log("getProtocol callback error = " + err);
} else {
console.log("getProtocol callback = " + data);
}
});
getProtocol10+
getProtocol():Promise<string>
在TLSSocketServer通信连接成功之后,获取通信的协议版本,使用Promise方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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 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: " + JSON.stringify(err));
});
tlsServer.getProtocol().then((data: string) => {
console.log(data);
}).catch((err: BusinessError) => {
console.error("failed" + err);
});
on(‘connect’)10+
on(type: ‘connect’, callback: Callback<TLSSocketConnection>): void
订阅TLSSocketServer的连接事件。使用callback方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 订阅的事件类型。’connect’:连接事件。 |
callback | Callback<TLSSocketConnection> | 是 | 回调函数。 |
错误码:
错误码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: " + JSON.stringify(err));
});
tlsServer.on('connect', (data: socket.TLSSocketConnection) => {
console.log(JSON.stringify(data))
});
off(‘connect’)10+
off(type: ‘connect’, callback?: Callback<TLSSocketConnection>): void
取消订阅TLSSocketServer的连接事件。使用callback方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 订阅的事件类型。’connect’:连接事件。 |
callback | Callback<TLSSocketConnection> | 否 | 回调函数。 |
错误码:
错误码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: " + JSON.stringify(err));
});
let callback = (data: socket.TLSSocketConnection) => {
console.log('on connect message: ' + JSON.stringify(data));
}
tlsServer.on('connect', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tlsServer.off('connect', callback);
tlsServer.off('connect');
on(‘error’)10+
on(type: ‘error’, callback: ErrorCallback): void
订阅TLSSocketServer连接的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 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: " + JSON.stringify(err));
});
tlsServer.on('error', (err: BusinessError) => {
console.log("on error, err:" + JSON.stringify(err))
});
off(‘error’)10+
off(type: ‘error’, callback?: ErrorCallback): void
取消订阅TLSSocketServer连接的error事件。使用callback方式作为异步方法。
说明: listen方法调用成功后,才可调用此方法。 可以指定传入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: " + JSON.stringify(err));
});
let callback = (err: BusinessError) => {
console.log("on error, err:" + JSON.stringify(err));
}
tlsServer.on('error', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tlsServer.off('error', callback);
tlsServer.off('error');
TLSSocketConnection10+
TLSSocketConnection连接,即TLSSocket客户端与服务端的连接。在调用TLSSocketConnection的方法前,需要先获取TLSSocketConnection对象。
说明: 客户端与服务端成功建立连接后,才能通过返回的TLSSocketConnection对象调用相应的接口。
系统能力:SystemCapability.Communication.NetStack
属性
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
clientId | number | 是 | 客户端与TLSSocketServer建立连接的id。 |
send10+
send(data: string, callback: AsyncCallback<void>): void
在TLSSocketServer通信连接成功之后,向客户端发送消息,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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 "@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.send('Hello, client!', (err: BusinessError) => {
if (err) {
console.log('send fail');
return;
}
console.log('send success');
});
});
send10+
send(data: string): Promise<void>
在TLSSocketServer通信连接成功之后,向服务端发送消息,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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 "@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.send('Hello, client!').then(() => {
console.log('send success');
}).catch((err: BusinessError) => {
console.log('send fail');
});
});
close10+
close(callback: AsyncCallback<void>): void
在与TLSSocketServer通信连接成功之后,断开连接,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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 "@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.close((err: BusinessError) => {
if (err) {
console.log('close fail');
return;
}
console.log('close success');
});
});
close10+
close(): Promise<void>
在与TLSSocketServer通信连接成功之后,断开连接,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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 "@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.close().then(() => {
console.log('close success');
}).catch((err: BusinessError) => {
console.log('close fail');
});
});
getRemoteAddress10+
getRemoteAddress(callback: AsyncCallback<NetAddress>): void
在TLSSocketServer通信连接成功之后,获取对端Socket地址。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<NetAddress> | 是 | 回调函数。成功返回对端的socket地址,失败返回错误码,错误信息。 |
错误码:
错误码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 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.getRemoteAddress((err: BusinessError, data: socket.NetAddress) => {
if (err) {
console.log('getRemoteAddress fail');
return;
}
console.log('getRemoteAddress success:' + JSON.stringify(data));
});
});
getRemoteAddress10+
getRemoteAddress(): Promise<NetAddress>
在TLSSocketServer通信连接成功之后,获取对端Socket地址。使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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 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.getRemoteAddress().then((data: socket.NetAddress) => {
console.log('getRemoteAddress success:' + JSON.stringify(data));
}).catch((err: BusinessError) => {
console.error("failed" + err);
});
});
getRemoteCertificate10+
getRemoteCertificate(callback: AsyncCallback<X509CertRawData>): void
在TLSSocketServer通信连接成功之后,获取对端的数字证书,该接口只适用于客户端向服务端发送证书时,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<X509CertRawData> | 是 | 回调函数,返回对端的证书。失败返回错误码,错误信息。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
2303501 | SSL is null. |
2300002 | System internal 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.getRemoteCertificate((err: BusinessError, data: socket.X509CertRawData) => {
if (err) {
console.log("getRemoteCertificate callback error = " + err);
} else {
console.log("getRemoteCertificate callback = " + data);
}
});
});
getRemoteCertificate10+
getRemoteCertificate():Promise<X509CertRawData>
在TLSSocketServer通信连接成功之后,获取对端的数字证书,该接口只适用于客户端向服务端发送证书时,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
Promise<X509CertRawData> | 以Promise形式返回对端的数字证书的结果。失败返回错误码,错误信息。 |
错误码:
错误码ID | 错误信息 |
---|---|
2303501 | SSL is null. |
2300002 | System internal 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.getRemoteCertificate().then((data: socket.X509CertRawData) => {
console.log('getRemoteCertificate success:' + JSON.stringify(data));
}).catch((err: BusinessError) => {
console.error("failed" + err);
});
});
getCipherSuite10+
getCipherSuite(callback: AsyncCallback<Array<string>>): void
在TLSSocketServer通信连接成功之后,获取通信双方协商后的加密套件,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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 "@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.getCipherSuite((err: BusinessError, data: Array<string>) => {
if (err) {
console.log("getCipherSuite callback error = " + err);
} else {
console.log("getCipherSuite callback = " + data);
}
});
});
getCipherSuite10+
getCipherSuite(): Promise<Array<string>>
在TLSSocketServer通信连接成功之后,获取通信双方协商后的加密套件,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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 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.getCipherSuite().then((data: Array<string>) => {
console.log('getCipherSuite success:' + JSON.stringify(data));
}).catch((err: BusinessError) => {
console.error("failed" + err);
});
});
getSignatureAlgorithms10+
getSignatureAlgorithms(callback: AsyncCallback<Array<string>>): void
在TLSSocketServer通信连接成功之后,获取通信双方协商后签名算法,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<Array<string>> | 是 | 回调函数,返回双方支持的签名算法。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
2303501 | SSL is null. |
2300002 | System internal 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.getSignatureAlgorithms((err: BusinessError, data: Array<string>) => {
if (err) {
console.log("getSignatureAlgorithms callback error = " + err);
} else {
console.log("getSignatureAlgorithms callback = " + data);
}
});
});
getSignatureAlgorithms10+
getSignatureAlgorithms(): Promise<Array<string>>
在TLSSocketServer通信连接成功之后,获取通信双方协商后的签名算法,使用Promise方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
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 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.getSignatureAlgorithms().then((data: Array<string>) => {
console.log("getSignatureAlgorithms success" + data);
}).catch((err: BusinessError) => {
console.error("failed" + err);
});
});
on(‘message’)10+
on(type: ‘message’, callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void
订阅TLSSocketConnection连接的接收消息事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)10+
off(type: ‘message’, callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void
取消订阅TLSSocketConnection连接的接收消息事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
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’)10+
on(type: ‘close’, callback: Callback<void>): void
订阅TLSSocketConnection的关闭事件。使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 订阅的事件类型。’close’:关闭事件。 |
callback | Callback<void> | 是 | 回调函数。 |
错误码:
错误码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('close', () => {
console.log("on close success")
});
});
off(‘close’)10+
off(type: ‘close’, callback?: Callback<void>): void
取消订阅TLSSocketConnection的关闭事件。使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 订阅的事件类型。’close’:关闭事件。 |
callback | Callback<void> | 否 | 回调函数。 |
错误码:
错误码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 = () => {
console.log("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’)10+
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’)10+
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');
});
你可能感兴趣的鸿蒙文章
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)
harmony 鸿蒙@ohos.distributedBundle (分布式包管理)
harmony 鸿蒙@ohos.bundle (Bundle模块)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦