Skip to content

Commit ff67927

Browse files
authored
Fix wording for the perCallBufferSize docs (#500) (#501)
1 parent dec67eb commit ff67927

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

docs/pages/kotlinx-rpc/topics/configuration.topic

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@
9292
The default value is <code>Duration.INFINITE</code>.
9393
</li>
9494
<li>
95-
<code>perCallBufferSize</code> - size of the buffer for one call.
96-
Call can be a stream or a single message.
95+
<code>perCallBufferSize</code> - size of the messages buffer for one call.
96+
The buffer ignores the size in bytes and only counts the number of messages.
9797
This effectively provides a backpressure mechanism.
9898
If a peer is slow to process the message during a call,
9999
the buffer will be filled up and

krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/KrpcConfig.kt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,9 @@ public sealed class KrpcConfigBuilder protected constructor() {
7979
/**
8080
* A buffer size for a single call.
8181
*
82-
* The default value is 1000,
83-
* meaning that only after one message is handled - the next one will be sent.
82+
* The default value is 1000 messages independent of their size in bytes.
8483
*
85-
* This buffer also applies to how many messages are cached with [waitTimeout]
84+
* This buffer also applies to how many messages are cached with [waitTimeout].
8685
*/
8786
public var perCallBufferSize: Int = 1000
8887
}

0 commit comments

Comments
 (0)