Socket連接

導入模塊

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

socket.constructUDPSocketInstance

constructUDPSocketInstance(): UDPSocket

創(chuàng)建一個UDPSocket對象。

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

示例：

let udp = socket.constructUDPSocketInstance();

UDPSocket

UDPSocket連接。在調(diào)用UDPSocket的方法前，需要先通過socket.constructUDPSocketInstance創(chuàng)建UDPSocket對象。

bind

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

綁定IP地址和端口，端口可以指定或由系統(tǒng)隨機分配。使用callback方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
})

bind

bind(address: NetAddress): Promise<void>

綁定IP地址和端口，端口可以指定或由系統(tǒng)隨機分配。使用Promise方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

返回值：

示例：

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

send

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

通過UDPSocket連接發(fā)送數(shù)據(jù)。使用callback方式作為異步方法。

發(fā)送數(shù)據(jù)前，需要先調(diào)用UDPSocket.bind()綁定IP地址和端口。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let udp = socket.constructUDPSocketInstance();
udp.send({
  data:'Hello, server!',
  address: {
    address:'192.168.xx.xxx',
    port:xxxx,
    family:1
  }
}, err=> {
    if (err) {
      console.log('send fail');
      return;
    }
    console.log('send success');
})

send

send(options: UDPSendOptions): Promise<void>

通過UDPSocket連接發(fā)送數(shù)據(jù)。使用Promise方式作為異步方法。

發(fā)送數(shù)據(jù)前，需要先調(diào)用UDPSocket.bind()綁定IP地址和端口。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

返回值：

示例：

let udp = socket.constructUDPSocketInstance();
let promise = udp.send({
  data:'Hello, server!',
  address: {
    address:'192.168.xx.xxx',
    port:xxxx,
    family:1
  }
});
promise.then(() => {
  console.log('send success');
}).catch(err => {
  console.log('send fail');
});

close

close(callback: AsyncCallback<void>): void

關(guān)閉UDPSocket連接。使用callback方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

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

close

close(): Promise<void>

關(guān)閉UDPSocket連接。使用Promise方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

示例：

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

getState

getState(callback: AsyncCallback<SocketStateBase>): void

獲取UDPSocket狀態(tài)。使用callback方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  udp.getState((err, data) => {
    if (err) {
      console.log('getState fail');
      return;
    }
    console.log('getState success:' + JSON.stringify(data));
  })
})

getState

getState(): Promise<SocketStateBase>

獲取UDPSocket狀態(tài)。使用Promise方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

示例：

let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  let promise = udp.getState();
  promise.then(data => {
    console.log('getState success:' + JSON.stringify(data));
  }).catch(err => {
    console.log('getState fail');
  });
})

setExtraOptions

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

設(shè)置UDPSocket連接的其他屬性。使用callback方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let udp = socket.constructUDPSocketInstance();
udp.bind({address:'192.168.xx.xxx', port:xxxx, family:1}, err=> {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  udp.setExtraOptions({
    receiveBufferSize:1000,
    sendBufferSize:1000,
    reuseAddress:false,
    socketTimeout:6000,
    broadcast:true
  }, err=> {
    if (err) {
      console.log('setExtraOptions fail');
      return;
    }
    console.log('setExtraOptions success');
  })
})

setExtraOptions

setExtraOptions(options: UDPExtraOptions): Promise<void>

設(shè)置UDPSocket連接的其他屬性。使用Promise方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

返回值：

錯誤碼：

示例：

let udp = socket.constructUDPSocketInstance();
let promise = udp.bind({address:'192.168.xx.xxx', port:xxxx, family:1});
promise.then(() => {
  console.log('bind success');
  let promise1 = udp.setExtraOptions({
    receiveBufferSize:1000,
    sendBufferSize:1000,
    reuseAddress:false,
    socketTimeout:6000,
    broadcast:true
  });
  promise1.then(() => {
    console.log('setExtraOptions success');
  }).catch(err => {
    console.log('setExtraOptions fail');
  });
}).catch(err => {
  console.log('bind fail');
});

on('message')

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

訂閱UDPSocket連接的接收消息事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let udp = socket.constructUDPSocketInstance();
udp.on('message', value => {
    console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
});

off('message')

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

