# OkSocket

**Repository Path**: chinasoft2_ohos/OkSocket

## Basic Information

- **Project Name**: OkSocket
- **Description**: 一款基于Tcp协议的Socket通讯（长连接）
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 4
- **Created**: 2021-05-10
- **Last Updated**: 2023-10-09

## Categories & Tags

**Categories**: harmonyos-network

**Tags**: None

## README

# OkSocket

## 项目介绍
- 项目名称：OkSocket
- 所属系列：openharmony的第三方组件适配移植
- 功能：是一款基于Tcp协议的Socket通讯（长连接）
- 项目移植状态：主功能完成
- 调用差异：无
- 开发版本:sdk6，DevEco Studio 2.2 Beta1
- 基线版本：Release 4.2.2
## 效果演示

![输入图片说明](https://gitee.com/chinasoft2_ohos/OkSocket/raw/master/img/oksocketr.gif "oksocketr.gif")

## 安装教程
1.在项目根目录下的build.gradle文件中

```

allprojects {
    repositories {
        maven {
            url 'https://s01.oss.sonatype.org/content/repositories/releases/'
        }
    }
}

```
2.在entry模块的build.gradle文件中，
```
dependencies {
       implementation('com.gitee.chinasoft_ohos:socket-client:1.0.0')

       implementation('com.gitee.chinasoft_ohos:socket-common-interface:1.0.0')

       implementation('com.gitee.chinasoft_ohos:socket-server:1.0.0')

       implementation('com.gitee.chinasoft_ohos:socket-core:1.0.0')
    ......
 }
 ```

 在sdk6，DevEco Studio 2.2 Beta1下项目可直接运行 如无法运行，删除项目.gradle,.idea,build,gradle,build.gradle文件, 并依据自己的版本创建新项目，将新项目的对应文件复制到根目录下

## 使用说明
```
SocketActionAdapter adapter = new SocketActionAdapter() {
        @Override
        public void onSocketConnectionSuccess(ConnectionInfo info, String action) {
           //成功
        }

        @Override
        public void onSocketDisconnection(ConnectionInfo info, String action, Exception e) {
           //断开
        }

        @Override
        public void onSocketConnectionFailed(ConnectionInfo info, String action, Exception e) {
           //连接失败
        }

        @Override
        public void onSocketReadResponse(ConnectionInfo info, String action, OriginalData data) {
          //从服务器读取到字节回调
        }

        @Override
        public void onSocketWriteResponse(ConnectionInfo info, String action, ISendable data) {
           //写给服务器字节后回调
        }

        @Override
        public void onPulseSend(ConnectionInfo info, IPulseSendable data) {
          //发送心跳后的回调
        }
    };
    ConnectionInfo mInfo = new ConnectionInfo(ip, post);
       OkSocketOptions mOkOptions = new OkSocketOptions.Builder()
                .setReconnectionManager(new NoneReconnect())
                .setConnectTimeoutSecond(10)
                .setCallbackThreadModeToken(new OkSocketOptions.ThreadModeToken() {
                    @Override
                    public void handleCallbackEvent(ActionDispatcher.ActionRunnable runnable) {
                        mHandler.postTask(runnable);
                    }
                })
                .build();
      IConnectionManager  mManager = OkSocket.open(mInfo).option(mOkOptions);
        mManager.registerReceiver(adapter);

         mManager.connect(); //连接
```
## 测试信息
CodeCheck代码测试无异常

CloudTest代码测试无异常

病毒安全检测通过

当前版本demo功能与原组件基本无差异

## 版本迭代
- 1.0.0
## 版权和许可信息
```
 Copyright [2018] [徐昊]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
```