Netstack

概述

为网络协议栈模块提供C接口。

起始版本： 11

汇总

[h2]文件

[h2]结构体

[h2]类型定义

[h2]枚举

[h2]函数

[h2]变量

类型定义说明

[h2]WebSocket_OnCloseCallback

typedef void(* WebSocket_OnCloseCallback) (struct WebSocket *client, WebSocket_CloseResult closeResult)

描述

websocket客户端接收close消息的回调函数定义

起始版本： 11

参数:

[h2]WebSocket_OnErrorCallback

typedef void(* WebSocket_OnErrorCallback) (struct WebSocket *client, WebSocket_ErrorResult errorResult)

描述

websocket客户端接收error错误消息的回调函数定义

起始版本： 11

参数:

[h2]WebSocket_OnMessageCallback

typedef void(* WebSocket_OnMessageCallback) (struct WebSocket *client, char *data, uint32_t length)

描述

websocket客户端接收数据的回调函数定义

起始版本： 11

参数:

[h2]WebSocket_OnOpenCallback

typedef void(* WebSocket_OnOpenCallback) (struct WebSocket *client, WebSocket_OpenResult openResult)

描述

websocket客户端接收open消息的回调函数定义

起始版本： 11

参数:

枚举类型说明

[h2]NetStack_CertType

enum NetStack_CertType

描述

证书类型枚举。

起始版本： 11

[h2]WebSocket_ErrCode

enum WebSocket_ErrCode

描述

websocket错误码

起始版本： 11

[h2]NetStack_CertificatePinningKind

enum NetStack_CertificatePinningKind

描述

证书锁定类型枚举。

起始版本： 12

[h2]NetStack_HashAlgorithm

enum NetStack_HashAlgorithm

描述

哈希算法。

起始版本： 12

函数说明

[h2]OH_NetStack_CertVerification()

uint32_t OH_NetStack_CertVerification(const struct NetStack_CertBlob * cert, const struct NetStack_CertBlob * caCert )

描述

证书链校验接口。

系统能力： SystemCapability.Communication.NetStack

起始版本： 11

参数:

返回：

0 - 成功.

2305001 - 未指定的错误.

2305002 - 无法获取颁发者证书.

2305003 - 无法获取证书吊销列表（CRL）.

2305004 - 无法解密证书签名.

2305005 - 无法解密CRL签名.

2305006 - 无法解码颁发者公钥.

2305007 - 证书签名失败.

2305008 - CRL签名失败.

2305009 - 证书尚未生效.

2305010 - 证书已过期.

2305011 - CRL尚未有效.

2305012 - CRL已过期.

2305023 - 证书已被吊销.

2305024 - 证书颁发机构（CA）无效.

2305027 - 证书不受信任.

2305069 - 证书验证时发生错误调用或无效的参数.

[h2]OH_NetStack_GetPinSetForHostName()

int32_t OH_NetStack_GetPinSetForHostName (const char * hostname, NetStack_CertificatePinning * pin)

描述

获取证书锁定信息。

系统能力： SystemCapability.Communication.NetStack

起始版本： 12

参数:

返回：

0 - 成功.

401- 参数设置错误.

2305999 - 内存错误.

[h2]OH_NetStack_GetCertificatesForHostName()

int32_t OH_NetStack_GetCertificatesForHostName(const char * hostname, NetStack_Certificates * certs)

描述

获取证书信息。

系统能力： SystemCapability.Communication.NetStack

起始版本： 12

参数:

返回：

0 - 成功.

401- 参数设置错误.

2305999 - 内存错误.

[h2]OH_Netstack_DestroyCertificatesContent()

void OH_Netstack_DestroyCertificatesContent(NetStack_Certificates * certs)

描述

释放证书内容(certs->content)，当NetStack_Certificates使用结束时调用此方法释放该结构体中证书的内存。

系统能力： SystemCapability.Communication.NetStack

起始版本： 12

参数:

[h2]OH_WebSocketClient_AddHeader()

int OH_WebSocketClient_AddHeader (struct WebSocket * client, struct WebSocket_Header header )

描述

将header头信息添加到client客户端request中。

系统能力： SystemCapability.Communication.NetStack

起始版本： 11

参数:

返回：

返回值为0表示执行成功。返回错细信息可以查看OH_Websocket_ErrCode。

[h2]OH_WebSocketClient_Close()

int OH_WebSocketClient_Close (struct WebSocket * client, struct WebSocket_CloseOption options )

描述

客户端主动关闭websocket连接。

系统能力： SystemCapability.Communication.NetStack

