Skip to content

Commit 2c900e7

Browse files
author
Georgi Neykov
committed
Update CHANGELOG.md and README.md
(cherry picked from commit acb4fc4d1f2fb61f299fd109027deb3dc8deb0e2)
1 parent ec6ac27 commit 2c900e7

File tree

3 files changed

+26
-27
lines changed

3 files changed

+26
-27
lines changed

CHANGELOG.md

+16-17
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
11
Changelog
22
==========
33

4+
Version 2.5.1 (17.02.2021)
5+
--------------------------
6+
7+
## Composer
8+
9+
- Fix a case in `DataApiResponseAdapter` where an API call with a non-success result code being adapted to a `DataApiResponse` will result in the underlying `Response` and `Connection` not being closed (and potentially reused).
10+
411
Version 2.5.0 (28.07.2020)
512
--------------------------
613

714
## Client
815

9-
- Deprecate `ResponseBody.writeTo()`, `ResponseBody.valuesBytes()`,
10-
`ResponseBody.valuesByteArray()`.
16+
- Deprecate `ResponseBody.writeTo()`, `ResponseBody.valuesBytes()`, `ResponseBody.valuesByteArray()`.
1117

12-
The one-shot stream of data being held by a `ResponseBody`
13-
needs to be decoded by a `ProtocolReader` before use. `ResponseBody.reader()`
14-
returns such an instance which is already configured
15-
and ready for reading making these methods redundant.
16-
Also the aforementioned methods bring some behavior ambiguity in cases where
17-
the stream may be partially consumed through the exposed `ProtocolReader`.
18+
The one-shot stream of data being held by a `ResponseBody` needs to be decoded by a `ProtocolReader` before use. `ResponseBody.reader()` returns such an instance which is already configured and ready for reading making these methods redundant.
19+
Also the aforementioned methods bring some behavior ambiguity in cases where the stream may be partially consumed through the exposed `ProtocolReader`.
1820

19-
**The methods will now throw an `IllegalStateException` if
20-
called when the response has been partially read via a `ProtocolReader`.**
21+
**The methods will now throw an `IllegalStateException` if called when the response has been partially read via a `ProtocolReader`.**
2122

2223
**The methods will be removed in the next major release of the library.**
2324

24-
- Fix potential connection leaks in `Call.enqueue()`
25-
and `Call.enqueueAndWait()` implementations.
26-
- Review connection closing/recycling in the `MultiCall` implementation
27-
- Add more assertions regarding connection recycling/closure in `Call`,
28-
`MultiCall` unit tests.
25+
- Fix potential connection leaks in `Call.enqueue()` and `Call.enqueueAndWait()` implementations.
26+
- Review connection closing/recycling in the `MultiCall` implementation.
27+
- Add more assertions regarding connection recycling/closure in `Call` and `MultiCall` unit tests.
2928

3029
Version 2.4.1 (20.03.2020)
3130
--------------------------
@@ -154,13 +153,13 @@ Version 2.0.0 (05.01.2018)
154153
* Internal optimizations in `BytesWriter` to minimize allocations
155154
* More unit tests for `BytesWriter`
156155
* ProtocolResponseReader can now directly read the data after data-enriched responses.
157-
* Added the `SCOPE_DATA` scope in `ProtocolResponseReader` will be entered after all the values of a data-enriched response are read and the `ProtocolResponseReader` is at the begging of the attached data bytes.
156+
* Added the `SCOPE_DATA` scope in `ProtocolResponseReader` will be entered after all the values of a data-enriched response are read and the `ProtocolResponseReader` is at the begging of the attached data bytes.
158157
* Add delegating implementations for `ProtocolReader`, `ProtocolResponseReader`, `ProtocolRequestWriter`and `ProtocolWriter`.
159158

160159
#### Client
161160

162161
* Add the `ApiChannel` low-level interface for writing and reading binary-encoded data to an API connection.
163-
- This addition exposes the lowest possible level of detail when writing/reading messages from the API by still abstracting away the details of connection establishment, TLS handshaking and so on.
162+
- This addition exposes the lowest possible level of detail when writing/reading messages from the API by still abstracting away the details of connection establishment, TLS handshaking and so on.
164163
- The interface allows for pipelining of requests and reading/writing on separate threads.
165164
- Instances of the interface can be opened via `PCloudApiClient.newChannel()`.
166165

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ api.copy(...)
5959
<dependency>
6060
<groupId>com.pcloud.pcloud-networking-java</groupId>
6161
<artifactId>composer</artifactId>
62-
<version>2.5.0</version>
62+
<version>2.5.1</version>
6363
<type>pom</type>
6464
</dependency>
6565
```
6666

6767
```groovy
68-
compile 'com.pcloud.pcloud-networking-java:composer:2.5.0'
68+
compile 'com.pcloud.pcloud-networking-java:composer:2.5.1'
6969
```
7070

7171
### Client
@@ -87,13 +87,13 @@ The `binapi-client` module contains a network client for composing and executing
8787
<dependency>
8888
<groupId>com.pcloud.pcloud-networking-java</groupId>
8989
<artifactId>binapi-client</artifactId>
90-
<version>2.5.0</version>
90+
<version>2.5.1</version>
9191
<type>pom</type>
9292
</dependency>
9393
```
9494

9595
```groovy
96-
compile 'com.pcloud.pcloud-networking-java:binapi-client:2.5.0'
96+
compile 'com.pcloud.pcloud-networking-java:binapi-client:2.5.1'
9797
```
9898

9999
--------------------------------------------------------------------------------
@@ -115,13 +115,13 @@ The `serialization` module contains a library for serializing Java objects to bi
115115
<dependency>
116116
<groupId>com.pcloud.pcloud-networking-java</groupId>
117117
<artifactId>serialization</artifactId>
118-
<version>2.5.0</version>
118+
<version>2.5.1</version>
119119
<type>pom</type>
120120
</dependency>
121121
```
122122

123123
```groovy
124-
compile 'com.pcloud.pcloud-networking-java:serialization:2.5.0'
124+
compile 'com.pcloud.pcloud-networking-java:serialization:2.5.1'
125125
```
126126
--------------------------------------------------------------------------------
127127
### Protocol
@@ -142,13 +142,13 @@ The `protocol` module contains the core logic for writing/reading data in the fo
142142
<dependency>
143143
<groupId>com.pcloud.pcloud-networking-java</groupId>
144144
<artifactId>protocol</artifactId>
145-
<version>2.5.0</version>
145+
<version>2.5.1</version>
146146
<type>pom</type>
147147
</dependency>
148148
```
149149

150150
```groovy
151-
compile 'com.pcloud.pcloud-networking-java:protocol:2.5.0'
151+
compile 'com.pcloud.pcloud-networking-java:protocol:2.5.1'
152152
```
153153

154154
## License

publishing.gradle

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
ext {
1818
isCi = System.getenv().containsKey('CI')
1919

20-
versionName = "2.5.0"
21-
versionCode = 23
20+
versionName = "2.5.1"
21+
versionCode = 24
2222
libraryName = "pcloud-networking-java"
2323
groupId = "com.pcloud.pcloud-networking-java"
2424
description = "A Network Stack for pCloud's API written in Java"

0 commit comments

Comments
 (0)