Skip to content

Commit a429a3b

Browse files
Updating documentation and Gradle files
1 parent cb10e8b commit a429a3b

File tree

4 files changed

+15
-11
lines changed

4 files changed

+15
-11
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**Note that this is a FORK of a project by NaikSoftware! This version was originally made to avoid using RetroLambda.**
88

9-
*(It now has [many other differences](#changes-in-this-fork).)*
9+
*(It now has [many other important differences](#changes-in-this-fork).)*
1010

1111
This library provides support for [STOMP protocol](https://stomp.github.io/) over Websockets.
1212

@@ -21,7 +21,7 @@ repositories {
2121
maven { url "https://jitpack.io" }
2222
}
2323
dependencies {
24-
compile 'com.github.forresthopkinsa:StompProtocolAndroid:1.4.0'
24+
compile 'com.github.forresthopkinsa:StompProtocolAndroid:17.10.0'
2525
}
2626
```
2727

@@ -30,12 +30,8 @@ You can use this library two ways:
3030
- Using the old JACK toolchain
3131
- If you have Java 8 compatiblity and Jack enabled, this library will work for you
3232
- Using the new Native Java 8 support
33-
- As of this writing, you must be using Android Studio Beta to use this feature.
34-
- Has been tested in the following environments:
35-
- Beta 1-6, Gradle plugin v3.0.0-beta(1-6)
36-
- Canary 8-9, Gradle plugin v3.0.0-alpha(8-9)
37-
- It *should* work in all 3.0.0+ versions
38-
- You can find more info on the [Releases Page](https://github.com/forresthopkinsa/StompProtocolAndroid/releases)
33+
- It should work in all Android Studio (and Gradle plugin) 3.0.0+ versions
34+
- You can find compatibility info on the [Releases Page](https://github.com/forresthopkinsa/StompProtocolAndroid/releases)
3935

4036
However, *this fork is NOT compatible with Retrolambda.*
4137
If you have RL as a dependency, then you should be using the [upstream version](https://github.com/NaikSoftware/StompProtocolAndroid) of this project!
@@ -168,6 +164,15 @@ Right now, the library only supports sending and receiving messages. ACK message
168164

169165
## Changes in this fork
170166

167+
**Summary**
168+
169+
Improvements: Most of the Rx logic has been rewritten, and a good portion of the other code has also been modified
170+
to allow for more stability. Additionally, a lot of blocking code has been replaced with reactive code,
171+
resulting in better performance.
172+
173+
Drawbacks: In order to allow for major changes, this branch sacrifices backward compatibility. Code written
174+
for the upstream will likely have to be modified to work with this version. You can find more details below.
175+
171176
**Build changes**
172177

173178
The upstream master is based on Retrolambda. This version is based on Native Java 8 compilation,
@@ -270,6 +275,7 @@ These are the possible changes you need to make to your code for this branch, if
270275
- Better adherence to STOMP spec
271276
- According to the [spec](http://stomp.github.io/stomp-specification-1.2.html#STOMP_Frames), the end of the message body should be immediately followed by a NULL octet, marking the end of the frame.
272277
- Before, we were adding an extra two newlines between the body and NULL octet, which was breaking compatibility with picky servers.
278+
- Now, we format it correctly; there is no whitespace between the end of the body and the `\u0000`.
273279
- This shouldn't make any difference, but if it does, you can revert to legacy formatting with `client.setLegacyWhitespace(true)`.
274280
275281
## Additional Reading

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ buildscript {
88
}
99
}
1010
dependencies {
11-
classpath 'com.android.tools.build:gradle:3.0.0-beta6'
11+
classpath 'com.android.tools.build:gradle:3.0.1'
1212
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
1313

1414
// NOTE: Do not place your application dependencies here; they belong

example-client/build.gradle

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ apply plugin: 'com.android.application'
22

33
android {
44
compileSdkVersion 25
5-
buildToolsVersion "25.0.2"
65

76
defaultConfig {
87
applicationId "ua.naiksoftware.stompclientexample"

lib/build.gradle

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ group='com.github.forresthopkinsa'
55

66
android {
77
compileSdkVersion 25
8-
buildToolsVersion "25.0.2"
98

109
defaultConfig {
1110
minSdkVersion 16

0 commit comments

Comments
 (0)