起始版本： 11

参数:

返回：

返回值为0表示执行成功。返回错细信息可以查看OH_Websocket_ErrCode。

Permission：

ohos.permission.INTERNET

[h2]OH_WebSocketClient_Connect()

int OH_WebSocketClient_Connect (struct WebSocket * client, const char * url, struct WebSocket_RequestOptions options )

描述

客户端连接服务端。

系统能力： SystemCapability.Communication.NetStack

起始版本： 11

参数:

返回：

返回值为0表示执行成功。返回错细信息可以查看OH_Websocket_ErrCode。

Permission：

ohos.permission.INTERNET

[h2]OH_WebSocketClient_Constructor()

struct WebSocket* OH_WebSocketClient_Constructor (WebSocket_OnOpenCallback onOpen, WebSocket_OnMessageCallback onMessage, WebSocket_OnErrorCallback onError, WebSocket_OnCloseCallback onclose )

描述

Websocket客户端的构造函数。

系统能力： SystemCapability.Communication.NetStack

起始版本： 11

参数:

返回：

成功返回客户端指针，失败返回为NULL。

[h2]OH_WebSocketClient_Destroy()

int OH_WebSocketClient_Destroy (struct WebSocket * client)

描述

释放websocket连接上下文和资源。

系统能力： SystemCapability.Communication.NetStack

起始版本： 11

参数:

返回：

返回值为0表示执行成功。返回错细信息可以查看OH_Websocket_ErrCode。

Permission：

ohos.permission.INTERNET

[h2]OH_WebSocketClient_Send()

int OH_WebSocketClient_Send (struct WebSocket * client, char * data, size_t length )

描述

客户端向服务端发送数据。

系统能力： SystemCapability.Communication.NetStack

起始版本： 11

参数:

返回：

0 - 成功.

返回值为0表示执行成功。返回错细信息可以查看OH_Websocket_ErrCode。

Permission：

ohos.permission.INTERNET

变量说明

[h2]data

uint8_t* NetStack_CertBlob::data

描述

证书内容。

[h2]size

uint32_t NetStack_CertBlob::size

描述

证书内容长度。

[h2]type

enum NetStack_CertType NetStack_CertBlob::type

描述

证书类型。

[h2]kind

enum NetStack_CertificatePinningKind NetStack_CertificatePinning::kind

描述

证书锁定类型。

[h2]hashAlgorithm

enum NetStack_HashAlgorithm NetStack_CertificatePinning::hashAlgorithm

描述

哈希算法。

[h2]publicKeyHash

char* NetStack_CertificatePinning::publicKeyHash

描述

哈希值。

[h2]content

char** NetStack_Certificates::content

描述

证书的PEM内容。

[h2]length

size_t NetStack_Certificates::length

描述

证书数量。

[h2]code [1/3]

uint32_t WebSocket_CloseResult::code

描述

关闭值。

[h2]code [2/3]

uint32_t WebSocket_CloseOption::code

描述

关闭值。

[h2]code [3/3]

uint32_t WebSocket_OpenResult::code

描述

websocket客户端连接成功码。

[h2]errorCode

uint32_t WebSocket_ErrorResult::errorCode

描述

错误码。

[h2]errorMessage

const char* WebSocket_ErrorResult::errorMessage

描述

错误的消息。

[h2]fieldName

const char* WebSocket_Header::fieldName

描述

header头的字段名。

[h2]fieldValue

const char* WebSocket_Header::fieldValue

描述

header头的字段内容。

[h2]next

struct WebSocket_Header* WebSocket_Header::next

描述

header头链表的next指针。

[h2]onClose

WebSocket_OnCloseCallback WebSocket::onClose

描述

客户端接收关闭消息的回调指针。

[h2]onError

WebSocket_OnErrorCallback WebSocket::onError

描述

客户端接收错误消息的回调指针。

[h2]onMessage

WebSocket_OnMessageCallback WebSocket::onMessage

描述

客户端接收消息的回调指针。

[h2]onOpen

WebSocket_OnOpenCallback WebSocket::onOpen

描述

客户端接收连接消息的回调指针。

[h2]reason [1/3]

const char* WebSocket_CloseResult::reason

描述

关闭原因。

[h2]reason [2/3]

const char* WebSocket_CloseOption::reason

描述

关闭原因。

[h2]reason [3/3]

const char* WebSocket_OpenResult::reason

描述

websocket客户端连接原因。

[h2]requestOptions

WebSocket_RequestOptions WebSocket::requestOptions

描述

客户端建立连接请求内容。