# mars

**Repository Path**: zhangjun93/mars

## Basic Information

- **Project Name**: mars
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 23
- **Created**: 2022-06-15
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mars

### 项目简介

Mars 是一个跨平台的网络组件，包括主要用于网络请求中的长连接，短连接，是基于 socket 层的解决方案，在网络调优方面有更好的可控性，暂不支持HTTP协议。
Mars 极大的方便了开发者的开发效率。

### 效果演示
![效果演示](preview.png)

### 下载安装

1. 参考安装教程 [如何安装OpenHarmony npm包](https://gitee.com/openharmony-tpc/docs/blob/master/OpenHarmony_npm_usage.md)
2. 安装命令如下：
 ```
 npm install @ohos/mars --save
 ```

### 使用说明：

第一步： 初始化,导入 Mars 组件到自己项目中；
```mars
...
import { Mars, StnLogic, Xlog, BuildConfig } from '@ohos/Mars/';
import MarsServiceNative from '../wrapper/service/MarsServiceNative';
import MarsServiceProfile from '../wrapper/service/MarsServiceProfile';
import marsnapi from 'libmarsnapi.so';

...

```
第二步：方法调用，通过marsnapi调用对应方法；
```mars
marsnapi.BaseEvent_onCreate();
}
```

### 接口说明

	marsnapi.BaseEvent_onCreate();
	
	marsnapi.BaseEvent_onInitConfigBeforeOnCreate(packer_encoder_version);
	
	marsnapi.BaseEvent_onDestroy();
	
	marsnapi.BaseEvent_onForeground(true);
	
	marsnapi.BaseEvent_onNetworkChange();
	
	marsnapi.BaseEvent_onSingalCrash(sig);
	
	marsnapi.BaseEvent_onExceptionCrash();
	
	marsnapi.StnLogic_setLonglinkSvrAddr(profile.longLinkHost(), profile.longLinkPorts(), "");
	
	marsnapi.StnLogic_startTask(_task);
	
	marsnapi.StnLogic_stopTask();
	
	marsnapi.StnLogic_hasTask(taskid);
	
	marsnapi.StnLogic_redoTask();
	
	marsnapi.StnLogic_clearTask();
	
	marsnapi.StnLogic_makesureLongLinkConnected();
	
	marsnapi.StnLogic_setSignallingStrategy();


### 兼容性

支持OpenHarmony  API version 9 及以上版本

### 目录结构
```
|---- Mars  
|     |---- cpp  # 示例代码文件夹
|           |---- mars # C++库文件
|     |---- ets
|           |---- sdk  # 对外封装接口
|     |---- README.md  # 安装使用方法
```

### 贡献代码
使用过程中发现任何问题都可以提 [Issue](https://gitee.com/hihopeorg/mars/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://gitee.com/hihopeorg/mars/pulls) 。

### 开源协议
本项目基于 [Apache License 2.0](https://gitee.com/hihopeorg/mars/blob/master/LICENSE) ，请自由地享受和参与开源。