https://github.com/codeestx/rxsocketclient

:rocket:Reactive Socket APIs for Android, Java and Kotlin, powered by RxJava2
https://github.com/codeestx/rxsocketclient

android-library kotlin rxjava2 socket

Last synced: 3 months ago
JSON representation

:rocket:Reactive Socket APIs for Android, Java and Kotlin, powered by RxJava2

• Host: GitHub
• URL: https://github.com/codeestx/rxsocketclient
• Owner: codeestX
• License: apache-2.0
• Created: 2017-07-09T18:27:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-19T08:31:42.000Z (about 7 years ago)
• Last Synced: 2023-03-10T17:33:25.330Z (almost 2 years ago)
• Topics: android-library, kotlin, rxjava2, socket
• Language: Kotlin
• Homepage:
• Size: 145 KB
• Stars: 46
• Watchers: 3
• Forks: 17
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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)[![](https://jitpack.io/v/codeestX/RxSocketClient.svg)](https://jitpack.io/#codeestX/RxSocketClient)

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

Step 1. Add the JitPack repository to your build file

	allprojects {

		repositories {

			...

			maven { url "https://jitpack.io" }

		}

	}

   

Step 2. Add the dependency

	dependencies {

	        compile 'com.github.codeestX:RxSocketClient:v1.0.1'

	}

	

### init

```java

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

```java

Disposable ref = mClient.connect()

	... // anything else what you can do with RxJava

                .observeOn(AndroidSchedulers.mainThread())

                .subscribe(new SocketSubscriber() {

                    @Override

                    public void onConnected() {

                        //onConnected

                        Log.e(TAG, "onConnected");

                    }

                    @Override

                    public void onDisconnected() {

                        //onDisconnected

                        Log.e(TAG, "onDisconnected");

                    }

                    @Override

                    public void onResponse(@NotNull byte[] data) {

                        //receive data

                        Log.e(TAG, Arrays.toString(data));

                    }

                }, new Consumer() {

                    @Override

                    public void accept(Throwable throwable) throws Exception {

                        //onError

                        Log.e(TAG, throwable.toString());

                    }

                });

```

### disconnect

```java

mClient.disconnect();

//or

ref.dispose();

```

### sendData

```java

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.