取消訂閱UDPSocket連接的接收消息事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let udp = socket.constructUDPSocketInstance();
let callback = value =>{
    console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
}
udp.on('message', callback);
// 可以指定傳入on中的callback取消一個訂閱，也可以不指定callback清空所有訂閱。
udp.off('message', callback);
udp.off('message');

on('listening' | 'close')

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

訂閱UDPSocket連接的數(shù)據(jù)包消息事件或關(guān)閉事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let udp = socket.constructUDPSocketInstance();
udp.on('listening', () => {
    console.log("on listening success");
});
udp.on('close', () => {
    console.log("on close success" );
});

off('listening' | 'close')

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

取消訂閱UDPSocket連接的數(shù)據(jù)包消息事件或關(guān)閉事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let udp = socket.constructUDPSocketInstance();
let callback1 = () =>{
    console.log("on listening, success");
}
udp.on('listening', callback1);
// 可以指定傳入on中的callback取消一個訂閱，也可以不指定callback清空所有訂閱。
udp.off('listening', callback1);
udp.off('listening');
let callback2 = () =>{
    console.log("on close, success");
}
udp.on('close', callback2);
// 可以指定傳入on中的callback取消一個訂閱，也可以不指定callback清空所有訂閱。
udp.off('close', callback2);
udp.off('close');

on('error')

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

訂閱UDPSocket連接的error事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let udp = socket.constructUDPSocketInstance();
udp.on('error', err => {
    console.log("on error, err:" + JSON.stringify(err))
});

off('error')

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

取消訂閱UDPSocket連接的error事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let udp = socket.constructUDPSocketInstance();
let callback = err =>{
    console.log("on error, err:" + JSON.stringify(err));
}
udp.on('error', callback);
// 可以指定傳入on中的callback取消一個訂閱，也可以不指定callback清空所有訂閱。
udp.off('error', callback);
udp.off('error');

NetAddress

目標地址信息。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

UDPSendOptions

UDPSocket發(fā)送參數(shù)。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

UDPExtraOptions

UDPSocket連接的其他屬性。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

SocketStateBase

Socket的狀態(tài)信息。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

SocketRemoteInfo

Socket的連接信息。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

UDP 錯誤碼說明

UDP 其余錯誤碼映射形式為：2301000 + Linux內(nèi)核錯誤碼。

錯誤碼的詳細介紹參見Socket錯誤碼

socket.constructTCPSocketInstance

constructTCPSocketInstance(): TCPSocket

創(chuàng)建一個TCPSocket對象。

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

示例：

let tcp = socket.constructTCPSocketInstance();

TCPSocket

TCPSocket連接。在調(diào)用TCPSocket的方法前，需要先通過socket.constructTCPSocketInstance創(chuàng)建TCPSocket對象。

bind

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

綁定IP地址和端口，端口可以指定或由系統(tǒng)隨機分配。使用callback方法作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
tcp.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 }, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
})

bind

bind(address: NetAddress): Promise<void>

綁定IP地址和端口，端口可以指定或由系統(tǒng)隨機分配。使用Promise方法作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

返回值：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise = tcp.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
promise.then(() => {
  console.log('bind success');
}).catch(err => {
  console.log('bind fail');
});

connect

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

連接到指定的IP地址和端口。使用callback方法作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 } , timeout: 6000}, err => {
  if (err) {
    console.log('connect fail');
    return;
  }
  console.log('connect success');
})

connect

connect(options: TCPConnectOptions): Promise<void>

連接到指定的IP地址和端口。使用promise方法作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

返回值：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success')
}).catch(err => {
  console.log('connect fail');
});

send

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

通過TCPSocket連接發(fā)送數(shù)據(jù)。使用callback方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  tcp.send({
    data:'Hello, server!'
  },err => {
    if (err) {
      console.log('send fail');
      return;
    }
    console.log('send success');
  })
}).catch(err => {
  console.log('connect fail');
});

send

send(options: TCPSendOptions): Promise<void>

通過TCPSocket連接發(fā)送數(shù)據(jù)。使用Promise方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

返回值：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise1 = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise1.then(() => {
  console.log('connect success');
  let promise2 = tcp.send({
    data:'Hello, server!'
  });
  promise2.then(() => {
    console.log('send success');
  }).catch(err => {
    console.log('send fail');
  });
}).catch(err => {
  console.log('connect fail');
});

close

