harmony 鸿蒙@ohos.net.socket (Socket Connection)
@ohos.net.socket (Socket Connection)
The socket module implements data transfer over TCP, UDP, Web, and TLS socket connections.
NOTE
The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import socket from '@ohos.net.socket';
socket.constructUDPSocketInstance7+
constructUDPSocketInstance(): UDPSocket
Creates a UDPSocket object.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| UDPSocket | UDPSocket object. |
Example
import socket from '@ohos.net.socket';
let udp: socket.UDPSocket = socket.constructUDPSocketInstance();
UDPSocket7+
Defines a UDP socket connection. Before calling UDPSocket APIs, you need to call socket.constructUDPSocketInstance to create a UDPSocket object.
bind7+
bind(address: NetAddress, callback: AsyncCallback<void>): void
Binds the IP address and port number. The port number can be specified or randomly allocated by the system. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | NetAddress | Yes | Destination address. For details, see NetAddress. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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>
Binds the IP address and port number. The port number can be specified or randomly allocated by the system. This API uses a promise to return the result.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | NetAddress | Yes | Destination address. For details, see NetAddress. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. |
Example
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
Sends data over a UDP socket connection. This API uses an asynchronous callback to return the result.
Before sending data, call UDPSocket.bind() to bind the IP address and port.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | UDPSendOptions | Yes | Parameters for sending data over the UDP socket connection. For details, see UDPSendOptions. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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>
Sends data over a UDP socket connection. This API uses a promise to return the result.
Before sending data, call UDPSocket.bind() to bind the IP address and port.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | UDPSendOptions | Yes | Parameters for sending data over the UDP socket connection. For details, see UDPSendOptions. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. |
Example
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
Closes a UDP socket connection. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
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>
Closes a UDP socket connection. This API uses a promise to return the result.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. |
Example
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
Obtains the status of the UDP socket connection. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after bind is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<SocketStateBase> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
Example
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>
Obtains the status of the UDP socket connection. This API uses a promise to return the result.
NOTE
This API can be called only after bind is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<SocketStateBase> | Promise used to return the result. |
Example
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
Sets other properties of the UDP socket connection. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after bind is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | UDPExtraOptions | Yes | Other properties of the UDP socket connection. For details, see UDPExtraOptions. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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>
Sets other properties of the UDP socket connection. This API uses a promise to return the result.
NOTE
This API can be called only after bind is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | UDPExtraOptions | Yes | Other properties of the UDP socket connection. For details, see UDPExtraOptions. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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
Subscribes to message events of the UDP socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. message: message receiving event. |
| callback | Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}> | Yes | Callback used to return the result. |
Example
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
Unsubscribes from message events of the UDP socket connection. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. message: message receiving event. |
| callback | Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}> | No | Callback used to return the result. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
udp.off('message', callback);
udp.off('message');
on(‘listening’|‘close’)7+
on(type: ‘listening’|‘close’, callback: Callback<void>): void
Subscribes to listening events or close events of the UDP socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. - listening: data packet message event. - close: close event. |
| callback | Callback<void> | Yes | Callback used to return the result. |
Example
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
Unsubscribes from listening events or close events of the UDP socket connection. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. - listening: data packet message event. - close: close event. |
| callback | Callback<void> | No | Callback used to return the result. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
udp.off('listening', callback1);
udp.off('listening');
let callback2 = () => {
console.log("on close, success");
}
udp.on('close', callback2);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
udp.off('close', callback2);
udp.off('close');
on(‘error’)7+
on(type: ‘error’, callback: ErrorCallback): void
Subscribes to error events of the UDP socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | Yes | Callback used to return the result. |
Example
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
Unsubscribes from error events of the UDP socket connection. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | No | Callback used to return the result. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
udp.off('error', callback);
udp.off('error');
NetAddress7+
Defines the destination address.
System capability: SystemCapability.Communication.NetStack
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | string | Yes | Bound IP address. |
| port | number | No | Port number. The value ranges from 0 to 65535. If this parameter is not specified, the system randomly allocates a port. |
| family | number | No | Network protocol type. - 1: IPv4 - 2: IPv6 The default value is 1. |
UDPSendOptions7+
Defines the parameters for sending data over the UDP socket connection.
System capability: SystemCapability.Communication.NetStack
| Name | Type | Mandatory | Description |
|---|---|---|---|
| data | string |ArrayBuffer7+ | Yes | Data to send. |
| address | NetAddress | Yes | Destination address. |
UDPExtraOptions7+
Defines other properties of the UDP socket connection.
System capability: SystemCapability.Communication.NetStack
| Name | Type | Mandatory | Description |
|---|---|---|---|
| broadcast | boolean | No | Whether to send broadcast messages. The default value is false. |
| receiveBufferSize | number | No | Size of the receive buffer, in bytes. The default value is 0. |
| sendBufferSize | number | No | Size of the send buffer, in bytes. The default value is 0. |
| reuseAddress | boolean | No | Whether to reuse addresses. The default value is false. |
| socketTimeout | number | No | Timeout duration of the UDP socket connection, in ms. The default value is 0. |
SocketStateBase7+
Defines the status of the socket connection.
System capability: SystemCapability.Communication.NetStack
| Name | Type | Mandatory | Description |
|---|---|---|---|
| isBound | boolean | Yes | Whether the connection is in the bound state. |
| isClose | boolean | Yes | Whether the connection is in the closed state. |
| isConnected | boolean | Yes | Whether the connection is in the connected state. |
SocketRemoteInfo7+
Defines information about the socket connection.
System capability: SystemCapability.Communication.NetStack
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | string | Yes | Bound IP address. |
| family | string | Yes | Network protocol type. - IPv4 - IPv6 The default value is IPv4. |
| port | number | Yes | Port number. The value ranges from 0 to 65535. |
| size | number | Yes | Length of the server response message, in bytes. |
Description of UDP Error Codes
The UDP error code mapping is in the format of 2301000 + Linux kernel error code.
For details about error codes, see Socket Error Codes.
socket.constructTCPSocketInstance7+
constructTCPSocketInstance(): TCPSocket
Creates a TCPSocket object.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| TCPSocket | TCPSocket object. |
Example
import socket from "@ohos.net.socket";
let tcp: socket.TCPSocket = socket.constructTCPSocketInstance();
TCPSocket7+
Defines a TCP socket connection. Before calling TCPSocket APIs, you need to call socket.constructTCPSocketInstance to create a TCPSocket object.
bind7+
bind(address: NetAddress, callback: AsyncCallback<void>): void
Binds an IP address and a port number. The port number can be specified or randomly allocated by the system. This API uses an asynchronous callback to return the result.
NOTE
If the bind operation fails due to a port conflict, the system will randomly allocate a port number. The TCP client can call tcp.bind to explicitly bind the IP address and port number, and then call tcp.connect to connect to the server. Alternatively, the TCP client can directly call tcp.connect to automatically bind the IP address and port number to connect to the server. If the IP address is localhost or 127.0.0.1, only local loopback access is allowed; that is, the TCP client and the server are deployed on the same device.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | NetAddress | Yes | Destination address. For details, see NetAddress. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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>
Binds an IP address and a port number. The port number can be specified or randomly allocated by the system. This API uses a promise to return the result.
NOTE
If the bind operation fails due to a port conflict, the system will randomly allocate a port number. The TCP client can call tcp.bind to explicitly bind the IP address and port number, and then call tcp.connect to connect to the server. Alternatively, the TCP client can directly call tcp.connect to automatically bind the IP address and port number to connect to the server. If the IP address is localhost or 127.0.0.1, only local loopback access is allowed; that is, the TCP client and the server are deployed on the same device.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | NetAddress | Yes | Destination address. For details, see NetAddress. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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
Sets up a connection to the specified IP address and port number. This API uses an asynchronous callback to return the result.
NOTE
This API allows you to connect to the TCP server without first executing tcp.bind.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPConnectOptions | Yes | TCP socket connection parameters. For details, see TCPConnectOptions. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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>
Sets up a connection to the specified IP address and port number. This API uses a promise to return the result.
NOTE
This API allows you to connect to the TCP server without first executing tcp.bind.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPConnectOptions | Yes | TCP socket connection parameters. For details, see TCPConnectOptions. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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
Sends data over a TCP socket connection. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after connect is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPSendOptions | Yes | Parameters for sending data over the TCP socket connection. For details, see TCPSendOptions. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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>
Sends data over a TCP socket connection. This API uses a promise to return the result.
NOTE
This API can be called only after connect is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPSendOptions | Yes | Parameters for sending data over the TCP socket connection. For details, see TCPSendOptions. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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
Closes a TCP socket connection. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
Example
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>
Closes a TCP socket connection. This API uses a promise to return the result.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
Example
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
Obtains the remote address of a socket connection. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after connect is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<NetAddress> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
Example
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>
Obtains the remote address of a socket connection. This API uses a promise to return the result.
NOTE
This API can be called only after connect is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<NetAddress> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
Example
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
Obtains the status of the TCP socket connection. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after bind or connect is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<SocketStateBase> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
Example
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>
Obtains the status of the TCP socket connection. This API uses a promise to return the result.
NOTE
This API can be called only after bind or connect is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<SocketStateBase> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
Example
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
Obtains the file descriptor of the TCPSocket object. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after bind or connect is successfully called.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<number> | Yes | Callback used to return the result. If the operation is successful, the file descriptor of the socket is returned. Otherwise, undefined is returned. |
Example
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>
Obtains the file descriptor of the TCPSocket object. This API uses a promise to return the result.
NOTE
This API can be called only after bind or connect is successfully called.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<number> | Promise used to return the result. |
Example
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
Sets other properties of the TCP socket connection. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after bind or connect is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPExtraOptions | Yes | Other properties of the TCP socket connection. For details, see TCPExtraOptions. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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>
Sets other properties of the TCP socket connection. This API uses a promise to return the result.
NOTE
This API can be called only after bind or connect is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPExtraOptions | Yes | Other properties of the TCP socket connection. For details, see TCPExtraOptions. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
Example
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
Subscribes to message events of the TCP socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. message: message receiving event. |
| callback | Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}> | Yes | Callback used to return the result. |
Example
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
Unsubscribes from message events of the TCP socket connection. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. message: message receiving event. |
| callback | Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}> | No | Callback used to return the result. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tcp.off('message', callback);
tcp.off('message');
on(‘connect’|‘close’)7+
on(type: ‘connect’|‘close’, callback: Callback<void>): void
Subscribes to connection or close events of the TCP socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. - connect: connection event. - close: close event. |
| callback | Callback<void> | Yes | Callback used to return the result. |
Example
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
Unsubscribes from connection or close events of the TCP socket connection. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. - connect: connection event. - close: close event. |
| callback | Callback<void> | No | Callback used to return the result. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tcp.off('connect', callback1);
tcp.off('connect');
let callback2 = () => {
console.log("on close success");
}
tcp.on('close', callback2);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tcp.off('close', callback2);
tcp.off('close');
on(‘error’)7+
on(type: ‘error’, callback: ErrorCallback): void
Subscribes to error events of the TCP socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | Yes | Callback used to return the result. |
Example
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
Unsubscribes from error events of the TCP socket connection. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | No | Callback used to return the result. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tcp.off('error', callback);
tcp.off('error');
TCPConnectOptions7+
Defines TCP socket connection parameters.
System capability: SystemCapability.Communication.NetStack
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | NetAddress | Yes | Bound IP address and port number. |
| timeout | number | No | Timeout duration of the TCP socket connection, in ms. |
TCPSendOptions7+
Defines the parameters for sending data over the TCP socket connection.
System capability: SystemCapability.Communication.NetStack
| Name | Type | Mandatory | Description |
|---|---|---|---|
| data | string|ArrayBuffer7+ | Yes | Data to send. |
| encoding | string | No | Character encoding format. The options are as follows: UTF-8, UTF-16BE, UTF-16LE, UTF-16, US-AECII, and ISO-8859-1. The default value is UTF-8. |
TCPExtraOptions7+
Defines other properties of the TCP socket connection.
System capability: SystemCapability.Communication.NetStack
| Name | Type | Mandatory | Description |
|---|---|---|---|
| keepAlive | boolean | No | Whether to keep the connection alive. The default value is false. |
| OOBInline | boolean | No | Whether to enable OOBInline. The default value is false. |
| TCPNoDelay | boolean | No | Whether to enable no-delay on the TCP socket connection. The default value is false. |
| socketLinger | Object | Yes | Socket linger. - on: whether to enable socket linger. The value true means to enable socket linger and false means the opposite. - linger: linger time, in ms. The value ranges from 0 to 65535. Specify this parameter only when on is set to true. |
| receiveBufferSize | number | No | Size of the receive buffer, in bytes. The default value is 0. |
| sendBufferSize | number | No | Size of the send buffer, in bytes. The default value is 0. |
| reuseAddress | boolean | No | Whether to reuse addresses. The default value is false. |
| socketTimeout | number | No | Timeout duration of the UDP socket connection, in ms. The default value is 0. |
socket.constructTCPSocketServerInstance10+
constructTCPSocketServerInstance(): TCPSocketServer
Creates a TCPSocketServer object.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| TCPSocketServer | TCPSocketServer object. |
Example
import socket from "@ohos.net.socket";
let tcpServer: socket.TCPSocketServer = socket.constructTCPSocketServerInstance();
TCPSocketServer10+
Defines a TCPSocketServer connection. Before calling TCPSocketServer APIs, you need to call socket.constructTCPSocketServerInstance to create a TCPSocketServer object.
listen10+
listen(address: NetAddress, callback: AsyncCallback<void>): void
Binds the IP address and port number. The port number can be specified or randomly allocated by the system. The server listens to and accepts TCP socket connections established over the socket. Multiple threads are used to process client data concurrently. This API uses an asynchronous callback to return the result.
NOTE
The server uses this API to perform the bind, listen, and accept operations. If the bind operation fails, the system randomly allocates a port number.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | NetAddress | Yes | Destination address. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 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. |
Example
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>
Binds the IP address and port number. The port number can be specified or randomly allocated by the system. The server listens to and accepts TCP socket connections established over the socket. Multiple threads are used to process client data concurrently. This API uses a promise to return the result.
NOTE
The server uses this API to perform the bind, listen, and accept operations. If the bind operation fails, the system randomly allocates a port number.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | NetAddress | Yes | Destination address. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 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. |
Example
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
Obtains the status of the TCPSocketServer connection. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<SocketStateBase> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2300002 | System internal error. |
| 2303188 | Socket operation on non-socket. |
Example
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>
Obtains the status of the TCPSocketServer connection. This API uses a promise to return the result.
NOTE
This API can be called only after listen is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<SocketStateBase> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
| 2300002 | System internal error. |
| 2303188 | Socket operation on non-socket. |
Example
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
Sets other properties of the TCPSocketServer connection. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPExtraOptions | Yes | Other properties of the TCPSocketServer connection. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2300002 | System internal error. |
| 2303188 | Socket operation on non-socket. |
Example
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>
Sets other properties of the TCPSocketServer connection. This API uses a promise to return the result.
NOTE
This API can be called only after listen is successfully called.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPExtraOptions | Yes | Other properties of the TCPSocketServer connection. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2300002 | System internal error. |
| 2303188 | Socket operation on non-socket. |
Example
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
Subscribes to TCPSocketServer connection events. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. connect: connection event. |
| callback | Callback<TCPSocketConnection> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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
Unsubscribes from TCPSocketServer connection events. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. connect: connection event. |
| callback | Callback<TCPSocketConnection> | No | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tcpServer.off('connect', callback);
tcpServer.off('connect');
on(‘error’)10+
on(type: ‘error’, callback: ErrorCallback): void
Subscribes to error events of the TCPSocketServer connection. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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
Unsubscribes from error events of the TCPSocketServer connection. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | No | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tcpServer.off('error', callback);
tcpServer.off('error');
TCPSocketConnection10+
Defines a TCPSocketConnection object, that is, the connection between the TCPSocket client and the server. Before calling TCPSocketConnection APIs, you need to obtain a TCPSocketConnection object.
NOTE
The TCPSocket client can call related APIs through the TCPSocketConnection object only after a connection is successfully established between the TCPSocket client and the server.
System capability: SystemCapability.Communication.NetStack
Attributes
| Name | Type | Mandatory | Description |
|---|---|---|---|
| clientId | number | Yes | ID of the connection between the client and TCPSocketServer. |
send10+
send(options: TCPSendOptions, callback: AsyncCallback<void>): void
Sends data over a TCPSocketConnection object. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after a connection with the client is set up.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPSendOptions | Yes | Defines the parameters for sending data over the TCPSocketConnection object. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2300002 | System internal error. |
Example
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>
Sends data over a TCPSocketConnection object. This API uses a promise to return the result.
NOTE
This API can be called only after a connection with the client is set up.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPSendOptions | Yes | Defines the parameters for sending data over the TCPSocketConnection object. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2300002 | System internal error. |
Example
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
Closes a TCP socket connection. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2300002 | System internal error. |
Example
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>
Closes a TCP socket connection. This API uses a promise to return the result.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
| 2300002 | System internal error. |
Example
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
Obtains the remote address of a socket connection. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after a connection with the client is set up.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<NetAddress> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2300002 | System internal error. |
| 2303188 | Socket operation on non-socket. |
Example
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>
Obtains the remote address of a socket connection. This API uses a promise to return the result.
NOTE
This API can be called only after a connection with the client is set up.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<NetAddress> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
| 2300002 | System internal error. |
| 2303188 | Socket operation on non-socket. |
Example
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
Subscribes to message events of a TCPSocketConnection object. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. message: message receiving event. |
| callback | Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}> | Yes | Callback used to return the result. message: received message. remoteInfo: socket connection information. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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
Unsubscribes from message events of a TCPSocketConnection object. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. message: message receiving event. |
| callback | Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}> | No | Callback used to return the result. message: received message. remoteInfo: socket connection information. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
client.off('message', callback);
client.off('message');
});
on(‘close’)10+
on(type: ‘close’, callback: Callback<void>): void
Subscribes to close events of a TCPSocketConnection object. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. close: close event. |
| callback | Callback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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
Unsubscribes from close events of a TCPSocketConnection object. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. close: close event. |
| callback | Callback<void> | No | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
client.off('close', callback);
client.off('close');
});
on(‘error’)10+
on(type: ‘error’, callback: ErrorCallback): void
Subscribes to error events of a TCPSocketConnection object. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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
Unsubscribes from error events of a TCPSocketConnection object. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | No | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
client.off('error', callback);
client.off('error');
});
Description of TCP Error Codes
The TCP error code mapping is in the format of 2301000 + Linux kernel error code.
For details about error codes, see Socket Error Codes.
socket.constructTLSSocketInstance9+
constructTLSSocketInstance(): TLSSocket
Creates a TLSSocket object.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| TLSSocket | TLSSocket object. |
Example
import socket from "@ohos.net.socket";
let tls: socket.TLSSocket = socket.constructTLSSocketInstance();
TLSSocket9+
Defines a TLS socket connection. Before calling TLSSocket APIs, you need to call socket.constructTLSSocketInstance to create a TLSSocket object.
bind9+
bind(address: NetAddress, callback: AsyncCallback<void>): void
Binds the IP address and port number. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | NetAddress | Yes | Destination address. For details, see NetAddress. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, the result of binding the local IP address and port number is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2303198 | Address already in use. |
| 2300002 | System internal error. |
Example
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>
Binds the IP address and port number. This API uses a promise to return the result.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | NetAddress | Yes | Destination address. For details, see NetAddress. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2303198 | Address already in use. |
| 2300002 | System internal error. |
Example
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
Obtains the status of the TLS socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<SocketStateBase> | Yes | Callback used to return the result. If the operation is successful, the status of the TLS socket connection is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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>
Obtains the status of the TLS socket connection. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<SocketStateBase> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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
Sets other properties of the TCP socket connection after bind is successfully called. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPExtraOptions | Yes | Other properties of the TCP socket connection. For details, see TCPExtraOptions. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, the result of setting other properties of the TCP socket connection is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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>
Sets other properties of the TCP socket connection after bind is successfully called. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPExtraOptions | Yes | Other properties of the TCP socket connection. For details, see TCPExtraOptions. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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;
Subscribes to message events of the TLS socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. message: message receiving event. |
| callback | Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}> | Yes | Callback used to return the result. message: received message. remoteInfo: socket connection information. |
Example
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
Unsubscribes from message events of the TLS socket connection. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. message: message receiving event. |
| callback | Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}> | No | Callback used to return the result. message: received message. remoteInfo: socket connection information. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tls.off('message', callback);
on(‘connect’|‘close’)9+
on(type: ‘connect’|‘close’, callback: Callback<void>): void
Subscribes to connect or close events of the TLS socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. - connect: connection event. - close: close event. |
| callback | Callback<void> | Yes | Callback used to return the result. |
Example
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
Unsubscribes from connect or close events of the TLS socket connection. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. - connect: connection event. - close: close event. |
| callback | Callback<void> | No | Callback used to return the result. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tls.off('connect', callback1);
tls.off('connect');
let callback2 = () => {
console.log("on close success");
}
tls.on('close', callback2);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tls.off('close', callback2);
on(‘error’)9+
on(type: ‘error’, callback: ErrorCallback): void
Subscribes to error events of the TLS socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | Yes | Callback used to return the result. |
Example
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
Unsubscribes from error events of the TLS socket connection. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | No | Callback used to return the result. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tls.off('error', callback);
connect9+
connect(options: TLSConnectOptions, callback: AsyncCallback<void>): void
Sets up a TLS socket connection, and creates and initializes a TLS session after bind is successfully called. During this process, a TLS/SSL handshake is performed between the application and the server to implement data transmission. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TLSConnectOptions | Yes | Parameters required for the TLS socket connection. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 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. |
Example
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>
Sets up a TLS socket connection, and creates and initializes a TLS session after bind is successfully called. During this process, a TLS/SSL handshake is performed between the application and the server to implement data transmission. Both two-way and one-way authentication modes are supported. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TLSConnectOptions | Yes | Parameters required for the connection. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 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. |
Example
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
Obtains the remote address of a TLS socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<NetAddress> | Yes | Callback used to return the result. If the operation is successful, the remote address is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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>
Obtains the remote address of a TLS socket connection. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<NetAddress> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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
Obtains the local digital certificate after a TLS socket connection is established. This API is applicable to two-way authentication. It uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<X509CertRawData> | Yes | Callback used to return the result. If the operation is successful, the local certificate is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2303504 | Error looking up x509. |
| 2300002 | System internal error. |
Example
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>
Obtains the local digital certificate after a TLS socket connection is established. This API is applicable to two-way authentication. It uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<X509CertRawData> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2303504 | Error looking up x509. |
| 2300002 | System internal error. |
Example
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
Obtains the digital certificate of the server after a TLS socket connection is established. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<X509CertRawData> | Yes | Callback used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
Example
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>
Obtains the digital certificate of the server after a TLS socket connection is established. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<X509CertRawData> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
Example
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
Obtains the communication protocol version after a TLS socket connection is established. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<string> | Yes | Callback used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. |
Example
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>
Obtains the communication protocol version after a TLS socket connection is established. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<string> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. |
Example
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
Obtains the cipher suite negotiated by both communication parties after a TLS socket connection is established. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<Array<string>> | Yes | Callback used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2303502 | Error in tls reading. |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. |
Example
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>>
Obtains the cipher suite negotiated by both communication parties after a TLS socket connection is established. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<Array<string>> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2303502 | Error in tls reading. |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. |
Example
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
Obtains the signing algorithm negotiated by both communication parties after a TLS socket connection is established. This API is applicable to two-way authentication. It uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<Array<string>> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
Example
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>>
Obtains the signing algorithm negotiated by both communication parties after a TLS socket connection is established. This API is applicable to two-way authentication. It uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<Array<string>> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
Example
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
Sends a message to the server after a TLS socket connection is established. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| data | string | Yes | Data content of the message to send. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 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. |
Example
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>
Sends a message to the server after a TLS socket connection is established. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| data | string | Yes | Data content of the message to send. |
Error codes
| ID | Error Message |
|---|---|
| 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. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation fails, an error message is returned. |
Example
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
Closes a TLS socket connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2303506 | Error clearing tls connection. |
| 2300002 | System internal error. |
Example
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>
Closes a TLS socket connection. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2303506 | Error clearing tls connection. |
| 2300002 | System internal error. |
Example
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+
Defines TLS connection options.
System capability: SystemCapability.Communication.NetStack
| Name | Type | Mandatory | Description |
|---|---|---|---|
| address | NetAddress | Yes | Gateway address. |
| secureOptions | TLSSecureOptions | Yes | TLS security options. |
| ALPNProtocols | Array<string> | No | ALPN protocol. The value range is [“spdy/1”, “http/1.1”]. The default value is []. |
TLSSecureOptions9+
Defines TLS security options. The CA certificate is mandatory, and other parameters are optional. When cert (local certificate) and key (private key) are not empty, the two-way authentication mode is enabled. If cert or key is empty, one-way authentication is enabled.
System capability: SystemCapability.Communication.NetStack
| Name | Type | Mandatory | Description |
|---|---|---|---|
| ca | string |Array<string> | Yes | CA certificate of the server, which is used to authenticate the digital certificate of the server. |
| cert | string | No | Digital certificate of the local client. |
| key | string | No | Private key of the local digital certificate. |
| password | string | No | Password for reading the private key. |
| protocols | Protocol |Array<Protocol> | No | TLS protocol version. The default value is TLSv1.2. |
| useRemoteCipherPrefer | boolean | No | Whether to use the remote cipher suite preferentially. |
| signatureAlgorithms | string | No | Signing algorithm used during communication. The default value is ””. |
| cipherSuite | string | No | Cipher suite used during communication. The default value is ””. |
Protocol9+
Enumerates TLS protocol versions.
System capability: SystemCapability.Communication.NetStack
| Name | Value | Description |
|---|---|---|
| TLSv12 | “TLSv1.2” | TLSv1.2. |
| TLSv13 | “TLSv1.3” | TLSv1.3. |
X509CertRawData9+
Defines the certificate raw data.
System capability: SystemCapability.Communication.NetStack
socket.constructTLSSocketServerInstance10+
constructTLSSocketServerInstance(): TLSSocketServer
Creates a TLSSocketServer object.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| TLSSocketServer | TLSSocketServer object. |
Example
import socket from "@ohos.net.socket";
import { BusinessError } from '@ohos.base';
let tlsServer: socket.TLSSocketServer = socket.constructTLSSocketServerInstance();
TLSSocketServer10+
Defines a TLS socket server connection. Before calling TLSSocketServer APIs, you need to call socket.constructTLSSocketServerInstance to create a TLSSocketServer object.
listen10+
listen(options: TLSConnectOptions, callback: AsyncCallback<void>): void
Listens to client connections after bind is successfully called. This API uses an asynchronous callback to return the result. After a connection is established, a TLS session will be created and initialized and a certificate key will be loaded and verified.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TLSConnectOptions | Yes | Parameters required for the connection. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 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. |
Example
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>
Listens to client connections after bind is successfully called. This API uses a promise to return the result. After a connection is established, a TLS session will be created and initialized and a certificate key will be loaded and verified.
Required permissions: ohos.permission.INTERNET
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TLSConnectOptions | Yes | Parameters required for the connection. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 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. |
Example
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
Obtains the status of the TLS socket server connection upon successful listening. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<SocketStateBase> | Yes | Callback used to return the result. If the operation is successful, the status of the TLS socket server connection is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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>
Obtains the status of the TLS socket server connection upon successful listening. This API uses a promise to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<SocketStateBase> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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
Sets other properties of the TLS socket server connection upon successful listening. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPExtraOptions | Yes | Other properties of the TLS socket server connection. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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>
Sets other properties of the TLS socket server connection upon successful listening. This API uses a promise to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| options | TCPExtraOptions | Yes | Other properties of the TLS socket server connection. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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
Obtains the local digital certificate after a TLS socket server connection is established. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<X509CertRawData> | Yes | Callback used to return the result. If the operation is successful, the local certificate is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303501 | SSL is null. |
| 2303504 | Error looking up x509. |
| 2300002 | System internal error. |
Example
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>
Obtains the local digital certificate after a TLS socket server connection is established. This API uses a promise to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<X509CertRawData> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2303504 | Error looking up x509. |
| 2300002 | System internal error. |
Example
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
Obtains the communication protocol version after a TLS socket server connection is established. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<string> | Yes | Callback used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. |
Example
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>
Obtains the communication protocol version after a TLS socket server connection is established. This API uses a promise to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<string> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. |
Example
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
Subscribes to TLS socket server connection events. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. connect: connection event. |
| callback | Callback<TLSSocketConnection> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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
Unsubscribes from TLS socket server connection events. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called. You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. connect: connection event. |
| callback | Callback<TLSSocketConnection> | No | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tlsServer.off('connect', callback);
tlsServer.off('connect');
on(‘error’)10+
on(type: ‘error’, callback: ErrorCallback): void
Subscribes to error events of a TLSSocketServer object. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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
Unsubscribes from error events of a TLSSocketServer object. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only after listen is successfully called. You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | No | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
tlsServer.off('error', callback);
tlsServer.off('error');
TLSSocketConnection10+
Defines a TLSSocketConnection object, that is, the connection between the TLSSocket client and the server. Before calling TLSSocketConnection APIs, you need to obtain a TLSSocketConnection object.
NOTE
The TLSSocket client can call related APIs through the TLSSocketConnection object only after a connection is successfully established between the TLSSocket client and the server.
System capability: SystemCapability.Communication.NetStack
Attributes
| Name | Type | Mandatory | Description |
|---|---|---|---|
| clientId | number | Yes | ID of the connection between the client and TLSSocketServer. |
send10+
send(data: string, callback: AsyncCallback<void>): void
Sends a message to the client after a TLS socket server connection is established. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| data | string | Yes | Parameters for sending data over the TLS socket server connection. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 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. |
Example
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>
Sends a message to the server after a TLS socket server connection is established. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| data | string | Yes | Parameters for sending data over the TLS socket server connection. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 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. |
Example
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
Closes a TLS socket server connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2303506 | Error clearing tls connection. |
| 2300002 | System internal error. |
Example
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>
Closes a TLS socket server connection. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise used to return the result. If the operation is successful, no value is returned. If the operation fails, an error message is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2303506 | Error clearing tls connection. |
| 2300002 | System internal error. |
Example
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
Obtains the remote address of a TLS socket server connection. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<NetAddress> | Yes | Callback used to return the result. If the operation is successful, the remote address is returned. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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>
Obtains the remote address of a TLS socket server connection. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<NetAddress> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. |
Example
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
Obtains the digital certificate of the peer end after a TLS socket server connection is established. This API uses an asynchronous callback to return the result. It applies only to the scenario where the client sends a certificate to the server.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<X509CertRawData> | Yes | Callback used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
Example
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>
Obtains the digital certificate of the peer end after a TLS socket server connection is established. This API uses a promise to return the result. It applies only to the scenario where the client sends a certificate to the server.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<X509CertRawData> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
Example
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
Obtains the cipher suite negotiated by both communication parties after a TLS socket server connection is established. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<Array<string>> | Yes | Callback used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303501 | SSL is null. |
| 2303502 | Error in tls reading. |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. |
Example
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>>
Obtains the cipher suite negotiated by both communication parties after a TLS socket server connection is established. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<Array<string>> | Promise used to return the result. If the operation fails, an error message is returned. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2303502 | Error in tls reading. |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. |
Example
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
Obtains the signing algorithm negotiated by both communication parties after a TLS socket server connection is established. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | AsyncCallback<Array<string>> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
Example
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>>
Obtains the signing algorithm negotiated by both communication parties after a TLS socket server connection is established. This API uses a promise to return the result.
System capability: SystemCapability.Communication.NetStack
Return value
| Type | Description |
|---|---|
| Promise<Array<string>> | Promise used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
Example
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
Subscribes to message events of a TLSSocketConnection object. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. message: message receiving event. |
| callback | Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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
Unsubscribes from message events of a TLSSocketConnection object. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. message: message receiving event. |
| callback | Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}> | No | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
client.off('message', callback);
client.off('message');
});
on(‘close’)10+
on(type: ‘close’, callback: Callback<void>): void
Subscribes to close events of a TLSSocketConnection object. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. close: close event. |
| callback | Callback<void> | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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
Unsubscribes from close events of a TLSSocketConnection object. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. close: close event. |
| callback | Callback<void> | No | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
client.off('close', callback);
client.off('close');
});
on(‘error’)10+
on(type: ‘error’, callback: ErrorCallback): void
Subscribes to error events of a TLSSocketConnection object. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | Yes | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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
Unsubscribes from error events of a TLSSocketConnection object. This API uses an asynchronous callback to return the result.
NOTE
You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
System capability: SystemCapability.Communication.NetStack
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Type of the event to subscribe to. error: error event. |
| callback | ErrorCallback | No | Callback used to return the result. |
Error codes
| ID | Error Message |
|---|---|
| 401 | Parameter error. |
Example
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);
// You can pass the callback of the on function if you want to cancel listening for a certain type of events. If you do not pass the callback, you will cancel listening for all events.
client.off('error', callback);
client.off('error');
});
你可能感兴趣的鸿蒙文章
harmony 鸿蒙System Common Events (To Be Deprecated Soon)
harmony 鸿蒙System Common Events
harmony 鸿蒙API Reference Document Description
harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)
harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)
harmony 鸿蒙@ohos.bundle (Bundle)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)
- 所属分类： 后端技术
- 本文标签：
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
6、 golang
-
8、 openharmony