docs: create README

Author: codeestX

README.md

@@ -0,0 +1,92 @@
+# RxSocketClient
+
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/codeestX/RxSocketClient/pulls)[![API](https://img.shields.io/badge/API-20%2B-brightgreen.svg)](https://android-arsenal.com/api?level=20)[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+RxSocketClient, Reactive Socket APIs for Android, Java and Kotlin, powered by RxJava2
+RxSocketClient，支持Android，Java和Kotlin的响应式Socket APIs封装，基于RxJava2
+
+RxJava2 Version: 2.1.1
+
+# Usage
+
+### init
+```
+SocketClient mClient = RxSocketClient
+        .create(new SocketConfig.Builder()
+                .setIp(IP)
+                .setPort(PORT)
+                .setCharset(Charsets.UTF_8)
+                .setThreadStrategy(ThreadStrategy.ASYNC)
+                .setTimeout(30 * 1000)
+                .build())
+        .option(new SocketOption.Builder()
+                .setHeartBeat(HEART_BEAT, 60 * 1000)
+                .setHead(HEAD)
+                .setTail(TAIL)
+                .build());
+
+```
+| value | default | description |
+| :--: | :--: | :--: |
+| Ip | required | host address |
+| Port | required | port number |
+| Charset | UTF_8 | the charset when encode a String to byte[] |
+| ThreadStrategy | Async | sending data asynchronously or synchronously|
+| Timeout | 0 | the timeout of a connection, millisecond |
+| HeartBeat | Optional | value and interval of heartbeat, millisecond |
+| Head | Optional | appending bytes at head when sending data, not included heartbeat |
+| Tail | Optional | appending bytes at last when sending data, not included heartbeat |
+
+### connect
+```
+Disposable ref = mClient.connect()
+                .observeOn(AndroidSchedulers.mainThread())
+                .subscribe(new SocketSubscriber() {
+                    @Override
+                    public void onConnected() {
+                        Log.e(TAG, "onConnected");
+                    }
+
+                    @Override
+                    public void onDisconnected() {
+                        Log.e(TAG, "onDisconnected");
+                    }
+
+                    @Override
+                    public void onResponse(@NotNull byte[] data) {
+                    	// receive data
+                        Log.e(TAG, Arrays.toString(data));
+                    }
+                });
+```
+
+### disconnect
+```
+mClient.disconnect();
+//or
+ref.dispose();
+```
+
+### sendData
+```
+mClient.sendData(bytes);
+//or
+mClient.sendData(string);
+```
+
+# License
+
+      Copyright (c) 2017 codeestX
+
+      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.
+

RxSocketClient/src/main/java/moe/codeest/rxsocketclient/SocketClient.kt

@@ -21,9 +21,9 @@ import moe.codeest.rxsocketclient.meta.DataWrapper
 import moe.codeest.rxsocketclient.meta.SocketConfig
 import moe.codeest.rxsocketclient.meta.SocketOption
 import moe.codeest.rxsocketclient.meta.ThreadStrategy
-import moe.codeest.rxsocketclient.post.AsyncIPoster
+import moe.codeest.rxsocketclient.post.AsyncPoster
 import moe.codeest.rxsocketclient.post.IPoster
-import moe.codeest.rxsocketclient.post.SyncIPoster
+import moe.codeest.rxsocketclient.post.SyncPoster
 import java.net.Socket
 import java.util.concurrent.Executor
 import java.util.concurrent.Executors
@@ -50,7 +50,7 @@ class SocketClient(val mConfig: SocketConfig) {
 
     fun connect(): Observable<DataWrapper> {
         mObservable = SocketObservable(mConfig, mSocket)
-        mIPoster = if (mConfig.mThreadStrategy == ThreadStrategy.ASYNC) AsyncIPoster(this, mExecutor) else SyncIPoster(this, mExecutor)
+        mIPoster = if (mConfig.mThreadStrategy == ThreadStrategy.ASYNC) AsyncPoster(this, mExecutor) else SyncPoster(this, mExecutor)
         initHeartBeat()
         return mObservable
     }
@@ -66,7 +66,7 @@ class SocketClient(val mConfig: SocketConfig) {
             if (mHeartBeatConfig != null) {
             val disposable = Observable.interval(mHeartBeatConfig.interval, TimeUnit.MILLISECONDS)
                         .subscribe({
-                            sendData(mHeartBeatConfig.data?: ByteArray(0))
+                            mIPoster.enqueue(mHeartBeatConfig.data?: ByteArray(0))
                         })
                 if (mObservable is SocketObservable) {
                     (mObservable as SocketObservable).setHeartBeatRef(disposable)

RxSocketClient/src/main/java/moe/codeest/rxsocketclient/post/AsyncIPoster.kt renamed to RxSocketClient/src/main/java/moe/codeest/rxsocketclient/post/AsyncPoster.kt

@@ -26,7 +26,7 @@ import java.util.concurrent.Executor
  * @description:
  */
 
-class AsyncIPoster(private val mSocketClient: SocketClient, private val mExecutor: Executor) : Runnable, IPoster {
+class AsyncPoster(private val mSocketClient: SocketClient, private val mExecutor: Executor) : Runnable, IPoster {
 
     private val queue: PendingPostQueue = PendingPostQueue()
 

RxSocketClient/src/main/java/moe/codeest/rxsocketclient/post/SyncIPoster.kt renamed to RxSocketClient/src/main/java/moe/codeest/rxsocketclient/post/SyncPoster.kt

@@ -1,8 +1,3 @@
-package moe.codeest.rxsocketclient.post
-
-import moe.codeest.rxsocketclient.SocketClient
-import java.util.concurrent.Executor
-
 /*
  * Copyright (C) 2017 codeestX
  *
@@ -19,13 +14,18 @@ import java.util.concurrent.Executor
  * limitations under the License.
  */
 
+package moe.codeest.rxsocketclient.post
+
+import moe.codeest.rxsocketclient.SocketClient
+import java.util.concurrent.Executor
+
 /**
  * @author: Est <codeest.dev@gmail.com>
  * @date: 2017/7/9
  * @description:
  */
 
-class SyncIPoster(private val mSocketClient: SocketClient, private val mExecutor: Executor) : Runnable, IPoster {
+class SyncPoster(private val mSocketClient: SocketClient, private val mExecutor: Executor) : Runnable, IPoster {
 
     private val queue: PendingPostQueue = PendingPostQueue()
 

app/src/main/java/moe/codeest/rxsocketclientdemo/JavaActivity.java

@@ -31,7 +31,7 @@ public class JavaActivity extends AppCompatActivity implements View.OnClickListe
     private static final String TAG = "JavaActivity";
 
     private static final String IP = "192.168.1.101";
-    private static final int PORT = 8080;
+    private static final int PORT = 55731;
     private static final byte[] HEART_BEAT = {1, 3, 4};
     private static final byte[] HEAD = {1, 2};
     private static final byte[] TAIL = {5, 7};