close(callback: AsyncCallback<void>): void

關(guān)閉TCPSocket連接。使用callback方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
tcp.close(err => {
  if (err) {
    console.log('close fail');
    return;
  }
  console.log('close success');
})

close

close(): Promise<void>

關(guān)閉TCPSocket連接。使用Promise方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise = tcp.close();
promise.then(() => {
  console.log('close success');
}).catch(err => {
  console.log('close fail');
});

getRemoteAddress

getRemoteAddress(callback: AsyncCallback<NetAddress>): void

獲取對端Socket地址。使用callback方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  tcp.getRemoteAddress((err, data) => {
    if (err) {
      console.log('getRemoteAddressfail');
      return;
    }
    console.log('getRemoteAddresssuccess:' + JSON.stringify(data));
  })
}).catch(err => {
  console.log('connect fail');
});

getRemoteAddress

getRemoteAddress(): Promise<NetAddress>

獲取對端Socket地址。使用Promise方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise1 = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise1.then(() => {
  console.log('connect success');
  let promise2 = tcp.getRemoteAddress();
  promise2.then(() => {
    console.log('getRemoteAddress success');
  }).catch(err => {
    console.log('getRemoteAddressfail');
  });
}).catch(err => {
  console.log('connect fail');
});

getState

getState(callback: AsyncCallback<SocketStateBase>): void

獲取TCPSocket狀態(tài)。使用callback方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  tcp.getState((err, data) => {
    if (err) {
      console.log('getState fail');
      return;
    }
    console.log('getState success:' + JSON.stringify(data));
  });
}).catch(err => {
  console.log('connect fail');
});

getState

getState(): Promise<SocketStateBase>

獲取TCPSocket狀態(tài)。使用Promise方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  let promise1 = tcp.getState();
  promise1.then(() => {
    console.log('getState success');
  }).catch(err => {
    console.log('getState fail');
  });
}).catch(err => {
  console.log('connect fail');
});

setExtraOptions

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

設(shè)置TCPSocket連接的其他屬性。使用callback方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  tcp.setExtraOptions({
    keepAlive: true,
    OOBInline: true,
    TCPNoDelay: true,
    socketLinger: { on:true, linger:10 },
    receiveBufferSize: 1000,
    sendBufferSize: 1000,
    reuseAddress: true,
    socketTimeout: 3000,
  },err => {
    if (err) {
      console.log('setExtraOptions fail');
      return;
    }
    console.log('setExtraOptions success');
  });
}).catch(err => {
  console.log('connect fail');
});

setExtraOptions

setExtraOptions(options: TCPExtraOptions): Promise<void>

設(shè)置TCPSocket連接的其他屬性，使用Promise方式作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

返回值：

錯誤碼：

示例：

let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  let promise1 = tcp.setExtraOptions({
    keepAlive: true,
    OOBInline: true,
    TCPNoDelay: true,
    socketLinger: { on:true, linger:10 },
    receiveBufferSize: 1000,
    sendBufferSize: 1000,
    reuseAddress: true,
    socketTimeout: 3000,
  });
  promise1.then(() => {
    console.log('setExtraOptions success');
  }).catch(err => {
    console.log('setExtraOptions fail');
  });
}).catch(err => {
  console.log('connect fail');
});

on('message')

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

訂閱TCPSocket連接的接收消息事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let tcp = socket.constructTCPSocketInstance();
tcp.on('message', value => {
    console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo)
});

off('message')

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

取消訂閱TCPSocket連接的接收消息事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let tcp = socket.constructTCPSocketInstance();
let callback = value =>{
    console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
}
tcp.on('message', callback);
// 可以指定傳入on中的callback取消一個訂閱，也可以不指定callback清空所有訂閱。
tcp.off('message', callback);
tcp.off('message');

on('connect' | 'close')

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

訂閱TCPSocket的連接事件或關(guān)閉事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let tcp = socket.constructTCPSocketInstance();
tcp.on('connect', () => {
    console.log("on connect success")
});
tcp.on('close', data => {
    console.log("on close success")
});

off('connect' | 'close')

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

