1# Netstack 2 3 4## 概述 5 6为网络协议栈模块提供C接口。 7 8**起始版本：** 11 9 10 11## 汇总 12 13 14### 文件 15 16| 名称 | 描述 | 17| -------- | -------- | 18| [net_ssl_c.h](net__ssl__c_8h.md) | 为SSL/TLS证书链校验模块定义C接口。<br>**引用文件：** \<network\/netstack\/net_ssl\/net_ssl_c.h\> | 19| [net_ssl_c_type.h](net__ssl__c__type_8h.md) | 定义SSL/TLS证书链校验模块的C接口需要的数据结构。**引用文件：** \<network\/netstack\/net_ssl\/net_ssl_c_type.h\> | 20| [net_websocket.h](net__websocket_8h.md) | 为websocket客户端模块定义C接口。**引用文件：** \<network\/netstack\/net_websocket.h\> | 21| [net_websocket_type.h](net__websocket__type_8h.md) | 定义websocket客户端模块的C接口需要的数据结构。**引用文件：** \<network\/net_websocket_type.h\> | 22 23 24### 结构体 25 26| 名称 | 描述 | 27| -------- | -------- | 28| [NetStack_CertBlob](_net_stack___cert_blob.md) | 证书数据结构体。 | 29| [NetStack_CertificatePinning](_net_stack___certificate_pinning.md) | 证书锁定信息数据结构体。 | 30| [NetStack_Certificates](_net_stack___certificates.md) | 证书信息数据结构体。 | 31| [WebSocket_CloseResult](_web_socket___close_result.md) | websocket客户端来自服务端关闭的参数。 | 32| [WebSocket_CloseOption](_web_socket___close_option.md) | websocket客户端主动关闭的参数。 | 33| [WebSocket_ErrorResult](_web_socket___error_result.md) | websocket客户端来自服务端连接错误的参数。 | 34| [WebSocket_OpenResult](_web_socket___open_result.md) | websocket客户端来自服务端连接成功的参数。 | 35| [WebSocket_Header](_web_socket___header.md) | websocket客户端增加header头的链表节点。 | 36| [WebSocket_RequestOptions](_web_socket___request_options.md) | websocket客户端和服务端建立连接的参数。 | 37| [WebSocket](_web_socket.md) | websocket客户端结构体。 | 38 39 40### 类型定义 41 42| 名称 | 描述 | 43| -------- | -------- | 44| (\* [WebSocket_OnOpenCallback](#websocket_onopencallback)) (struct [WebSocket](_web_socket.md) \*client, [WebSocket_OpenResult](_web_socket___open_result.md) openResult) | websocket客户端接收open消息的回调函数定义。 | 45| (\* [WebSocket_OnMessageCallback](#websocket_onmessagecallback)) (struct [WebSocket](_web_socket.md) \*client, char \*data, uint32_t length) | websocket客户端接收数据的回调函数定义。 | 46| (\* [WebSocket_OnErrorCallback](#websocket_onerrorcallback)) (struct [WebSocket](_web_socket.md) \*client, [WebSocket_ErrorResult](_web_socket___error_result.md) errorResult) | websocket客户端接收error错误消息的回调函数定义。 | 47| (\* [WebSocket_OnCloseCallback](#websocket_onclosecallback)) (struct [WebSocket](_web_socket.md) \*client, [WebSocket_CloseResult](_web_socket___close_result.md) closeResult) | websocket客户端接收close消息的回调函数定义。 | 48 49### 枚举 50 51| 名称 | 描述 | 52| -------- | -------- | 53| [NetStack_CertType](#netstack_certtype) { <br/>NetStack_CERT_TYPE_PEM = 0, <br/>NetStack_CERT_TYPE_DER = 1, <br/>NetStack_CERT_TYPE_INVALID <br/>} | 证书类型枚举。 | 54| [WebSocket_ErrCode](#websocket_errcode) {<br/>WEBSOCKET_OK = 0, <br/>E_BASE = 1000, <br/>WEBSOCKET_CLIENT_NULL = (E_BASE + 1), <br/>WEBSOCKET_CLIENT_NOT_CREATED = (E_BASE + 2),<br/>WEBSOCKET_CONNECTION_ERROR = (E_BASE + 3), <br/>WEBSOCKET_CONNECTION_PARSE_URL_ERROR = (E_BASE + 5),<br/> WEBSOCKET_CONNECTION_NO_MEMORY = (E_BASE + 6), <br/>WEBSOCKET_CONNECTION_CLOSED_BY_PEER = (E_BASE + 7),<br/>WEBSOCKET_DESTROYED = (E_BASE + 8), <br/>WEBSOCKET_PROTOCOL_ERROR = (E_BASE + 9), <br/>WEBSOCKET_SEND_NO_MEMORY = (E_BASE + 10), <br/>WEBSOCKET_SEND_DATA_NULL = (E_BASE + 11),<br/>WEBSOCKET_DATA_LENGTH_EXCEEDED = (E_BASE + 12), <br/>WEBSOCKET_QUEUE_LENGTH_EXCEEDED = (E_BASE + 13),<br/> WEBSOCKET_NO_CLIENT_CONTEXT = (E_BASE + 14), <br/>WEBSOCKET_NO_HEADER_CONTEXT = (E_BASE + 15),<br/>WEBSOCKET_HEADER_EXCEEDED = (E_BASE + 16), <br/>WEBSOCKET_NO_CONNECTION = (E_BASE + 17), <br/>WEBSOCKET_NO_CONNECTION_CONTEXT = (E_BASE + 18)<br/>} | websocket错误码。 | 55| [NetStack_CertificatePinningKind](#netstack_certificatepinningkind) {<br/>PUBLIC_KEY,<br/>} | 证书锁定类型。 | 56| [NetStack_HashAlgorithm](#netstack_hashalgorithm) {<br/>SHA_256,<br/>} | 哈希算法类型。 | 57 58### 函数 59 60| 名称 | 描述 | 61| -------- | -------- | 62| [OH_WebSocketClient_Constructor](#oh_websocketclient_constructor) ([WebSocket_OnOpenCallback](#websocket_onopencallback) onOpen, [WebSocket_OnMessageCallback](#websocket_onmessagecallback) onMessage, [WebSocket_OnErrorCallback](#websocket_onerrorcallback) onError, [WebSocket_OnCloseCallback](#websocket_onclosecallback) onclose) | Websocket客户端的构造函数。 | 63| [OH_WebSocketClient_AddHeader](#oh_websocketclient_addheader) (struct [WebSocket](_web_socket.md) \*client, struct [WebSocket_Header](_web_socket___header.md) header) | 将header头信息添加到client客户端request中。 | 64| [OH_WebSocketClient_Connect](#oh_websocketclient_connect) (struct [WebSocket](_web_socket.md) \*client, const char \*url, struct [WebSocket_RequestOptions](_web_socket___request_options.md) options) | 客户端连接服务端。 | 65| [OH_WebSocketClient_Send](#oh_websocketclient_send) (struct [WebSocket](_web_socket.md) \*client, char \*data, size_t length) | 客户端向服务端发送数据。 | 66| [OH_WebSocketClient_Close](#oh_websocketclient_close) (struct [WebSocket](_web_socket.md) \*client, struct [WebSocket_CloseOption](_web_socket___close_option.md) options) | 客户端主动关闭websocket连接。 | 67| [OH_WebSocketClient_Destroy](#oh_websocketclient_destroy) (struct [WebSocket](_web_socket.md) \*client) | 释放websocket连接上下文和资源。 | 68| [OH_NetStack_GetPinSetForHostName](#oh_netstack_getpinsetforhostname)(const char \*hostname, [NetStack_CertificatePinning](_net_stack___certificate_pinning.md) \*pin) | 获取证书锁定信息。 | 69| [OH_NetStack_GetCertificatesForHostName](#oh_netstack_getcertificatesforhostname)(const char \*hostname, [NetStack_Certificates](_net_stack___certificates.md) \*certs) | 获取证书信息。 | 70| [OH_Netstack_DestroyCertificatesContent](#oh_netstack_destroycertificatescontent)([NetStack_Certificates](_net_stack___certificates.md) \*certs) | 释放证书内容。 | 71 72### 变量 73 74| 名称 | 描述 | 75| -------- | -------- | 76| [NetStack_CertBlob::type](#type) | 证书类型。 | 77| [NetStack_CertBlob::size](#size) | 证书内容长度。 | 78| [NetStack_CertBlob::data](#data) | 证书内容。 | 79| [NetStack_CertificatePinning::kind](#kind) | 证书锁定类型。 | 80| [NetStack_CertificatePinning::hashAlgorithm](#hashalgorithm) | 哈希算法。 | 81| [NetStack_CertificatePinning::publicKeyHash](#publickeyhash) | 哈希值。 | 82| [NetStack_Certificates::content](#content) | 证书的PEM内容。 | 83| [NetStack_Certificates::length](#length) | 证书数量。 | 84| [WebSocket_CloseResult::code](#code-13) | 关闭值。 | 85| [WebSocket_CloseResult::reason](#reason-13) | 关闭原因。 | 86| [WebSocket_CloseOption::code](#code-23) | 关闭值。 | 87| [WebSocket_CloseOption::reason](#reason-23) | 关闭原因。 | 88| [WebSocket_ErrorResult::errorCode](#errorcode) | 错误码。 | 89| [WebSocket_ErrorResult::errorMessage](#errormessage) | 错误的消息。 | 90| [WebSocket_OpenResult::code](#code-33) | websocket客户端连接成功码。 | 91| [WebSocket_OpenResult::reason](#reason-33) | websocket客户端连接原因。 | 92| [WebSocket_Header::fieldName](#fieldname) | header头的字段名。 | 93| [WebSocket_Header::fieldValue](#fieldvalue) | header头的字段内容。 | 94| [WebSocket_Header](_web_socket___header.md) \* [WebSocket_Header::next](#next) | header头链表的next指针。 | 95| [WebSocket_Header](_web_socket___header.md) \* WebSocket_RequestOptions::headers | header头信息。 | 96| [WebSocket_OnOpenCallback](#websocket_onopencallback) [WebSocket::onOpen](#onopen) | 客户端接收连接消息的回调指针。 | 97| [WebSocket_OnMessageCallback](#websocket_onmessagecallback) [WebSocket::onMessage](#onmessage) | 客户端接收消息的回调指针。 | 98| [WebSocket_OnErrorCallback](#websocket_onerrorcallback) [WebSocket::onError](#onerror) | 客户端接收错误消息的回调指针。 | 99| [WebSocket_OnCloseCallback](#websocket_onclosecallback) [WebSocket::onClose](#onclose) | 客户端接收关闭消息的回调指针。 | 100| [WebSocket_RequestOptions](_web_socket___request_options.md) [WebSocket::requestOptions](#requestoptions) | 客户端建立连接请求内容。 | 101 102 103## 类型定义说明 104 105 106### WebSocket_OnCloseCallback 107 108``` 109typedef void(* WebSocket_OnCloseCallback) (struct WebSocket *client, WebSocket_CloseResult closeResult) 110``` 111**描述** 112websocket客户端接收close消息的回调函数定义 113 114**起始版本：** 11 115 116**参数:** 117 118| 名称 | 描述 | 119| -------- | -------- | 120| client | websocket客户端 | 121| closeResult | websocket客户端接收关闭消息的内容 | 122 123 124### WebSocket_OnErrorCallback 125 126``` 127typedef void(* WebSocket_OnErrorCallback) (struct WebSocket *client, WebSocket_ErrorResult errorResult) 128``` 129**描述** 130websocket客户端接收error错误消息的回调函数定义 131 132**起始版本：** 11 133 134**参数:** 135 136| 名称 | 描述 | 137| -------- | -------- | 138| client | websocket客户端 | 139| errorResult | websocket客户端接收连接错误消息的内容 | 140 141 142### WebSocket_OnMessageCallback 143 144``` 145typedef void(* WebSocket_OnMessageCallback) (struct WebSocket *client, char *data, uint32_t length) 146``` 147**描述** 148websocket客户端接收数据的回调函数定义 149 150**起始版本：** 11 151 152**参数:** 153 154| 名称 | 描述 | 155| -------- | -------- | 156| client | websocket客户端 | 157| data | websocket客户端接收的数据 | 158| length | websocket客户端接收的数据长度 | 159 160 161### WebSocket_OnOpenCallback 162 163``` 164typedef void(* WebSocket_OnOpenCallback) (struct WebSocket *client, WebSocket_OpenResult openResult) 165``` 166**描述** 167websocket客户端接收open消息的回调函数定义 168 169**起始版本：** 11 170 171**参数:** 172 173| 名称 | 描述 | 174| -------- | -------- | 175| client | websocket客户端 | 176| openResult | websocket客户端接收建立连接消息的内容 | 177 178 179 180## 枚举类型说明 181 182 183### NetStack_CertType 184 185``` 186enum NetStack_CertType 187``` 188 189**描述** 190 191证书类型枚举。 192 193**起始版本：** 11 194 195| 枚举值 | 描述 | 196| -------- | -------- | 197| NetStack_CERT_TYPE_PEM | PEM证书类型。 | 198| NetStack_CERT_TYPE_DER | DER证书类型。 | 199| NetStack_CERT_TYPE_INVALID | 错误证书类型。 | 200 201 202### WebSocket_ErrCode 203 204``` 205enum WebSocket_ErrCode 206``` 207**描述** 208websocket错误码 209 210**起始版本：** 11 211 212| 枚举值 | 描述 | 213| -------- | -------- | 214| WEBSOCKET_OK | 执行成功。 | 215| E_BASE | 异常错误代码的基础。 | 216| WEBSOCKET_CLIENT_NULL | websocket为空。 | 217| WEBSOCKET_CLIENT_NOT_CREATED | websocket未创建。 | 218| WEBSOCKET_CONNECTION_ERROR | websocket客户端连接错误。 | 219| WEBSOCKET_CONNECTION_PARSE_URL_ERROR | websocket客户端连接参数解析错误。 | 220| WEBSOCKET_CONNECTION_NO_MEMORY | websocket客户端连接时创建上下文无内存。 | 221| WEBSOCKET_CONNECTION_CLOSED_BY_PEER | 初始化时候关闭。 | 222| WEBSOCKET_DESTROYED | websocket连接被销毁。 | 223| WEBSOCKET_PROTOCOL_ERROR | websocket客户端连接时候协议错误。 | 224| WEBSOCKET_SEND_NO_MEMORY | websocket客户端发送数据时候没有足够内存。 | 225| WEBSOCKET_SEND_DATA_NULL | websocket客户端发送数据为空。 | 226| WEBSOCKET_DATA_LENGTH_EXCEEDED | websocket客户端发送数据长度超限制。 | 227| WEBSOCKET_QUEUE_LENGTH_EXCEEDED | websocket客户端发送数据队列长度超限制。 | 228| WEBSOCKET_NO_CLIENT_CONTEXT | websocket客户端上下文为空。 | 229| WEBSOCKET_NO_HEADER_CONTEXT | websocket客户端header头异常。 | 230| WEBSOCKET_HEADER_EXCEEDED | websocket客户端header头超过限制。 | 231| WEBSOCKET_NO_CONNECTION | websocket客户端没有连接。 | 232| WEBSOCKET_NO_CONNECTION_CONTEXT | websocket客户端没有连接上下文。 | 233 234### NetStack_CertificatePinningKind 235 236``` 237enum NetStack_CertificatePinningKind 238``` 239 240**描述** 241 242证书锁定类型枚举。 243 244**起始版本：** 12 245 246| 枚举值 | 描述 | 247| ---------- | -------------- | 248| PUBLIC_KEY | 公钥锁定类型。 | 249 250### NetStack_HashAlgorithm 251 252``` 253enum NetStack_HashAlgorithm 254``` 255 256**描述** 257 258哈希算法。 259 260**起始版本：** 12 261 262| 枚举值 | 描述 | 263| ------- | ------------- | 264| SHA_256 | SHA-256算法。 | 265 266## 函数说明 267 268 269### OH_NetStack_CertVerification() 270 271``` 272uint32_t OH_NetStack_CertVerification(const struct NetStack_CertBlob * cert, const struct NetStack_CertBlob * caCert ) 273``` 274 275**描述** 276 277证书链校验接口。 278 279**系统能力：** SystemCapability.Communication.NetStack 280 281**起始版本：** 11 282 283**参数:** 284 285| 名称 | 描述 | 286| -------- | -------- | 287| cert | 用户传入的待校验证书。 | 288| caCert | 用户指定的证书，若为空则以系统预置证书进行校验。 | 289 290**返回：** 291 2920 - 成功. 293 2942305001 - 未指定的错误. 295 2962305002 - 无法获取颁发者证书. 297 2982305003 - 无法获取证书吊销列表（CRL）. 299 3002305004 - 无法解密证书签名. 301 3022305005 - 无法解密CRL签名. 303 3042305006 - 无法解码颁发者公钥. 305 3062305007 - 证书签名失败. 307 3082305008 - CRL签名失败. 309 3102305009 - 证书尚未生效. 311 3122305010 - 证书已过期. 313 3142305011 - CRL尚未有效. 315 3162305012 - CRL已过期. 317 3182305023 - 证书已被吊销. 319 3202305024 - 证书颁发机构（CA）无效. 321 3222305027 - 证书不受信任. 323 3242305069 - 证书验证时发生错误调用或无效的参数. 325 326### OH_NetStack_GetPinSetForHostName() 327 328``` 329int32_t OH_NetStack_GetPinSetForHostName (const char * hostname, NetStack_CertificatePinning * pin) 330``` 331 332**描述** 333 334获取证书锁定信息。 335 336**系统能力：** SystemCapability.Communication.NetStack 337 338**起始版本：** 12 339 340**参数:** 341 342| 名称 | 描述 | 343| -------- | ------------------------------ | 344| hostname | 主机名。 | 345| pin | 用户接受证书锁定信息的结构体。 | 346 347**返回：** 348 3490 - 成功. 350 351401- 参数设置错误. 352 3532305999 - 内存错误. 354 355### OH_NetStack_GetCertificatesForHostName() 356 357``` 358int32_t OH_NetStack_GetCertificatesForHostName(const char * hostname, NetStack_Certificates * certs) 359``` 360 361**描述** 362 363获取证书信息。 364 365**系统能力：** SystemCapability.Communication.NetStack 366 367**起始版本：** 12 368 369**参数:** 370 371| 名称 | 描述 | 372| -------- | -------------------------- | 373| hostname | 主机名。 | 374| certs | 用户接受证书信息的结构体。 | 375 376**返回：** 377 3780 - 成功. 379 380401- 参数设置错误. 381 3822305999 - 内存错误. 383 384### OH_Netstack_DestroyCertificatesContent() 385 386``` 387void OH_Netstack_DestroyCertificatesContent(NetStack_Certificates * certs) 388``` 389 390**描述** 391 392释放证书内容(certs->content)，当NetStack_Certificates使用结束时调用此方法释放该结构体中证书的内存。 393 394**系统能力：** SystemCapability.Communication.NetStack 395 396**起始版本：** 12 397 398**参数:** 399 400| 名称 | 描述 | 401| ----- | ---------------- | 402| certs | 证书信息结构体。 | 403 404### OH_WebSocketClient_AddHeader() 405 406``` 407int OH_WebSocketClient_AddHeader (struct WebSocket * client, struct WebSocket_Header header ) 408``` 409**描述** 410将header头信息添加到client客户端request中。 411 412**系统能力：** SystemCapability.Communication.NetStack 413 414**起始版本：** 11 415 416**参数:** 417 418| 名称 | 描述 | 419| -------- | -------- | 420| client | 客户端指针。 | 421| header | header头信息。 | 422 423**返回：** 424 425返回值为0表示执行成功。返回错细信息可以查看**OH_Websocket_ErrCode**。 426 427 428 429### OH_WebSocketClient_Close() 430 431``` 432int OH_WebSocketClient_Close (struct WebSocket * client, struct WebSocket_CloseOption options ) 433``` 434**描述** 435客户端主动关闭websocket连接。 436 437**系统能力：** SystemCapability.Communication.NetStack 438 439**起始版本：** 11 440 441**参数:** 442 443| 名称 | 描述 | 444| -------- | -------- | 445| client | 客户端。 | 446| url | 客户端要连接到服务端的地址。 | 447| options | 发起关闭连接的可选参数。 | 448 449**返回：** 450 451返回值为0表示执行成功。返回错细信息可以查看**OH_Websocket_ErrCode**。 452 453**Permission：** 454 455ohos.permission.INTERNET 456 457 458### OH_WebSocketClient_Connect() 459 460``` 461int OH_WebSocketClient_Connect (struct WebSocket * client, const char * url, struct WebSocket_RequestOptions options ) 462``` 463**描述** 464客户端连接服务端。 465 466**系统能力：** SystemCapability.Communication.NetStack 467 468**起始版本：** 11 469 470**参数:** 471 472| 名称 | 描述 | 473| -------- | -------- | 474| client | 客户端指针。 | 475| url | 客户端要连接到服务端的地址。 | 476| options | 发起连接的可选参数。 | 477 478**返回：** 479 480返回值为0表示执行成功。返回错细信息可以查看**OH_Websocket_ErrCode**。 481 482**Permission：** 483 484ohos.permission.INTERNET 485 486 487### OH_WebSocketClient_Constructor() 488 489``` 490struct WebSocket* OH_WebSocketClient_Constructor (WebSocket_OnOpenCallback onOpen, WebSocket_OnMessageCallback onMessage, WebSocket_OnErrorCallback onError, WebSocket_OnCloseCallback onclose ) 491``` 492**描述** 493Websocket客户端的构造函数。 494 495**系统能力：** SystemCapability.Communication.NetStack 496 497**起始版本：** 11 498 499**参数:** 500 501| 名称 | 描述 | 502| -------- | -------- | 503| onMessage | 客户端定义的接收消息的回调函数。 | 504| onClose | 客户端定义的关闭消息的回调函数。 | 505| onError | 客户端定义的错误消息的回调函数。 | 506| onOpen | 客户端定义的建立连接消息的回调函数。 | 507 508**返回：** 509 510成功返回客户端指针，失败返回为NULL。 511 512 513 514### OH_WebSocketClient_Destroy() 515 516``` 517int OH_WebSocketClient_Destroy (struct WebSocket * client) 518``` 519**描述** 520释放websocket连接上下文和资源。 521 522**系统能力：** SystemCapability.Communication.NetStack 523 524**起始版本：** 11 525 526**参数:** 527 528| 名称 | 描述 | 529| -------- | -------- | 530| client | 客户端。 | 531 532**返回：** 533 534返回值为0表示执行成功。返回错细信息可以查看**OH_Websocket_ErrCode**。 535 536**Permission：** 537 538ohos.permission.INTERNET 539 540 541### OH_WebSocketClient_Send() 542 543``` 544int OH_WebSocketClient_Send (struct WebSocket * client, char * data, size_t length ) 545``` 546**描述** 547客户端向服务端发送数据。 548 549**系统能力：** SystemCapability.Communication.NetStack 550 551**起始版本：** 11 552 553**参数:** 554 555| 名称 | 描述 | 556| -------- | -------- | 557| client | 客户端。 | 558| data | 客户端发送的数据。 | 559| length | 客户端发送的数据长度。 | 560 561**返回：** 562 5630 - 成功. 564 565返回值为0表示执行成功。返回错细信息可以查看**OH_Websocket_ErrCode**。 566 567**Permission：** 568 569ohos.permission.INTERNET 570 571## 变量说明 572 573 574### data 575 576``` 577uint8_t* NetStack_CertBlob::data 578``` 579 580**描述** 581 582证书内容。 583 584 585### size 586 587``` 588uint32_t NetStack_CertBlob::size 589``` 590 591**描述** 592 593证书内容长度。 594 595 596### type 597 598``` 599enum NetStack_CertType NetStack_CertBlob::type 600``` 601 602**描述** 603 604证书类型。 605 606### kind 607 608``` 609enum NetStack_CertificatePinningKind NetStack_CertificatePinning::kind 610``` 611 612**描述** 613 614证书锁定类型。 615 616### hashAlgorithm 617 618``` 619enum NetStack_HashAlgorithm NetStack_CertificatePinning::hashAlgorithm 620``` 621 622**描述** 623 624哈希算法。 625 626### publicKeyHash 627 628``` 629char* NetStack_CertificatePinning::publicKeyHash 630``` 631 632**描述** 633 634哈希值。 635 636### content 637 638``` 639char** NetStack_Certificates::content 640``` 641 642**描述** 643 644证书的PEM内容。 645 646### length 647 648``` 649size_t NetStack_Certificates::length 650``` 651 652**描述** 653 654证书数量。 655 656### code [1/3] 657 658``` 659uint32_t WebSocket_CloseResult::code 660``` 661 662**描述** 663 664关闭值。 665 666 667### code [2/3] 668 669``` 670uint32_t WebSocket_CloseOption::code 671``` 672 673**描述** 674 675关闭值。 676 677 678### code [3/3] 679 680``` 681uint32_t WebSocket_OpenResult::code 682``` 683 684**描述** 685 686websocket客户端连接成功码。 687 688 689### errorCode 690 691``` 692uint32_t WebSocket_ErrorResult::errorCode 693``` 694 695**描述** 696 697错误码。 698 699 700### errorMessage 701 702``` 703const char* WebSocket_ErrorResult::errorMessage 704``` 705 706**描述** 707 708错误的消息。 709 710 711### fieldName 712 713``` 714const char* WebSocket_Header::fieldName 715``` 716 717**描述** 718 719header头的字段名。 720 721 722### fieldValue 723 724``` 725const char* WebSocket_Header::fieldValue 726``` 727 728**描述** 729 730header头的字段内容。 731 732 733### next 734 735``` 736struct WebSocket_Header* WebSocket_Header::next 737``` 738 739**描述** 740 741header头链表的next指针。 742 743 744### onClose 745 746``` 747WebSocket_OnCloseCallback WebSocket::onClose 748``` 749 750**描述** 751 752客户端接收关闭消息的回调指针。 753 754 755### onError 756 757``` 758WebSocket_OnErrorCallback WebSocket::onError 759``` 760 761**描述** 762 763客户端接收错误消息的回调指针。 764 765 766### onMessage 767 768``` 769WebSocket_OnMessageCallback WebSocket::onMessage 770``` 771 772**描述** 773 774客户端接收消息的回调指针。 775 776 777### onOpen 778 779``` 780WebSocket_OnOpenCallback WebSocket::onOpen 781``` 782 783**描述** 784 785客户端接收连接消息的回调指针。 786 787 788### reason [1/3] 789 790``` 791const char* WebSocket_CloseResult::reason 792``` 793 794**描述** 795 796关闭原因。 797 798 799### reason [2/3] 800 801``` 802const char* WebSocket_CloseOption::reason 803``` 804 805**描述** 806 807关闭原因。 808 809 810### reason [3/3] 811 812``` 813const char* WebSocket_OpenResult::reason 814``` 815 816**描述** 817 818websocket客户端连接原因。 819 820 821### requestOptions 822 823``` 824WebSocket_RequestOptions WebSocket::requestOptions 825``` 826 827**描述** 828 829客户端建立连接请求内容。