添加READEME

Signed-off-by: maosiping <maosiping@huawei.com>
This commit is contained in:
maosiping 2021-11-12 14:08:30 +08:00
parent e15029146e
commit 29acc13724
2 changed files with 85 additions and 0 deletions

43
READEME.md Normal file
View File

@ -0,0 +1,43 @@
# Network Stack Component<a name="EN-US_TOPIC_0000001125689015"></a>
- [Introduction](#section11660541593)
- [Directory Structure](#section1464106163817)
- [Available APIs](#section1096322014288)
- [Repositories Involved](#section11683135113011)
## Introduction<a name="section11660541593"></a>
The **network stack component** is an adaptation layer framework for developers to develop the HTTP protocol stack API of openharmony applications. At present, it mainly consists of the following two parts:
1. NAPI based JS adaptation layer on L2.
2. JSI based JS adaptation layer on L0 and L1
## Directory Structure<a name="section1464106163817"></a>
The source code of the network stack component is stored in **/foundation/communication/netstack**. The directory structure is as follows:
```
/foundation/communication/netstack
├── frameworks # Framework code
│ ├── js # JS adaptation
│ ├── builtin # JSI based JS adaptation layer on L0 and L1
│ └── napi # NAPI based JS adaptation layer on L2.
│ └── kits # Huawei SDK API, including Java, JS and native. At present, there is only JS
│ └── js # JS API
├── utils # Common tools
│ └── log # Log tool
```
## Available APIs<a name="section1096322014288"></a>
For details about the APIs, see the [JS Application Development](https://device.harmonyos.com/en/docs/apiref/js-framework-file-0000000000616658).
## Repositories Involved<a name="section11683135113011"></a>
[ ace_engine_lite ](https://gitee.com/openharmony/ace_engine_lite)
[ third_party_curl ](https://gitee.com/openharmony/third_party_curl)
[ third_party_mbedtls ](https://gitee.com/openharmony/third_party_mbedtls)

42
README_zh.md Normal file
View File

@ -0,0 +1,42 @@
# 电话子系统网络协议栈组件<a name="ZH-CN_TOPIC_0000001125689015"></a>
- [简介](#section11660541593)
- [目录](#section1464106163817)
- [接口](#section1096322014288)
- [相关仓](#section11683135113011)
## 简介<a name="section11660541593"></a>
**电话子系统网络协议栈组件**是OpenHarmony为开发者提供的一套开发OpenHarmony应用的Http协议栈的API的适配层框架。目前主要由以下两部分组成:
1、L2上基于NAPI的JS适配层。
2、L0、L1上基于JSI的JS适配层。
## 目录<a name="section1464106163817"></a>
电话子系统网络协议栈组件源代码在 **/foundation/communication/netstack**,目录结构如下图所示:
```
/foundation/communication/netstack
├── frameworks # 框架代码目录
│ ├── js # JS适配层
│ ├── builtin # L0、L1上基于JSI的JS适配层
│ └── napi # L2上基于NAPI的JS适配层
│ └── kits # Huawei SDK API, 包括Java、Js、Native, 目前只有JS
│ └── js # JS API
├── utils # 公共工具
│ └── log # 日志工具
```
## 接口<a name="section1096322014288"></a>
API介绍请参考[《OpenHarmony Device开发API参考》](https://device.harmonyos.com/cn/docs/develop/apiref/js-framework-file-0000000000611396)
## 相关仓<a name="section11683135113011"></a>
[ ace_engine_lite ](https://gitee.com/openharmony/ace_engine_lite)
[ third_party_curl ](https://gitee.com/openharmony/third_party_curl)
[ third_party_mbedtls ](https://gitee.com/openharmony/third_party_mbedtls)