取消訂閱TCPSocket的連接事件或關(guān)閉事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let tcp = socket.constructTCPSocketInstance();
let callback1 = () =>{
    console.log("on connect success");
}
tcp.on('connect', callback1);
// 可以指定傳入on中的callback取消一個訂閱，也可以不指定callback清空所有訂閱。
tcp.off('connect', callback1);
tcp.off('connect');
let callback2 = () =>{
    console.log("on close success");
}
tcp.on('close', callback2);
// 可以指定傳入on中的callback取消一個訂閱，也可以不指定callback清空所有訂閱。
tcp.off('close', callback2);
tcp.off('close');

on('error')

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

訂閱TCPSocket連接的error事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let tcp = socket.constructTCPSocketInstance();
tcp.on('error', err => {
    console.log("on error, err:" + JSON.stringify(err))
});

off('error')

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

取消訂閱TCPSocket連接的error事件。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

示例：

let tcp = socket.constructTCPSocketInstance();
let callback = err =>{
    console.log("on error, err:" + JSON.stringify(err));
}
tcp.on('error', callback);
// 可以指定傳入on中的callback取消一個訂閱，也可以不指定callback清空所有訂閱。
tcp.off('error', callback);
tcp.off('error');

TCPConnectOptions

TCPSocket連接的參數(shù)。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

TCPSendOptions

TCPSocket發(fā)送請求的參數(shù)。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

TCPExtraOptions

TCPSocket連接的其他屬性。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

TCP 錯誤碼說明

TCP 其余錯誤碼映射形式為：2301000 + Linux內(nèi)核錯誤碼。

錯誤碼的詳細介紹參見Socket錯誤碼

socket.constructTLSSocketInstance9+

constructTLSSocketInstance(): TLSSocket

創(chuàng)建并返回一個TLSSocket對象。

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值:

示例：

let tls = socket.constructTLSSocketInstance();

TLSSocket9+

TLSSocket連接。在調(diào)用TLSSocket的方法前，需要先通過socket.constructTLSSocketInstance創(chuàng)建TLSSocket對象。

bind9+

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

綁定IP地址和端口。使用callback方法作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

bind9+

bind(address: NetAddress): Promise<void>

綁定IP地址和端口。使用Promise方法作為異步方法。

需要權(quán)限：ohos.permission.INTERNET

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

返回值：

錯誤碼：

示例：

let promise = tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1});
promise.then(() => {
  console.log('bind success');
}).catch(err => {
  console.log('bind fail');
});

getState9+

getState(callback: AsyncCallback<SocketStateBase>): void

在TLSSocket的bind成功之后，獲取TLSSocket狀態(tài)。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let promise = tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
tls.getState((err, data) => {
  if (err) {
    console.log('getState fail');
    return;
  }
  console.log('getState success:' + JSON.stringify(data));
});

getState9+

getState(): Promise<SocketStateBase>

在TLSSocket的bind成功之后，獲取TLSSocket狀態(tài)。使用Promise方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

錯誤碼：

示例：

tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let promise = tls.getState();
promise.then(() => {
  console.log('getState success');
}).catch(err => {
  console.log('getState fail');
});

setExtraOptions9+

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

在TLSSocket的bind成功之后，設(shè)置TCPSocket連接的其他屬性。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

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

setExtraOptions9+

setExtraOptions(options: TCPExtraOptions): Promise<void>

在TLSSocket的bind成功之后，設(shè)置TCPSocket連接的其他屬性，使用Promise方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

返回值：

錯誤碼：

示例：

tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let promise = tls.setExtraOptions({
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on:true, linger:10 },
  receiveBufferSize: 1000,
  sendBufferSize: 1000,
  reuseAddress: true,
  socketTimeout: 3000,
});
promise.then(() => {
  console.log('setExtraOptions success');
}).catch(err => {
  console.log('setExtraOptions fail');
});

connect9+

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

在TLSSocket上bind成功之后，進行通信連接，并創(chuàng)建和初始化TLS會話，實現(xiàn)建立連接過程，啟動與服務(wù)器的TLS/SSL握手，實現(xiàn)數(shù)據(jù)傳輸功能，使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

let tlsTwoWay = socket.constructTLSSocketInstance(); // Two way authentication
tlsTwoWay.bind({address: '192.168.xxx.xxx', port: 8080, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let options = {
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "192.168.xx.xxx",
    port: 8080,
    family: 1,
  },
  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",
  },
};
tlsTwoWay.connect(options, (err, data) => {
  console.error("connect callback error"+err);
  console.log(JSON.stringify(data));
});

let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication
  tlsOneWay.bind({address: '192.168.xxx.xxx', port: 8080, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let oneWayOptions = {
  address: {
    address: "192.168.xxx.xxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    ca: ["xxxx","xxxx"],
    cipherSuite: "AES256-SHA256",
  },
};
tlsOneWay.connect(oneWayOptions, (err, data) => {
  console.error("connect callback error"+err);
  console.log(JSON.stringify(data));
});

connect9+

connect(options: TLSConnectOptions): Promise<void>

在TLSSocket上bind成功之后，進行通信連接，并創(chuàng)建和初始化TLS會話，實現(xiàn)建立連接過程，啟動與服務(wù)器的TLS/SSL握手，實現(xiàn)數(shù)據(jù)傳輸功能，該連接包括兩種認證方式，單向認證與雙向認證，使用Promise方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

返回值：

錯誤碼：

示例：

let tlsTwoWay = socket.constructTLSSocketInstance(); // Two way authentication
tlsTwoWay.bind({address: '192.168.xxx.xxx', port: 8080, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let options = {
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "xxxx",
    port: 8080,
    family: 1,
  },
  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",
  },
};
tlsTwoWay.connect(options).then(data => {
  console.log(JSON.stringify(data));
}).catch(err => {
  console.error(err);
});

let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication
tlsOneWay.bind({address: '192.168.xxx.xxx', port: 8080, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let oneWayOptions = {
  address: {
    address: "192.168.xxx.xxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    ca: ["xxxx","xxxx"],
    cipherSuite: "AES256-SHA256",
  },
};
tlsOneWay.connect(oneWayOptions).then(data => {
  console.log(JSON.stringify(data));
}).catch(err => {
  console.error(err);
});

getRemoteAddress9+

getRemoteAddress(callback: AsyncCallback<NetAddress>): void

在TLSSocket通信連接成功之后，獲取對端Socket地址。使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

tls.getRemoteAddress((err, data) => {
  if (err) {
    console.log('getRemoteAddress fail');
    return;
  }
  console.log('getRemoteAddress success:' + JSON.stringify(data));
});

getRemoteAddress9+

getRemoteAddress(): Promise<NetAddress>

在TLSSocket通信連接成功之后，獲取對端Socket地址。使用Promise方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

錯誤碼：

示例：

let promise = tls.getRemoteAddress();
promise.then(() => {
  console.log('getRemoteAddress success');
}).catch(err => {
  console.log('getRemoteAddress fail');
});

getCertificate9+

getCertificate(callback: AsyncCallback<X509CertRawData>): void

在TLSSocket通信連接成功之后，獲取本地的數(shù)字證書，該接口只適用于雙向認證時，使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

tls.getCertificate((err, data) => {
  if (err) {
    console.log("getCertificate callback error = " + err);
  } else {
    console.log("getCertificate callback = " + data);
  }
});

getCertificate9+

getCertificate():Promise<X509CertRawData>

在TLSSocket通信連接之后，獲取本地的數(shù)字證書，該接口只適用于雙向認證時，使用Promise方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

錯誤碼：

示例：

tls.getCertificate().then(data => {
  console.log(data);
}).catch(err => {
  console.error(err);
});

getRemoteCertificate9+

getRemoteCertificate(callback: AsyncCallback<X509CertRawData>): void

在TLSSocket通信連接成功之后，獲取服務(wù)端的數(shù)字證書，使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：

錯誤碼：

示例：

tls.getRemoteCertificate((err, data) => {
  if (err) {
    console.log("getRemoteCertificate callback error = " + err);
  } else {
    console.log("getRemoteCertificate callback = " + data);
  }
});

getRemoteCertificate9+

getRemoteCertificate():Promise<X509CertRawData>

在TLSSocket通信連接成功之后，獲取服務(wù)端的數(shù)字證書，使用Promise方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

返回值：

錯誤碼：

示例：

tls.getRemoteCertificate().then(data => {
  console.log(data);
}).catch(err => {
  console.error(err);
});

getProtocol9+

getProtocol(callback: AsyncCallback<string>): void

在TLSSocket通信連接成功之后，獲取通信的協(xié)議版本，使用callback方式作為異步方法。

系統(tǒng)能力：SystemCapability.Communication.NetStack

參數(shù)：